TRANXACT.AI Help

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.

Type REST16 operationsBase path /api/mfg/maintenance-ordersPublished as /api/v1/maintenance-orders

Download specification (OpenAPI 3.1) Screen: Maintenance Orders

Overview

PackageManufacturing
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tablemfg.maintenance_orders · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
titletextYesTitle
descriptiontextNoDescription
equipment_iduuidNoMachine
work_center_iduuidNoWork center
location_iduuidNoLocation
plan_iduuidNoFrom plan
order_typetextNoType
Allowed: corrective preventive predictive breakdown inspection calibration improvement statutory safety
prioritytextNoPriority
Allowed: emergency high medium low shutdown_only
failure_mode_iduuidNoFailure mode
reason_iduuidNoReason id
required_bydateNoRequired by
scheduled_starttimestamp with time zoneNoScheduled start
scheduled_endtimestamp with time zoneNoScheduled end
assigned_touuidNoAssigned to
crewtextNoCrew
tradetextNoTrade
supplier_iduuidNoSupplier
cost_center_iduuidNoCost center
findingstextNoWhat was actually wrong
work_performedtextNoWork performed
root_causetextNoRoot 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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
titletextYesTitle
descriptiontextNoDescription
equipment_iduuidNoMachine
work_center_iduuidNoWork center
location_iduuidNoLocation
plan_iduuidNoFrom plan
order_typetextNoType
Allowed: corrective preventive predictive breakdown inspection calibration improvement statutory safety
prioritytextNoPriority
Allowed: emergency high medium low shutdown_only
failure_mode_iduuidNoFailure mode
reason_iduuidNoReason id
required_bydateNoRequired by
scheduled_starttimestamp with time zoneNoScheduled start
scheduled_endtimestamp with time zoneNoScheduled end
assigned_touuidNoAssigned to
crewtextNoCrew
tradetextNoTrade
supplier_iduuidNoSupplier
cost_center_iduuidNoCost center
findingstextNoWhat was actually wrong
work_performedtextNoWork performed
root_causetextNoRoot 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

NameTypeDescription
idstring (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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
idstring (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, withLines

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/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

NameTypeDescription
idstring (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, stopMachine

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/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

NameTypeDescription
idstring (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, followUpRequired

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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
order_notextread onlyOrder no
titletextread, writeTitle
descriptiontextread, writeDescription
equipment_iduuidread, writeMachine
work_center_iduuidread, writeWork center
location_iduuidread, writeLocation
plan_iduuidread, writeFrom plan
order_typetextread, writeType
Allowed: corrective preventive predictive breakdown inspection calibration improvement statutory safety
prioritytextread, writePriority
Allowed: emergency high medium low shutdown_only
failure_mode_iduuidread, writeFailure mode
reason_iduuidread, writeReason id
downtime_event_iduuidread onlyDowntime event id
iot_alert_iduuidread onlyIot alert id
nonconformance_iduuidread onlyNonconformance id
requested_byuuidread onlyRequested by
reported_attimestamp with time zoneread onlyReported at
required_bydateread, writeRequired by
scheduled_starttimestamp with time zoneread, writeScheduled start
scheduled_endtimestamp with time zoneread, writeScheduled end
actual_starttimestamp with time zoneread onlyActual start
actual_endtimestamp with time zoneread onlyActual end
response_minutesnumericread onlyResponse minutes
labor_minutesnumericread onlyLabor minutes
production_downtime_minutesnumericread onlyProduction downtime minutes
assigned_touuidread, writeAssigned to
crewtextread, writeCrew
tradetextread, writeTrade
supplier_iduuidread, writeSupplier
cost_labornumericread onlyCost labor
cost_partsnumericread onlyCost parts
cost_contractornumericread onlyCost contractor
cost_totalnumericread onlyCost total
currencytextread onlyCurrency
cost_center_iduuidread, writeCost center
journal_iduuidread onlyJournal id
findingstextread, writeWhat was actually wrong
work_performedtextread, writeWork performed
root_causetextread, writeRoot cause
follow_up_requiredbooleanread onlyFollow up required
follow_up_order_iduuidread onlyFollow up order id
statustextread onlyStatus
completed_byuuidread onlyCompleted by
closed_attimestamp with time zoneread onlyClosed at
created_attimestamp with time zoneread onlyCreated at
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Manufacturing › Maintenance Orders for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.