Request

Response

    Takeoff Items
    GET

    projects/{projectId}/packages/{packageId}/takeoff-items

    Retrieves the takeoff items for a package.

    For more information about takeoff items, see the ACC Takeoff help documentation.

    To learn how this endpoint is used, see the Takeoff Extract Inventory tutorial.

    Note that this endpoint is not compatible with BIM 360 projects.

    Resource Information

    Method and URI
    GET
    https://developer.api.autodesk.com/construction/takeoff/v1/projects/{projectId}/packages/{packageId}/takeoff-items
    Authentication Context
    user context required
    Required OAuth Scopes
    data:read
    Data Format
    JSON

    Request

    Headers

    Authorization*
    string
    Must be Bearer <token>, where <token> is obtained via a three-legged OAuth flow.
    region
    string
    Specifies the region where the service is located.

    Possible values: US, EMEA. For the full list of supported regions, see the Regions page.

    * Required

    Request

    URI Parameters

    projectId
    string: UUID
    The ID of the project.

    This corresponds to project ID in the Data Management API, and can be specified in the form of “UUID” or b.”UUID”.

    To learn how to find the project ID, see the Retrieve ACC Account and project ID tutorial.

    packageId
    string: UUID
    The takeoff package ID.

    To find the ID, call GET packages.

    Request

    Query String Parameters

    offset
    int
    The takeoff item index from which the pagination starts. This is zero-based.
    limit
    int
    The maximum number of takeoff items per page.

    Acceptable values: 1-10000.

    Default value: 1000.

    Response

    HTTP Status Code Summary

    200
    OK
    Successfully retrieved the takeoff items.
    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
    pagination
    object
    The pagination object.
    limit
    int
    The maximum number of objects per page.
    nextUrl
    string
    The URL path that returns the next page of data.
    offset
    int
    The object number from which the pagination starts. This is zero-based.
    results
    array: object
    A list of takeoff items for the package.
    id
    string: UUID
    The takeoff item ID.
    takeoffTypeId
    string: UUID
    The takeoff type ID.
    type
    enum:string
    The takeoff type method.

    Possible values: COUNT, DISTANCE, AREA, SELECT.

    Corresponding UI names: COUNT, LINEAR, AREA, BIM.

    objectName
    string
    The name of the takeoff type that the item is derived from.
    geometry
    string
    The geometry of a 2D takeoff item specified in SVG. This property is not returned for a 3D takeoff item.
    objectId
    int
    The ID of the selected BIM model element in the viewing model.
    propertyValues
    array: object
    A list of takeoff item properties used to calculate quantity.
    name
    string
    Name of the property.
    unitOfMeasure
    enum:string
    The unit of measurement.

    Possible values: EA, IN, LF, YD, SI, SF, SY, CI, CF, CY, LBS, TON, MM, M, M2, M3, KG, T.

    source
    enum:string
    Specifies how a takeoff property value was obtained. Possible values: MANUAL_ENTRY, BIM_PROPERTY, MEASUREMENT
    value
    The value of a takeoff instance.
    anyOf
    The value of a takeoff instance.
    0
    number
    A number representation of the property value.
    1
    string
    A string representation of the property value.
    primaryQuantity
    object
    The quantity of a takeoff.
    outputName
    string
    A custom output name from the user.
    classificationCodeOne
    string
    The classification code selected from the first classification system.
    classificationCodeTwo
    string
    The classification code selected from the second classification system.
    quantity
    number
    The quantity of the takeoff.
    unitOfMeasure
    enum:string
    The unit of measurement.

    Possible values: EA, IN, LF, YD, SI, SF, SY, CI, CF, CY, LBS, TON, MM, M, M2, M3, KG, T.

    secondaryQuantities
    array: object
    A list of secondary takeoff quantities.
    outputName
    string
    A custom output name from the user.
    classificationCodeOne
    string
    The classification code selected from the first classification system.
    classificationCodeTwo
    string
    The classification code selected from the second classification system.
    quantity
    number
    The quantity of the takeoff.
    unitOfMeasure
    enum:string
    The unit of measurement.

    Possible values: EA, IN, LF, YD, SI, SF, SY, CI, CF, CY, LBS, TON, MM, M, M2, M3, KG, T.

    contentView
    object
    The content view reference that this item is associated with.
    id
    string: UUID
    The content view ID.
    version
    one of
    The content view version.
    Model identifier
    string
    The 3D model ID.
    Sheet identifier
    string: UUID
    The 2D sheet ID.
    locationId
    string: UUID
    The location ID associated with the takeoff item.

    For more information about the location, see GET nodes.

    createdAt
    datetime: ISO 8601
    The date and time when the resource was created, in the following format: YYYY-MM-DDThh:mm:ssZ.
    updatedAt
    datetime: ISO 8601
    The date and time when the resource was last updated, in the following format: YYYY-MM-DDThh:mm:ssZ.
    updatedByName
    string
    The name of the user who last updated the resource.

    Example

    Successfully retrieved the takeoff items.

    Request

    curl -v 'https://developer.api.autodesk.com/construction/takeoff/v1/projects/:projectId/packages/:packageId/takeoff-items?limit=1000' \
      -H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
    

    Response

    {
      "pagination": {
        "limit": 100,
        "nextUrl": "https://developer.api.autodesk.com/construction/takeoff/v1/resources?limit=100&offset=200",
        "offset": 100
      },
      "results": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "takeoffTypeId": "b9380176-9ac2-454d-acdd-fdfd988b9702",
          "type": "COUNT",
          "objectName": "36\" x 48\"",
          "geometry": "<path fill=\"none\" stroke=\"red\" d=\"M 10,10 h 10 m 0,10 h 10 m 0,10 h 10\">",
          "objectId": 1,
          "propertyValues": [
            {
              "name": "Perimeter",
              "unitOfMeasure": "LF",
              "source": "MEASUREMENT",
              "value": 3
            }
          ],
          "primaryQuantity": {
            "outputName": "Bedroom Wall",
            "classificationCodeOne": "085113",
            "classificationCodeTwo": "011223",
            "quantity": 15,
            "unitOfMeasure": "EA"
          },
          "secondaryQuantities": [
            {
              "outputName": "Wall Paint",
              "classificationCodeOne": "098732",
              "classificationCodeTwo": "011665",
              "quantity": 45,
              "unitOfMeasure": "LF"
            }
          ],
          "contentView": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "version": "urn:adsk.wipstg:fs.file:vf.oeSywgLpSkONo9O6CUZvkQ?version=3"
          },
          "locationId": "ff7f6eb4-6276-4993-bfeb-34cbbbba3a17",
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2020-11-11T12:32:45Z",
          "updatedByName": "Jane Johnson"
        }
      ]
    }
    
    Show More