maintenance-orders
Creates a new Maintenance Order. Requires code and priority. Provide exactly one of machine or component as the maintenance target. When performedByExternalEntity is false, provide at least one of workers or workerGroups; both may be supplied together. Workers already included in an assigned worker group are excluded from workers automatically. When performedByExternalEntity is true, omit worker assignment. When requestedBy is provided without approvedBy, the Maintenance Order is created as an MO Request (response status PENDING_REQUESTS); workers and workerGroups are optional. To convert an MO Request into a Maintenance Order, provide approvedBy (user id or name matching fullName) on the same POST or on a subsequent PATCH.
Resource Information
| Method and URI | POST https://api.aps.autodesk.com/fusion-operations/v2/maintenance-orders |
| Authentication Context | No security required |
| Required OAuth Scopes | data:read data:write |
| Data Format | JSON |
Request
Headers
| Authorization* string | JWT Access Token |
| Content-Type* string | Must be application/json |
Request
Body Structure
The Maintenance Order object to be created, conforming to the specified schema.
| code* | Unique code of the Maintenance Order within the company.
Max length: 255 |
| description string | Max length: 255 |
| dueDate* datetime: ISO 8601 | Due date of the Maintenance Order (e.g. 2025-06-21T14:00:00Z). |
| estimatedDuration string | Estimated duration of the Maintenance Order in ISO-8601 duration format (e.g. PT30H, PT2H30M). |
| priority* enum:string | Priority of the Maintenance Order.
Possible values: NONE, LOW, MEDIUM, HIGH |
| type enum:string | Type of maintenance.
Possible values: CORRECTIVE, PREVENTIVE |
| status enum:string | Status of the Maintenance Order. PENDING_REQUESTS is a read-only response status for Maintenance Orders created with requestedBy that are not yet approved (requestedBy is set and approvedBy is null). It cannot be supplied on create or patch. WAITING_FOR_APPROVAL is only valid when the company setting “Require maintenance work to be approved” is enabled.
Possible values: OPEN, WAITING_FOR_PARTS, WAITING_FOR_TECHNICIAN, WAITING_FOR_APPROVAL, CLOSED_COMPLETED, CLOSED_NOT_COMPLETED, PENDING_REQUESTS |
| archived boolean | Whether the Maintenance Order is archived. |
| performedByExternalEntity boolean | Whether the maintenance work is performed externally. When true, workers and workerGroups must be null or omitted. |
| machine | Machine associated with the Maintenance Order. Exactly one of machine or component must be set; the other must be null or omitted. |
| id int | Unique identifier of the referenced entity. |
| code string | Code of the referenced entity.
Max length: 255 |
| anyOf | Machine associated with the Maintenance Order. Exactly one of machine or component must be set; the other must be null or omitted. |
| 0 | |
| 1 | |
| component | Machine component associated with the Maintenance Order. Exactly one of machine or component must be set; the other must be null or omitted. |
| id int | Unique identifier of the referenced entity. |
| code string | Code of the referenced entity.
Max length: 255 |
| anyOf | Machine component associated with the Maintenance Order. Exactly one of machine or component must be set; the other must be null or omitted. |
| 0 | |
| 1 | |
| workers array: object | Workers directly assigned to the Maintenance Order in addition to any assigned worker groups. When performedByExternalEntity is false, at least one of workers or workerGroups must be provided; both may be supplied together. When both are provided, workers already included in an assigned worker group are excluded from workers automatically. In responses, lists only workers not already included in an assigned worker group. |
| id int | |
| number int | |
| anyOf | |
| 0 | |
| 1 | |
| workerGroups array: object | Worker groups assigned to the Maintenance Order. When performedByExternalEntity is false, at least one of workers or workerGroups must be provided; both may be supplied together. |
| id int | Unique identifier of the referenced entity. |
| name string | Name of the referenced entity.
Max length: 255 |
| anyOf | |
| 0 | |
| 1 | |
| checklist | Checklist template the user fills while working on the Maintenance Order. |
| id int | Unique identifier of the referenced entity. |
| code string | Code of the referenced entity.
Max length: 255 |
| anyOf | Checklist template the user fills while working on the Maintenance Order. |
| 0 | |
| 1 | |
| checklistValues array: object | Recorded values for checklist parameters. When provided on PATCH, the entire checklistValues array replaces the existing list; send all values if you want to update checklist values. |
| name* string | Name of the parameter.
Max length: 255 |
| value string | Value of the parameter.
Max length: 255 |
| consumptions array: object | Material consumptions associated with the Maintenance Order. When provided on PATCH, the entire consumptions array replaces the existing list; send all consumptions if you want to update consumptions. |
| product* | Product consumed. |
| id int | Unique identifier of the referenced entity. |
| code string | Code of the referenced entity.
Max length: 255 |
| anyOf* | Product consumed. |
| 0* | |
| 1* | |
| quantity* number | Quantity of the product consumed. |
| serialNumber | Lot or serial number of the consumed product, when applicable. |
| id int | Unique identifier of the referenced entity. |
| code string | Code of the referenced entity.
Max length: 255 |
| anyOf | Lot or serial number of the consumed product, when applicable. |
| 0 | |
| 1 | |
| cost number | Cost of the consumption. |
| warehouseLocation | Warehouse location from which the product was consumed. Warehouse is required when identifying the location by code, because location codes are unique per warehouse. |
| code string | Max length: 255 |
| name string | Max length: 255 |
| warehouse* | |
| code string | Max length: 255 |
| name string | Max length: 255 |
| site | Site associated with the Inventory Movement. |
| id int | Unique identifier of the referenced entity. |
| code string | Code of the referenced entity.
Max length: 255 |
| anyOf | Site associated with the Inventory Movement. |
| 0 | |
| 1 | |
| anyOf* | |
| 0* | |
| 1* | |
| anyOf | Warehouse location from which the product was consumed. Warehouse is required when identifying the location by code, because location codes are unique per warehouse. |
| 0 | |
| 1 | |
| requestedBy | Worker who requested the Maintenance Order. When provided on create without approvedBy, the record is created as an MO Request (response status PENDING_REQUESTS) and workers/workerGroups are optional. Writable on create and patch. |
| id int | |
| number int | |
| anyOf | Worker who requested the Maintenance Order. When provided on create without approvedBy, the record is created as an MO Request (response status PENDING_REQUESTS) and workers/workerGroups are optional. Writable on create and patch. |
| 0 | |
| 1 | |
| approvedBy | User who approved the Maintenance Order. Writable on create and patch — supply user id or name (matching fullName). Setting approvedBy on an MO Request converts it to a Maintenance Order. |
| id int | Unique identifier of the referenced entity. |
| name string | Name of the referenced entity.
Max length: 255 |
| anyOf | User who approved the Maintenance Order. Writable on create and patch — supply user id or name (matching fullName). Setting approvedBy on an MO Request converts it to a Maintenance Order. |
| 0 | |
| 1 | |
| anyOf | Unique code of the Maintenance Order within the company.
Max length: 255 |
| 0 | |
| 1 | |
| 2 all of | |
| 0 | |
| 1 object | |
| performedByExternalEntity object | Will always be: true |
| 3 |
Response
HTTP Status Code Summary
| 201 Created | Maintenance Order successfully created. |
| 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 (201)
| id | Unique identifier of the Maintenance Order. |
| code string | Unique code of the Maintenance Order within the company.
Max length: 255 |
| description string | Max length: 255 |
| dueDate datetime: ISO 8601 | Due date of the Maintenance Order (e.g. 2025-06-21T14:00:00Z). |
| estimatedDuration string | Estimated duration of the Maintenance Order in ISO-8601 duration format (e.g. PT30H, PT2H30M). |
| priority enum:string | Priority of the Maintenance Order.
Possible values: NONE, LOW, MEDIUM, HIGH |
| type enum:string | Type of maintenance.
Possible values: CORRECTIVE, PREVENTIVE |
| status enum:string | Status of the Maintenance Order. PENDING_REQUESTS is a read-only response status for Maintenance Orders created with requestedBy that are not yet approved (requestedBy is set and approvedBy is null). It cannot be supplied on create or patch. WAITING_FOR_APPROVAL is only valid when the company setting “Require maintenance work to be approved” is enabled.
Possible values: OPEN, WAITING_FOR_PARTS, WAITING_FOR_TECHNICIAN, WAITING_FOR_APPROVAL, CLOSED_COMPLETED, CLOSED_NOT_COMPLETED, PENDING_REQUESTS |
| archived boolean | Whether the Maintenance Order is archived. |
| performedByExternalEntity boolean | Whether the maintenance work is performed externally. When true, workers and workerGroups must be null or omitted. |
| machine | Machine associated with the Maintenance Order. Exactly one of machine or component must be set; the other must be null or omitted. |
| 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 | Machine associated with the Maintenance Order. Exactly one of machine or component must be set; the other must be null or omitted. |
| 0 | |
| 1 | |
| component | Machine component associated with the Maintenance Order. Exactly one of machine or component must be set; the other must be null or omitted. |
| 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 | Machine component associated with the Maintenance Order. Exactly one of machine or component must be set; the other must be null or omitted. |
| 0 | |
| 1 | |
| workers array: object | Workers directly assigned to the Maintenance Order in addition to any assigned worker groups. When performedByExternalEntity is false, at least one of workers or workerGroups must be provided; both may be supplied together. When both are provided, workers already included in an assigned worker group are excluded from workers automatically. In responses, lists only workers not already included in an assigned worker group. |
| id int | |
| number int | |
| name string | Max length: 255 |
| anyOf | |
| 0 | |
| 1 | |
| workerGroups array: object | Worker groups assigned to the Maintenance Order. When performedByExternalEntity is false, at least one of workers or workerGroups must be provided; both may be supplied together. |
| id int | Unique identifier of the referenced entity. |
| name string | Name of the referenced entity.
Max length: 255 |
| anyOf | |
| 0 | |
| 1 | |
| checklist | Checklist template the user fills while working on the Maintenance Order. |
| 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 | Checklist template the user fills while working on the Maintenance Order. |
| 0 | |
| 1 | |
| checklistValues array: object | Recorded values for checklist parameters. When provided on PATCH, the entire checklistValues array replaces the existing list; send all values if you want to update checklist values. |
| name string | Name of the parameter.
Max length: 255 |
| value string | Value of the parameter.
Max length: 255 |
| consumptions array: object | Material consumptions associated with the Maintenance Order. When provided on PATCH, the entire consumptions array replaces the existing list; send all consumptions if you want to update consumptions. |
| id int | Unique identifier of the consumption line. |
| product | Product consumed. |
| 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 | Product consumed. |
| 0 | |
| 1 | |
| quantity number | Quantity of the product consumed. |
| serialNumber | Lot or serial number of the consumed product, when applicable. |
| id int | Unique identifier of the referenced entity. |
| code string | Code of the referenced entity.
Max length: 255 |
| anyOf | Lot or serial number of the consumed product, when applicable. |
| 0 | |
| 1 | |
| cost number | Cost of the consumption. |
| warehouseLocation | Warehouse location from which the product was consumed. Warehouse is required when identifying the location by code, because location codes are unique per warehouse. |
| id int | Unique identifier of the warehouse location. |
| code string | Max length: 255 |
| name string | Max length: 255 |
| warehouse | |
| id int | Unique identifier of the warehouse. |
| code string | Max length: 255 |
| name string | Max length: 255 |
| site | Site associated with the Inventory Movement. |
| id int | Unique identifier of the referenced entity. |
| code string | Code of the referenced entity.
Max length: 255 |
| anyOf | Site associated with the Inventory Movement. |
| 0 | |
| 1 | |
| anyOf | |
| 0 | |
| 1 | |
| anyOf | Warehouse location from which the product was consumed. Warehouse is required when identifying the location by code, because location codes are unique per warehouse. |
| 0 | |
| 1 | |
| requestedBy | Worker who requested the Maintenance Order. When provided on create without approvedBy, the record is created as an MO Request (response status PENDING_REQUESTS) and workers/workerGroups are optional. Writable on create and patch. |
| id int | |
| number int | |
| name string | Max length: 255 |
| anyOf | Worker who requested the Maintenance Order. When provided on create without approvedBy, the record is created as an MO Request (response status PENDING_REQUESTS) and workers/workerGroups are optional. Writable on create and patch. |
| 0 | |
| 1 | |
| approvedBy | User who approved the Maintenance Order. Writable on create and patch — supply user id or name (matching fullName). Setting approvedBy on an MO Request converts it to a Maintenance Order. |
| id int | Unique identifier of the referenced entity. |
| name string | Name of the referenced entity.
Max length: 255 |
| anyOf | User who approved the Maintenance Order. Writable on create and patch — supply user id or name (matching fullName). Setting approvedBy on an MO Request converts it to a Maintenance Order. |
| 0 | |
| 1 | |
| anyOf | Unique identifier of the Maintenance Order. |
| 0 | |
| 1 | |
| 2 all of | |
| 0 | |
| 1 object | |
| performedByExternalEntity object | Will always be: true |
| 3 |