v1/containers/{containerId}/main-contracts/{mainContractId}/items
Retrieves one or more items in the specified main contracts.
Resource Information
Method and URI | GET https://developer.api.autodesk.com/cost/v1/containers/:containerId/main-contracts/:mainContractId/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. |
mainContractId array: string: uuid | A list of the IDs of the main contracts from which to return items, separated by commas. To find the main contract IDs, call GET main-contracts and inspect results.id in the response. |
Request
Query String Parameters
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 . |
include array: string | A list of the types of nested resources to include in the response with the main contract items, separated by commas.
For example, Possible values: |
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[externalSystem] string | The name of the external ERP system. Use this name to identify or search within the integrated system. For example, filter[externalSystem]=Sage300 .
Max length: 255 |
filter[externalId] array: string | The ID of the item in the external ERP system. Use this ID to track or look up data in an integrated ERP system. For example, filter[externalId]=id1,id2 . |
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 contents of a record returned by this endpoint. |
id string | The ID of the main contract item. |
budgetId string,null | The ID of the budget linked to the main contract item. |
containerId string,null | 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. |
parentId string,null | The ID of the parent item of the returned main contract item. This is used only when creating a main contract item. |
mainContractId string,null | The ID of the main contract that contains the returned main contract item. This is used only when creating a main contract item. |
code string | The code of the main contract item.
Max length: 255 |
name string | The name of the main contract item.
Max length: 1024 |
description string | A description of the main contract item.
Max length: 2048 |
unit string,null | The unit of measure of the main contract item.
Max length: 255 |
unitPrice number,string,null | The unit price of the main contract item. |
quantity number,string,null | The quantity of the main contract item. |
amount number,string,null | The total price of the main contract item. |
createdAt datetime: ISO 8601 | The date and time when the main contract item was created, in ISO 8601 format. |
updatedAt datetime: ISO 8601 | The date and time when the main contract item was last updated, in ISO 8601 format. |
isPrivate boolean,null | true : The main contract item is private.
|
position int | The position of the main contract item in its siblings of main contract items. |
externalId string | The identifier assigned to an item in its original external ERP system. Use this ID to track and look up data within the integrated system. Note that this value comes from the item’s ID in the external system.
Max length: 255 |
externalSystem string | The name of the external ERP system integrated with Cost Management. Use this name to identify and search for data within the integrated system.
Max length: 255 |
externalMessage string | A message generated by the external ERP system that explains the sync status of the integration. For example, common values include success or fail to indicate the result of the integration operation.
Max length: 255 |
lastSyncTime datetime: ISO 8601 | The date and time when the item was last synchronized with the external ERP system. This value is updated by the external system and is in ISO 8601 format. |
integrationState string,null | The state of the item during the integration with the external ERP system (such as SignNow). An item can be a budget , contract , main contract , main contract item , cost item , expense , expense item , change order , or schedule of value . For more details, see Integrate with External System tutorial.
Possible values:
For more information regarding integrations within the Cost Management system, see Integrations in Cost Management. |
integrationStateChangedAt string,null | The date and time that the item’s integration status was last changed. |
integrationStateChangedBy string,null | The user who last changed the integration status. This is the ID of a user managed by the BIM 360/ACC Admin. |
Example
Success
Request
curl -v 'https://developer.api.autodesk.com/cost/v1/containers/e94b9bc8-1775-4d76-9b1d-c613e120ccff/main-contracts/b6445638-ca68-4e3c-9160-15864de6b818/items?limit=100&sort=name,createdAt desc' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
{
"pagination": {
"limit": 20,
"offset": 0,
"totalResults": 1,
"nextUrl": ""
},
"results": [
{
"id": "1df59db0-9484-11e8-a7ec-7ddae203e404",
"budgetId": "fc1f46d3-7838-11e8-a467-7de33c3af32d",
"containerId": "e94b9bc8-1775-4d76-9b1d-c613e120ccff",
"parentId": "36d8d230-0030-4bd6-a57c-ac4be8a891c9",
"mainContractId": "f6445638-ca68-4e3c-9160-15864de6b818",
"code": 1011,
"name": "Site Management Staff",
"description": "Site Management Staff",
"unit": "ea",
"unitPrice": "1000.0000",
"quantity": "1000.0000",
"amount": "1000.0000",
"createdAt": "2019-08-22",
"updatedAt": "2019-08-22",
"isPrivate": true,
"position": 1,
"externalId": "10010-99-AB",
"externalSystem": "Sage300",
"externalMessage": "Success.",
"lastSyncTime": "2019-09-05T01:00:12.989Z",
"integrationState": "locked",
"integrationStateChangedAt": "2019-09-05T01:00:12.989Z",
"integrationStateChangedBy": "CED9LVTLHNXV"
}
]
}