Retrieve Machines
GET
machines
Retrieves a paginated list of all Machines, 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/machines |
| 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 Machines matching the specified id. |
| filter[code] string | Filter Machines matching the specified code. Pass the value as URL‑encoded. |
| filter[section.id] int | Filter Machines belonging to the specified Section. |
| filter[section.name] string | Filter Machines belonging to the specified Section. Pass the value as URL‑encoded. |
| filter[disabled] boolean | Filter Machines by status. If true, returns only disabled Machines; if false or omitted, returns only enabled Machines. |
| 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, code. Default: “id desc”. |
Response
HTTP Status Code Summary
| 200 OK | A list of machines. |
| 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 machines |
| id int | Unique identifier of the machine. |
| code string | Max length: 255 |
| name string | Max length: 255 |
| shift | The current active shift for the machine |
| id int | Unique identifier of the referenced entity. |
| code string | Code of the referenced entity.
Max length: 255 |
| anyOf | The current active shift for the machine |
| 0 | |
| 1 | |
| vendor string | Max length: 255 |
| model string | Max length: 255 |
| section | |
| id int | Unique identifier of the referenced entity. |
| name string | Name of the referenced entity.
Max length: 255 |
| anyOf | |
| 0 | |
| 1 | |
| counter int | The value from which the machine counter will start |
| costPerHour number | The value assigned to each hour of labor |
| notes string | Max length: 255 |
| disabled boolean | Defines if the machine is disabled |
| automatic boolean | Defines if the worker is linked to the Machine or not |
| productionClosedByOtherWorkers boolean | Defines if the Production using this Machine can only be closed by the worker that started it |
| parallelProduction boolean | Defines if the Production can be started on a Machine that is currently producing |
| totalCyclesInput boolean | Changes the way quantities and wastes are asked on the Production checkout |
| useMachineCounterAsQuantityMeasure boolean | Used when the Machine has an internal counter that indicates the total quantity produced since the last time it has been reset |
| machineComponents array: object | |
| id int | Unique identifier of the machine component. |
| code string | Max length: 255 |
| name string | Max length: 255 |
| products array: object | |
| 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 | |
| unitsProduced number | |
| anyOf | |
| 0 | |
| 1 | |
| reasonCodes array: object | |
| id int | Unique identifier of the referenced entity. |
| code string | Code of the referenced entity.
Max length: 255 |
| anyOf | |
| 0 | |
| 1 | |
| 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 machines.
Request
curl -v 'https://developer.api.autodesk.com/fusion-operations/v2/machines' \
-H 'Authorization: '
Response
{
"results": [
{
"id": 38,
"code": "My new machine",
"name": "Johannes",
"shift": {
"id": 3,
"code": "Normal"
},
"vendor": "ABC Machines",
"model": "Model X",
"section": {
"id": 3,
"name": "A"
},
"counter": 0,
"costPerHour": 150,
"notes": "My wonderful note with less than 255 characters",
"disabled": false,
"automatic": false,
"productionClosedByOtherWorkers": false,
"parallelProduction": true,
"totalCyclesInput": false,
"useMachineCounterAsQuantityMeasure": false,
"machineComponents": [
{
"id": 23,
"code": "Tool 1"
},
{
"id": 27,
"code": "Tool 2"
}
],
"reasonCodes": [
{
"id": 3,
"code": "Maintenance"
},
{
"id": 5,
"code": "Change Over"
}
]
},
{
"id": 40,
"code": "Machine Pro2000",
"name": "Pro2000",
"shift": {
"id": 3,
"code": "Normal"
},
"vendor": "Special Machines Inc.",
"model": "Pro2000",
"section": {
"id": 6,
"name": "B"
},
"counter": 0,
"costPerHour": 160,
"notes": "My wonderful note with less than 255 characters",
"disabled": false,
"automatic": false,
"productionClosedByOtherWorkers": false,
"parallelProduction": true,
"totalCyclesInput": false,
"useMachineCounterAsQuantityMeasure": false,
"machineComponents": [
{
"id": 23,
"code": "Tool 1"
}
],
"reasonCodes": [
{
"id": 5,
"code": "Change Over"
}
]
}
],
"pagination": {
"limit": 20,
"offset": 0,
"nextUrl": null
}
}
Show More