Manufacturing · Maintenance
Maintenance Orders
Preventive and breakdown work in one document, deliberately: the ratio between them is the most useful number in maintenance, and it cannot be computed across two tables.
/api/mfg/maintenance-ordersPublished as /api/v1/maintenance-ordersDownload specification (OpenAPI 3.1) Screen: Maintenance Orders
Overview
| Package | Manufacturing |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold Manufacturing › Maintenance Orders on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | mfg.maintenance_orders · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
16 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/mfg/maintenance-ordersList maintenance orders
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"order_no": "ORD-000001",
"title": "Example",
"description": "text",
"equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"order_type": "corrective",
"priority": "emergency",
"failure_mode_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"reason_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"downtime_event_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/mfg/maintenance-orders?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/mfg/maintenance-orders/{id}Read one maintenance order
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"order_no": "ORD-000001",
"title": "Example",
"description": "text",
"equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"order_type": "corrective",
"priority": "emergency",
"failure_mode_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"reason_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"downtime_event_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/mfg/maintenance-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/maintenance-ordersCreate a maintenance order
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
title | text | Yes | Title |
description | text | No | Description |
equipment_id | uuid | No | Machine |
work_center_id | uuid | No | Work center |
location_id | uuid | No | Location |
plan_id | uuid | No | From plan |
order_type | text | No | Type Allowed: corrective preventive predictive breakdown inspection calibration improvement statutory safety |
priority | text | No | Priority Allowed: emergency high medium low shutdown_only |
failure_mode_id | uuid | No | Failure mode |
reason_id | uuid | No | Reason id |
required_by | date | No | Required by |
scheduled_start | timestamp with time zone | No | Scheduled start |
scheduled_end | timestamp with time zone | No | Scheduled end |
assigned_to | uuid | No | Assigned to |
crew | text | No | Crew |
trade | text | No | Trade |
supplier_id | uuid | No | Supplier |
cost_center_id | uuid | No | Cost center |
findings | text | No | What was actually wrong |
work_performed | text | No | Work performed |
root_cause | text | No | Root cause |
Sample body
{
"title": "Example",
"description": "text",
"equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"order_no": "ORD-000001",
"title": "Example",
"description": "text",
"equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"order_type": "corrective",
"priority": "emergency",
"failure_mode_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"reason_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"downtime_event_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/mfg/maintenance-orders" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"title":"Example","description":"text","equipment_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","work_center_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","location_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/mfg/maintenance-orders/{id}Change a maintenance order
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
title | text | Yes | Title |
description | text | No | Description |
equipment_id | uuid | No | Machine |
work_center_id | uuid | No | Work center |
location_id | uuid | No | Location |
plan_id | uuid | No | From plan |
order_type | text | No | Type Allowed: corrective preventive predictive breakdown inspection calibration improvement statutory safety |
priority | text | No | Priority Allowed: emergency high medium low shutdown_only |
failure_mode_id | uuid | No | Failure mode |
reason_id | uuid | No | Reason id |
required_by | date | No | Required by |
scheduled_start | timestamp with time zone | No | Scheduled start |
scheduled_end | timestamp with time zone | No | Scheduled end |
assigned_to | uuid | No | Assigned to |
crew | text | No | Crew |
trade | text | No | Trade |
supplier_id | uuid | No | Supplier |
cost_center_id | uuid | No | Cost center |
findings | text | No | What was actually wrong |
work_performed | text | No | Work performed |
root_cause | text | No | Root cause |
Sample body
{
"title": "Example",
"description": "text"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"order_no": "ORD-000001",
"title": "Example",
"description": "text",
"equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"plan_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"order_type": "corrective",
"priority": "emergency",
"failure_mode_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"reason_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"downtime_event_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/mfg/maintenance-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"title":"Example","description":"text"}'DELETE/api/mfg/maintenance-orders/{id}Delete a maintenance order
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/mfg/maintenance-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/mfg/maintenance-orders/{parentId}/tasksTasks
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/mfg/maintenance-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/tasks" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/maintenance-orders/{parentId}/tasksTasks
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/mfg/maintenance-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/tasks" \
-H "Authorization: Bearer $TOKEN"PUT/api/mfg/maintenance-orders/{parentId}/tasks/{lineId}Tasks
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/mfg/maintenance-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/tasks/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/mfg/maintenance-orders/{parentId}/tasks/{lineId}Tasks
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/mfg/maintenance-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/tasks/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/mfg/maintenance-orders/{parentId}/partsParts
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/mfg/maintenance-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/parts" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/maintenance-orders/{parentId}/partsParts
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/mfg/maintenance-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/parts" \
-H "Authorization: Bearer $TOKEN"PUT/api/mfg/maintenance-orders/{parentId}/parts/{lineId}Parts
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/mfg/maintenance-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/parts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/mfg/maintenance-orders/{parentId}/parts/{lineId}Parts
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/mfg/maintenance-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/parts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/maintenance-orders/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/mfg/maintenance-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'POST/api/mfg/maintenance-orders/{id}/startStart
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
startWithoutParts, assignedTo, stopMachineResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/mfg/maintenance-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/start" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"startWithoutParts":"value","assignedTo":"value","stopMachine":"value"}'POST/api/mfg/maintenance-orders/{id}/completeComplete
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
findings*, laborMinutes, laborRate, contractorCost, workPerformed, rootCause, downtimeMinutes, followUpRequiredResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/mfg/maintenance-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/complete" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"findings":"value","laborMinutes":"value","laborRate":"value","contractorCost":"value","workPerformed":"value","rootCause":"value"}'Data model
Every field of a maintenance order, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
order_no | text | read only | Order no |
title | text | read, write | Title |
description | text | read, write | Description |
equipment_id | uuid | read, write | Machine |
work_center_id | uuid | read, write | Work center |
location_id | uuid | read, write | Location |
plan_id | uuid | read, write | From plan |
order_type | text | read, write | Type Allowed: corrective preventive predictive breakdown inspection calibration improvement statutory safety |
priority | text | read, write | Priority Allowed: emergency high medium low shutdown_only |
failure_mode_id | uuid | read, write | Failure mode |
reason_id | uuid | read, write | Reason id |
downtime_event_id | uuid | read only | Downtime event id |
iot_alert_id | uuid | read only | Iot alert id |
nonconformance_id | uuid | read only | Nonconformance id |
requested_by | uuid | read only | Requested by |
reported_at | timestamp with time zone | read only | Reported at |
required_by | date | read, write | Required by |
scheduled_start | timestamp with time zone | read, write | Scheduled start |
scheduled_end | timestamp with time zone | read, write | Scheduled end |
actual_start | timestamp with time zone | read only | Actual start |
actual_end | timestamp with time zone | read only | Actual end |
response_minutes | numeric | read only | Response minutes |
labor_minutes | numeric | read only | Labor minutes |
production_downtime_minutes | numeric | read only | Production downtime minutes |
assigned_to | uuid | read, write | Assigned to |
crew | text | read, write | Crew |
trade | text | read, write | Trade |
supplier_id | uuid | read, write | Supplier |
cost_labor | numeric | read only | Cost labor |
cost_parts | numeric | read only | Cost parts |
cost_contractor | numeric | read only | Cost contractor |
cost_total | numeric | read only | Cost total |
currency | text | read only | Currency |
cost_center_id | uuid | read, write | Cost center |
journal_id | uuid | read only | Journal id |
findings | text | read, write | What was actually wrong |
work_performed | text | read, write | Work performed |
root_cause | text | read, write | Root cause |
follow_up_required | boolean | read only | Follow up required |
follow_up_order_id | uuid | read only | Follow up order id |
status | text | read only | Status |
completed_by | uuid | read only | Completed by |
closed_at | timestamp with time zone | read only | Closed at |
created_at | timestamp with time zone | read only | Created at |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Manufacturing › Maintenance Orders for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.