v1/containers/{containerId}/time-sheets
Retrieves one or more timesheets in the given project.
Note that Cost API timesheets endpoints are designed only for use with a third party tracking app that you’ve synchronized with Cost Management. For more information, see Performance Tracking.
Resource Information
Method and URI | GET https://developer.api.autodesk.com/cost/v1/containers/:containerId/time-sheets |
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[budgetCode] string | Filter data that belong to associated budget code. For example, filter[budgetCode]=code .
To find budget codes, call GET budgets and inspect |
filter[trackingItemInstanceId] string: UUID | Filter data that belong to associated tracking item instance id. For example, filter[trackingItemInstanceId]=id . |
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 . |
include array: string | Include additional resources in the response. For example, include=meta will return the meta data. Possible values: meta . |
filter[startDate] string | Filter data by its start date. This may be an ISO 8601 string or a range. Ranges can be lowerValue..upperValue, lowerValue.. or ..upperValue. The range tests are always inclusive of their endpoints. |
filter[endDate] string | Filter data by its end date. This may be an ISO 8601 string or a range. Ranges can be lowerValue..upperValue, lowerValue.. or ..upperValue. The range tests are always inclusive of their endpoints. |
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 |
meta object | |
totalPreviousInputQuantity number,null | Total sum of timesheet logs input quantity before given trackingItemInstanceId and endDate filter. null if not applicable. |
totalPreviousOutputQuantity number,null | Total sum of timesheet logs output quantity before given trackingItemInstanceId and endDate filter. null if not applicable. |
results array: object | The timesheet list. |
id string: UUID | The ID of the timesheet. |
containerId string: UUID | The ID of the cost container for the project to which the timesheet belongs. |
trackingItemInstanceId string: UUID | The ID of the tracking item instance to which the timesheet belongs. |
startDate string | The first date of the time period covered by the timesheet. |
endDate string | The last date of the time period covered by the timesheet. This is also the date that the tracked inputQuantity and outputQuantity values are considered to have been reported. |
inputQuantity number | The hours worked during the time period covered by the timesheet. |
inputUnit string | The input unit of measurement of the timesheet. Currently this value should always be hr . |
outputQuantity number | The quantity of material used during time period covered by the timesheet. |
outputUnit string | The output unit of measurement of the timesheet. |
creatorId string,null | The BIM 360/ACC ID of the user who created the timesheet. |
changedBy string,null | The BIM 360/ACC ID of the user who made the last change to the timesheet. |
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/time-sheets?limit=100&sort=name,createdAt desc&filter[budgetCode]=code&filter[trackingItemInstanceId]=b6445638-ca68-4e3c-9160-15864de6b818&filter[lastModifiedSince]=2020-03-01T13:00:00Z&filter[startDate]=2020-10-31T14:48:00.000Z..2020-11-01T14:48:00.000Z&filter[endDate]=2020-10-31T14:48:00.000Z..2020-11-01T14:48:00.000Z' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
{
"pagination": {
"limit": 20,
"offset": 0,
"totalResults": 1,
"nextUrl": ""
},
"meta": {
"totalPreviousInputQuantity": "200",
"totalPreviousOutputQuantity": "200"
},
"results": [
{
"id": "1df59db0-9484-11e8-a7ec-7ddae203e404",
"containerId": "1df59db0-9484-11e8-a7ec-7ddae203e404",
"trackingItemInstanceId": "1df59db0-9484-11e8-a7ec-7ddae203e404",
"startDate": "2020-01-06",
"endDate": "2020-01-06",
"inputQuantity": "100",
"inputUnit": "hr",
"outputQuantity": "100",
"outputUnit": "cy",
"creatorId": "CED9LVTLHNXV",
"changedBy": "CED9LVTLHNXV",
"createdAt": "2019-01-06T01:24:22.678Z",
"updatedAt": "2019-09-05T01:00:12.989Z"
}
]
}