Retrieve Downtime Records
GET
downtime-records
Retrieves a paginated list of all Downtime Records, optionally filtered and sorted. When additional results are available, the pagination object in the response payload provides a “nextUrl” that links to the next page of results.
Resource Information
| Method and URI | GET https://api.aps.autodesk.com/fusion-operations/v2/downtime-records |
| Authentication Context | No security required |
| Required OAuth Scopes | data:read data:write |
| Data Format | JSON |
Request
Headers
| Authorization* string | JWT Access Token |
* Required
Request
Query String Parameters
| filter[id] int | Filter Downtime Records matching the specified id. |
| filter[startTime] string | Filter Downtime Records by startTime. Accepts an ISO-8601 date time or an inclusive date time range in the format lowerValue..upperValue, lowerValue.., or ..upperValue. Returns Downtime Records started within the specified range. |
| filter[endTime] string | Filter Downtime Records by endTime. Accepts an ISO-8601 date time or an inclusive date time range in the format lowerValue..upperValue, lowerValue.., or ..upperValue. Returns Downtime Records ended within the specified range. |
| filter[worker.id] int | Filter Downtime Records by worker, providing the id. |
| filter[worker.number] int | Filter Downtime Records by worker, providing the number. |
| filter[machine.id] int | Filter Downtime Records by machine id. |
| filter[machine.code] string | Filter Downtime Records by machine code. Pass the value as URL‑encoded. |
| filter[reasonCode.id] int | Filter Downtime Records by reason code id. |
| filter[reasonCode.code] string | Filter Downtime Records by reason code. Pass the value as URL‑encoded. |
| filter[endedBy.id] int | Filter Downtime Records ended by a specific worker, providing the id. |
| filter[endedBy.number] int | Filter Downtime Records ended by a specific worker, providing the number |
| filter[startedBy.id] int | Filter Downtime Records started by a specific worker, providing the id. |
| filter[startedBy.number] int | Filter Downtime Records started by a specific worker, providing the number. |
| filter[finished] boolean | When set to true, only Downtime Records marked as finished are returned. When set to false, Downtime Records that are not yet finished are returned. When nothing is sent, return all Downtime Records. |
| offset int | Page offset. Default value is 0. |
| limit int | Maximum number of results returned. Defaults to 25. |
| sort string | Comma separated fields to sort items by. Fields: id, “startTime”, “endTime”. Default: “startTime desc”. |
Response
HTTP Status Code Summary
| 200 OK | A list of downtime records. |
| 400 Bad Request | Bad request due to invalid data. |
| 401 Unauthorized | The access token is invalid. It may have either expired or may not be a three-legged access token. Please verify the token and retry the request. |
| 403 Forbidden | The request was successfully validated but lacked required permission. Please verify your token permissions and retry the request. |
| 429 Too Many Requests | Rate limit exceeded; wait some time before retrying. |
| 500 Internal Server Error | An unknown server-side error occurred. Please try again later. If the problem persists, please contact support. |
Response
Header (429)
| Retry-After integer | The number of seconds to wait before retrying the request. |
Response
Body Structure (200)
Expand all
| results array: object | List of downtime records |
| id int | Unique identifier of the downtime. |
| startTime datetime: ISO 8601 | Begin of the downtime (e.g. 2017-06-21T14:07:17Z) |
| endTime datetime: ISO 8601 | End of the downtime (e.g. 2017-06-21T16:07:17Z). This value can be null when the downtime is finished, indicating that the downtime was closed automatically by the system. |
| reasonCode | |
| id int | Unique identifier of the referenced entity. |
| code string | Code of the referenced entity.
Max length: 255 |
| anyOf | |
| 0 | |
| 1 | |
| machines array: object | |
| id int | Unique identifier of the referenced entity. |
| code string | Code of the referenced entity.
Max length: 255 |
| name string | Name of the referenced entity.
Max length: 255 |
| anyOf | |
| 0 | |
| 1 | |
| workers array: object | |
| id int | |
| number int | |
| name string | Max length: 255 |
| anyOf | |
| 0 | |
| 1 | |
| startedBy | |
| id int | |
| number int | |
| name string | Max length: 255 |
| anyOf | |
| 0 | |
| 1 | |
| endedBy | |
| id int | |
| number int | |
| name string | Max length: 255 |
| anyOf | |
| 0 | |
| 1 | |
| component | |
| id int | Unique identifier of the referenced entity. |
| code string | Code of the referenced entity.
Max length: 255 |
| name string | Name of the referenced entity.
Max length: 255 |
| anyOf | |
| 0 | |
| 1 | |
| product | |
| id int | Unique identifier of the referenced entity. |
| code string | Code of the referenced entity.
Max length: 255 |
| name string | Name of the referenced entity.
Max length: 255 |
| anyOf | |
| 0 | |
| 1 | |
| notes string | Max length: 5000 |
| anyOf | |
| 0 | |
| 1 | |
| pagination object | |
| limit int | Maximum number of results returned in this page. |
| offset int | Number of results skipped before this page. |
| nextUrl string | URL for the next page of results. Null when there are no additional pages. |
Example
A list of downtime records.
Request
curl -v 'https://developer.api.autodesk.com/fusion-operations/v2/downtime-records' \
-H 'Authorization: '
Response
{}