v1/containers/{containerId}/schedule-of-values
Retrieves one or more schedule of values (SOV) items in the given project.
Resource Information
Method and URI | GET https://developer.api.autodesk.com/cost/v1/containers/:containerId/schedule-of-values |
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
include array: string | Return the specified nested resources in the response. For example, include=subitems returns the project’s SOV items. Note that for a value of idOnly , the response includes only a list of SOV item IDs, and other include values are ignored. Possible values: subitems , attributes , idOnly . |
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[contractId] array: string: uuid | Returns only items associated with the contracts identified on this list of IDs. Separate multiple IDs with commas; for example:filter[contractId]=id1,id2 .
You can also provide a value of |
filter[includeChangeOrders] boolean | false : (default) will Returns only original contracted SOV items.
|
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 . |
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. |
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 unique ID of the schedule of values (SOV) item. |
parentId string,null | The ID of the SOV item’s parent item, the default value is null . For root SOV items, this value is null . |
contractId string | The ID of the contract to which the SOV item belongs. |
budgetId string,null | The ID of the budget to which the SOV item belongs. |
code string | The code of the SOV item.
Max length: 255 |
name string | The name of the SOV item.
Max length: 1024 |
quantity number | The quantity of the SOV item. |
unitPrice number | The unit price of the SOV item. |
unit string | The unit of measure of the SOV item.
Max length: 1024 |
amount number,string,null | The total price of the SOV item. |
allocatedAmount number,string,null | The amount of budget allocated to this contract. |
quantityPerBulk number | The quantity conversion ratio of the SOV item. |
bulkUnitPrice number | The unit price of the converted SOV item quantity. |
bulk number | The converted quantity of the SOV item. |
associationId string,null | The ID of a change order or cost item that this SOV item was originally created from. |
associationType string,null | The type of object from which the SOV item was created:a change order or a cost item. |
exchangeRate number,string,null | The exchange rate that applies to the SOV item’s base currency price. For example, provide the value 0.7455 for a foreign currency that’s worth 0.7455 of your base currency. |
position number | The position of the SOV item in the list of SOV items. |
createdAt datetime: ISO 8601 | The date and time that the item was created, in ISO 8601 format. |
updatedAt datetime: ISO 8601 | The date and time that the item was last updated, in ISO 8601 format. |
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. |
Example
Success
Request
curl -v 'https://developer.api.autodesk.com/cost/v1/containers/e94b9bc8-1775-4d76-9b1d-c613e120ccff/schedule-of-values?limit=100&sort=name,createdAt desc' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
[
{
"id": "88dc0f70-9483-11e8-a7ec-7ddae203e404",
"parentId": "null",
"contractId": "2256dc50-9481-11e8-87fb-215990a8aeb3",
"budgetId": "f6445638-ca68-4e3c-9160-15864de6b818",
"code": "03 30 01.1",
"name": "Concrete to Pile Caps",
"quantity": 50,
"unitPrice": 20,
"unit": "ea",
"amount": "1000.0000",
"allocatedAmount": "1000.0000",
"quantityPerBulk": 50,
"bulkUnitPrice": 20,
"bulk": 50,
"associationId": "88dc0f70-9483-11e8-a7ec-7ddae203e404",
"associationType": "SCO",
"exchangeRate": "1000.0000",
"position": 1,
"createdAt": "2019-01-06T01:24:22.678Z",
"updatedAt": "2019-09-05T01:00:12.989Z",
"externalId": "10010-99-AB",
"externalSystem": "Sage300",
"externalMessage": "Success.",
"lastSyncTime": "2019-09-05T01:00:12.989Z"
}
]