v1/containers/{containerId}/templates/{templateId}/segments
Retrieves all of the segments in a budget code template.
Resource Information
Method and URI | GET https://developer.api.autodesk.com/cost/v1/containers/:containerId/templates/:templateId/segments |
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. |
templateId string: UUID | The budget code template ID. To obtain a template ID, use GET templates. |
Request
Query String Parameters
filter[name] string | Returns only items with the specified name. For example, filter[name]=Labor .
Max length: 255 |
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 . |
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)
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 detailed segment definition values |
id string: UUID | The ID of the segment in the budget code template. |
templateId string: UUID | The ID of the budget code template. |
name string | The name of the segment in budget code template.
Max length: 1024 |
type string | The segment type. Possible values: code , column , or info . Code segments are displayed as part of the budget code. Column segments are displayed in a separate column. Info segments are not displayed. |
delimiter string | The delimiter that follows the segment. Possible values are: none , space , point , hyphen , underscore , tab . |
delimiterChar string | The delimiter char after the segment. For example, . , - , _ . |
length number | The number of characters allowed in the segment. |
isVariableLength boolean | Whether the segment is variable length. |
position number | The order of the segment in the budget code template. |
sampleCode string | A code sample for the segment used to demonstrate how the segment looks when displayed. |
isLocked boolean,null | The lock status of segment. |
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. |
Example
Success
Request
curl -v 'https://developer.api.autodesk.com/cost/v1/containers/e94b9bc8-1775-4d76-9b1d-c613e120ccff/templates/a2a9eb81-052b-4a18-9988-571e8134f98b/segments?filter[lastModifiedSince]=2020-03-01T13:00:00Z&limit=100&sort=name,createdAt desc' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
{
"pagination": {
"limit": 20,
"offset": 0,
"totalResults": 1,
"nextUrl": ""
},
"results": [
{
"id": "87256c07-5c03-42cd-b4dc-e9d06411c0cc",
"templateId": "a2a9eb81-052b-4a18-9988-571e8134f98b",
"name": "CSI",
"type": "code",
"delimiter": "none",
"delimiterChar": "",
"length": 6,
"isVariableLength": false,
"position": 0,
"sampleCode": 6656,
"isLocked": false,
"createdAt": "2019-01-06T01:24:22.678Z",
"updatedAt": "2019-09-05T01:00:12.989Z"
}
]
}