v1/containers/{containerId}/performance-tracking-items/{id}
Retrieves a performance tracking item by ID in the given project. Note that a tracking item’s attributes are a subset of those of the budget from which it was created.
Resource Information
Method and URI | GET https://developer.api.autodesk.com/cost/v1/containers/:containerId/performance-tracking-items/:id |
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 | The region where the project data resides, to which this request is routed.
This header is optional because the request is automatically routed to a target region based on the project ID or container ID. Using the header, though, can save lookup time on each API call. For information about verifying the region the data resides in, see the Working with BIM 360 Services in Different Regions section on the API Basics page. Possible values: |
Request
URI Parameters
containerId string: UUID | The ID of the cost container for the project. Each project is assigned a container that stores all of the cost data for the project.
To find the container ID, see the Retrieve a Cost Container ID tutorial. In ACC projects, the container ID is the same as the project ID. To obtain a project ID, use GET projects. |
id string: UUID | The ID of the performance tracking item. To find the item ID, call GET performance-tracking-items and inspect results.id in the response. |
Response
HTTP Status Code Summary
200 OK | Success |
400 Bad Request | The parameters are invalid. |
401 Unauthorized | The provided bearer token is invalid. |
403 Forbidden | Forbidden. The user or service represented by the bearer token does not have permission to perform this operation. |
404 Not Found | The resource or endpoint cannot be found. |
409 Conflict | The request could not be completed due to a conflict with the current state of the resource. |
429 Too Many Requests | Rate limit exceeded. Retry your request after a few minutes. |
500 Internal Server Error | An unexpected error occurred on the server. |
503 Service Unavailable | Service unavailable. |
Response
Body Structure (200)
id string: UUID | The ID of the tracking item. |
containerId string: UUID | The ID of the cost container for the project to which this tracking item belongs. |
budgetId string: UUID | The ID of the tracking item’s underlying budget. |
name string | The name of the tracking item’s underlying budget. |
description string | The description of the tracking item’s underlying budget. |
code string | The code of the tracking item’s underlying budget. |
quantity number | The quantity of the performance tracking item’s underlying budget. |
unit string | The unit of the performance tracking item’s underlying budget. |
unitPrice number,string,null | The unit price of the performance tracking item’s underlying budget. |
originalAmount number | Original amount of the budget, equals to quantity * unitPrice |
plannedStartDate datetime: ISO 8601 | The planned start date of the performance tracking item’s underlying budget. |
plannedEndDate datetime: ISO 8601 | The planned end date of the performance tracking item’s underlying budget. |
locations array,null | A list of the IDs of the project locations where this item applies.
For more information, see the Locations Help documentation help. |
locationPaths array,null | A list of the IDs of the project locations where this item applies, along with the node paths of these locations in the project’s locations tree.
For more information, see the Locations Help documentation help. |
Example
Success
Request
curl -v 'https://developer.api.autodesk.com/cost/v1/containers/e94b9bc8-1775-4d76-9b1d-c613e120ccff/performance-tracking-items/226449d0-9481-11e8-87fb-215990a8aeb3' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
{
"id": "1df59db0-9484-11e8-a7ec-7ddae203e404",
"containerId": "1df59db0-9484-11e8-a7ec-7ddae203e404",
"budgetId": "1df59db0-9484-11e8-a7ec-7ddae203e404",
"name": "Pouring Concrete to Pile Caps",
"description": "Pouring Concrete to Pile Caps",
"code": "100.033000.1.LAB",
"quantity": 2000,
"unit": "hr",
"unitPrice": "1000.0000",
"originalAmount": 1000,
"plannedStartDate": "2023-01-01T00:00:00.000Z",
"plannedEndDate": "2025-01-01T00:00:00.000Z",
"locations": [
"683904a0-47ce-4146-ac2d-a3840f00e0f4"
],
"locationPaths": [
"683904a0-47ce-4146-ac2d-a3840f00e0f4"
]
}