v1/containers/{containerId}/performance-tracking-items
Retrieves one or more performance tracking items in the given project. Note that a tracking item contains a subset of the attributes of the budget from which it was created. For more information about performance tracking, see the Cost Management API Field Guide.
Resource Information
Method and URI | GET https://developer.api.autodesk.com/cost/v1/containers/:containerId/performance-tracking-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 | 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. |
Request
Query String Parameters
offset int | The number of objects to skip before returning a page of records. To return the subsequent page, increment this number by the value of limit in the next request. |
limit int | The maximum number of records that this endpoint returns per page. Default: 100 .
Note that a returned page may contain fewer items than the limit under either of these conditions:
|
sort string | The sort order for items. Each attribute can be sorted in either asc (default) or desc order. For example, sort=name, updatedAt desc or sort=name + updatedAt desc sorts the results first by name in ascending order, then by date updated in descending order. |
filter[id] array: string: uuid | Returns only the items that are identified by the provided list of item IDs. Separate multiple IDs with commas. For example, filter[id]=id1,id2 . |
filter[budgetId] array: string: uuid | Returns only tracking item instances that belong to the budgets identified by the provided list of budget IDs (separated with commas). For example, filter[budgetId]=id1,id2 . Note that you can return the instances that are not linked to any budget using filter[budgetId]=blank . To find budget IDs, call GET budgets and inspect results.id in the response. |
filter[budgetCode] array: string | Filter data that belong to associated budget code. For example, filter[budgetCode]=code1,code2 . |
filter[lastModifiedSince] string | Returns only items that were modified since the specified date and time, in ISO 8601 format. For example, filter[lastModifiedSince]=2020-03-01T13:00:00Z . |
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)
pagination object | Pagination information when data must be returned page by page. |
limit int | The maximum number of objects returned in this response. |
offset int | The number of resulting objects that were skipped before this page of records was returned. |
totalResults int | The total number of objects found that satisfied the request criteria. |
nextUrl string | The URL for the next request to return the next page of records.
Max length: 2000 |
results array: object | The performance tracking item list. |
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?limit=100&sort=name,createdAt desc&filter[lastModifiedSince]=2020-03-01T13:00:00Z' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
{
"pagination": {
"limit": 20,
"offset": 0,
"totalResults": 1,
"nextUrl": ""
},
"results": [
{
"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"
]
}
]
}