projects/{projectId}/packages/{packageId}
Retrieves a specified takeoff package.
Takeoff packages organize and contain all takeoff data related to a scope of work in your project.
For more information about takeoff packages, see the ACC Takeoff - Working with Packages help documentation.
To find the takeoff types in a package, call GET takeoff-types.
To find the takeoff items in a package, call GET takeoff-items.
Resource Information
Method and URI | GET https://developer.api.autodesk.com/construction/takeoff/v1/projects/{projectId}/packages/{packageId} |
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: |
Request
URI Parameters
packageId string: UUID | The takeoff package ID.
To find the ID, call GET packages. |
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. |
Response
HTTP Status Code Summary
200 OK | Successfully retrieved the takeoff package. |
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)
name string | The package name (user defined).
Corresponding UI name: Max length: 64 |
id string: UUID | The package ID. |
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 package.
Request
curl -v 'https://developer.api.autodesk.com/construction/takeoff/v1/projects/:projectId/packages/:packageId' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Concrete",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2020-11-11T12:32:45Z",
"updatedByName": "Jane Johnson"
}