Request

Response

    Scope-Specific Bid Forms
    PATCH

    scope-specific-bid-forms/{formId}/line-items:batch-patch

    Updates multiple project bid form line items. Max 2000 line items per call.

    Note that a bid form’s line items must each have a unique combination of the type, description, and section field values.

    Resource Information

    Method and URI
    PATCH
    https://developer.api.autodesk.com/construction/buildingconnected/v2/scope-specific-bid-forms/{formId}/line-items:batch-patch
    Authentication Context
    user context required
    Required OAuth Scopes
    data:write
    Data Format
    JSON

    Request

    Headers

    Authorization*
    string
    Must be Bearer <token>, where <token> is obtained via a three-legged OAuth flow.
    Content-Type*
    string
    Must be application/json
    * Required

    Request

    URI Parameters

    formId
    string
    The ID of the form.

    Request

    Body Structure

    The bid form line items to update as ScopeSpecificBidFormLineItemUpdate objects keyed by ID.

    Max 2000 bid form line items per call.

    Expand all
    object
    The details of an update to a line item on a scope-specific bid form.
    description
    string
    A description of the scope-specific bid form line item.
    section
    string
    The section that the scope-specific line item should be under. Defaults to null.
    • If the specified section already exists, the new line item is added to that section.
    • If the specified section does not exist, a new section is automatically created and the new line item is added to that section.
    • If you omit this field from the request (null), the new line item is not under a section.
    isRequired
    boolean
    Indicates whether the scope-specific line item is required. Possible values:
    • true: The scope-specific line item is required.
    • false: The scope-specific line item is optional.
    unit
    enum:string
    The unit format of the scope-specific line item. Each line item type has its own subset of the possible formats.

    The possible values of this field depend on the value of type:

    • ADDENDUMTEXT, YES_NO, PER_ACRE, PER_AMP, PER_BOARD_FT, PER_CUBIC_FT, PER_CUBIC_METER, PER_CUBIC_YARD, PER_DAY, PER_EACH, PER_FLOOR, PER_GALLON, PER_GROSS_SQUARE_FT, PER_GROSS_SQUARE_METER, PER_HOUR, PER_KILOGRAM, PER_LINEAR_FT, PER_LINEAR_METER, PER_LINEAR_YARD, PER_LITER, PER_LOT, PER_METRIC_TON, PER_MONTH, PER_POUND, PER_RISER, PER_SQUARE_FT, PER_SQUARE_METER, PER_SQUARE_YARD, PER_SQUARE_YARD_INCH, PER_STALL, PER_STOP, PER_TON, PER_WATT, PER_WEEK, TOTAL_COST_ONLY
    • ALTERNATEACRES, AMPS, BOARD_FT, CUBIC_FT, CUBIC_METERS, CUBIC_YARDS, DAYS, EACH, FLOORS, GALLONS, GROSS_SQUARE_FT, HOURS, KILOGRAMS, LINEAR_FT, LINEAR_METERS, LINEAR_YARDS, LITERS, LOT, METRIC_TONS, MONTHS, POUNDS, RISERS, SQUARE_FT, SQUARE_METERS, SQUARE_YARDS, SQUARE_YARD_INCHES, STALLS, STOPS, TEXT, TONS, TOTAL_COST_ONLY, WATTS, WEEKS
    • COST_BREAKDOWNACRES, AMPS, BOARD_FT, CUBIC_FT, CUBIC_METERS, CUBIC_YARDS, DAYS, EACH, FLOORS, GALLONS, GROSS_SQUARE_FT, GROSS_SQUARE_METERS, HOURS, KILOGRAMS, LINEAR_FT, LINEAR_METERS, LINEAR_YARDS, LITERS, LOT, METRIC_TONS, MONTHS, POUNDS, RISERS, SQUARE_FT, SQUARE_METERS, SQUARE_YARDS, SQUARE_YARD_INCHES, STALLS, STOPS, TONS, TOTAL_COST_ONLY, WATTS, WEEKS
    • DISCLAIMER — Converted to null
    • INCLUSIONYES_NO_WITH_ADJUSTMENT
    • SCOPE_CLARIFICATION — Converted to null

    Note that the value TOTAL_COST_ONLY is used for a lump sum line item.

    code
    string
    A user-defined code associated with the scope-specific line item. Applies only to line items with a type value of COST_BREAKDOWN.

    If type is not COST_BREAKDOWN, this field is converted to null. Only COST_BREAKDOWN type line items may have a code.

    quantity
    number
    The quantity of the scope-specific line item. This value is null under either of the following conditions:
    • The value of type is not COST_BREAKDOWN. Only COST_BREAKDOWN type items have a quantity.
    • The value of unit is TOTAL_COST_ONLY. Items with a TOTAL_COST_ONLY unit do not have a quantity.
    isQuantityFixed
    boolean
    Indicates whether the scope-specific line item quantity is fixed. If it is fixed, bidders cannot change it. Possible values:
    • true: The scope-specific line item quantity is fixed.
    • false: The scope-specific line item quantity can be changed by bidders.
    external
    object
    Information about an external tool that can link the line item to a cost or other element that is external to BuildingConnected.

    Note that BuildingConnected does not use information in this object.

    id*
    string
    The ID of the external tool.
    name
    string
    The name of the external tool.
    * Required

    Response

    HTTP Status Code Summary

    200
    OK
    OK
    400
    Bad Request
    The parameters of the requested operation are invalid.
    401
    Unauthorized
    The provided bearer token is not valid.
    403
    Forbidden
    The user or service represented by the bearer token does not have permission to perform this operation.
    404
    Not Found
    The requested resource could not be found.
    429
    Too Many Requests
    Rate limit exceeded; wait some time before retrying. The ‘Retry-After’ header might provide the amount of the time to wait.
    500
    Internal Server Error
    An unknown error occurred on the server.

    Response

    Body Structure (200)

    Expand all
    results
    array: object
    id
    string
    The unique ID of the scope-specific line item.

    Max length: 24

    type
    enum:string
    The type of the scope-specific line item.

    The possible values have the following UI equivalents:

    • ADDENDUM — Scope-Specific Information and Unit Costs
    • ALTERNATE — Alternates
    • COST_BREAKDOWN — Line Items
    • INCLUSION — Inclusions
    • SCOPE_CLARIFICATION — Scope-Specific Clarifications
    description
    string
    A description of the scope-specific line item.
    section
    string
    The section that the scope-specific line item is under. This value is null if the item is not under a section.
    isRequired
    boolean
    Indicates whether the scope-specific line item is required. Possible values:
    • true: The scope-specific line item is required.
    • false: The scope-specific line item is optional.
    unit
    enum:string
    The unit format of the scope-specific line item.

    The possible values of this field depend on the value of type. Each possible line item type is listed, followed by the possible values of unit for that type:

    • ACKNOWLEDMENTYES_NO, TOTAL_COST_ONLY, TEXT, PERCENTAGE
    • ADDENDUMTEXT, YES_NO, PER_ACRE, PER_AMP, PER_BOARD_FT, PER_CUBIC_FT, PER_CUBIC_METER, PER_CUBIC_YARD, PER_DAY, PER_EACH, PER_FLOOR, PER_GALLON, PER_GROSS_SQUARE_FT, PER_GROSS_SQUARE_METER, PER_HOUR, PER_KILOGRAM, PER_LINEAR_FT, PER_LINEAR_METER, PER_LINEAR_YARD, PER_LITER, PER_LOT, PER_METRIC_TON, PER_MONTH, PER_POUND, PER_RISER, PER_SQUARE_FT, PER_SQUARE_METER, PER_SQUARE_YARD, PER_SQUARE_YARD_INCH, PER_STALL, PER_STOP, PER_TON, PER_WATT, PER_WEEK, TOTAL_COST_ONLY
    • ALTERNATEACRES, AMPS, BOARD_FT, CUBIC_FT, CUBIC_METERS, CUBIC_YARDS, DAYS, EACH, FLOORS, GALLONS, GROSS_SQUARE_FT, HOURS, KILOGRAMS, LINEAR_FT, LINEAR_METERS, LINEAR_YARDS, LITERS, LOT, METRIC_TONS, MONTHS, POUNDS, RISERS, SQUARE_FT, SQUARE_METERS, SQUARE_YARDS, SQUARE_YARD_INCHES, STALLS, STOPS, TEXT, TONS, TOTAL_COST_ONLY, WATTS, WEEKS
    • BONDINGYES_NO, TOTAL_COST_ONLY, TEXT, PERCENTAGE
    • CERTIFICATIONTEXT, YES_NO
    • COST_BREAKDOWNACRES, AMPS, BOARD_FT, CUBIC_FT, CUBIC_METERS, CUBIC_YARDS, DAYS, EACH, FLOORS, GALLONS, GROSS_SQUARE_FT, GROSS_SQUARE_METERS, HOURS, KILOGRAMS, LINEAR_FT, LINEAR_METERS, LINEAR_YARDS, LITERS, LOT, METRIC_TONS, MONTHS, POUNDS, RISERS, SQUARE_FT, SQUARE_METERS, SQUARE_YARDS, SQUARE_YARD_INCHES, STALLS, STOPS, TONS, TOTAL_COST_ONLY, WATTS, WEEKS
    • DISCLAIMER — Converted to null
    • INCLUSIONYES_NO_WITH_ADJUSTMENT
    • LABOR_RATEPER_HOUR, PER_DAY, PER_WEEK
    • MARKUPPERCENTAGE, TOTAL_COST_ONLY
    • SCOPE_CLARIFICATION — Converted to null

    Note that the value TOTAL_COST_ONLY is used for a lump sum line item.

    code
    string
    The code associated with the scope-specific line item. This value is null if type is not COST_BREAKDOWN. Only COST_BREAKDOWN type items have a code.
    quantity
    number
    The quantity of the scope-specific line item. This value is null under either of the following conditions:
    • The value of type is not COST_BREAKDOWN. Only COST_BREAKDOWN type items have a quantity.
    • The value of unit is TOTAL_COST_ONLY. Items with a TOTAL_COST_ONLY unit do not have a quantity.
    isQuantityFixed
    boolean
    Indicates whether the scope-specific line item quantity is fixed. If it is fixed, bidders cannot change it. Possible values:
    • true: The scope-specific line item quantity is fixed.
    • false: The scope-specific line item quantity can be changed by bidders.
    external
    object
    Information about an external tool that can link the line item to a cost or other element that is external to BuildingConnected.

    Note that BuildingConnected does not use information in this object.

    id
    string
    The ID of the external tool.
    name
    string
    The name of the external tool.

    Example

    OK

    Request

    curl -v 'https://developer.api.autodesk.com/construction/buildingconnected/v2/scope-specific-bid-forms/:formId/line-items:batch-patch' \
      -X 'PATCH' \
      -H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a' \
      -H 'Content-Type: application/json' \
      -d '{
            "53811754d3a604966df72247": {
              "description": "Concrete",
              "section": "Work & Cleanup",
              "quantity": 2000,
              "external": {
                "id": "1234-3214-1234-3214",
                "name": "External System"
              }
            }
          }'
    
    Show More

    Response

    {
      "results": [
        {
          "id": "53811754d3a604966df72247",
          "type": "COST_BREAKDOWN",
          "description": "Duct Insulation",
          "section": "Furnish & Install",
          "isRequired": true,
          "unit": "HOURS",
          "code": "D2",
          "quantity": 1000,
          "isQuantityFixed": true,
          "external": {
            "id": "",
            "name": ""
          }
        }
      ]
    }
    
    Show More