Manufacturing · Maintenance
Maintenance Plans
What should be done, how often, and measured how — by calendar, by running hours, by cycles, or by a condition somebody is monitoring. The three are different strategies with different costs.
/api/mfg/maintenance-plansPublished as /api/v1/maintenance-plansDownload specification (OpenAPI 3.1) Screen: Maintenance Plans
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 Plans 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_plans · 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
11 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/mfg/maintenance-plansList maintenance plans
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",
"plan_no": "PLA-000001",
"name": "Example",
"description": "text",
"equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"equipment_class": "text",
"work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"maintenance_type": "preventive",
"trigger_type": "calendar",
"interval_days": 10,
"meter_type": "running_hours",
"interval_meter": "1250.00",
"condition_rule_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/mfg/maintenance-plans?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/mfg/maintenance-plans/{id}Read one maintenance plan
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",
"plan_no": "PLA-000001",
"name": "Example",
"description": "text",
"equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"equipment_class": "text",
"work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"maintenance_type": "preventive",
"trigger_type": "calendar",
"interval_days": 10,
"meter_type": "running_hours",
"interval_meter": "1250.00",
"condition_rule_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-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/maintenance-plansCreate a maintenance plan
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
name | text | Yes | Name |
description | text | No | Description |
equipment_id | uuid | No | Machine |
equipment_class | text | No | Equipment class |
work_center_id | uuid | No | Work center |
maintenance_type | text | No | Type Allowed: preventive predictive condition_based inspection lubrication calibration statutory autonomous |
trigger_type | text | No | Triggered by Allowed: calendar meter condition event manual |
interval_days | integer | No | Interval (days) |
meter_type | text | No | Meter Allowed: running_hours cycles units_produced distance starts |
interval_meter | numeric | No | Interval (meter units) |
condition_rule_id | uuid | No | Condition rule |
lead_days | integer | No | Raise the order (days ahead) — A plan that raises its order on the due date is a plan that is always late. |
requires_shutdown | boolean | No | The machine has to stop |
estimated_hours | numeric | No | Estimated hours |
estimated_cost | numeric | No | Estimated cost |
currency | text | No | Currency |
crew_size | integer | No | Crew size |
trade | text | No | Trade |
failure_mode_id | uuid | No | Failure mode it prevents |
document_id | uuid | No | Procedure |
next_due_date | date | No | Next due |
next_due_meter | numeric | No | Next due at meter |
is_active | boolean | No | Active |
notes | text | No | Notes |
Sample body
{
"name": "Example",
"description": "text",
"equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"equipment_class": "text",
"work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"plan_no": "PLA-000001",
"name": "Example",
"description": "text",
"equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"equipment_class": "text",
"work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"maintenance_type": "preventive",
"trigger_type": "calendar",
"interval_days": 10,
"meter_type": "running_hours",
"interval_meter": "1250.00",
"condition_rule_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/mfg/maintenance-plans" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","description":"text","equipment_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","equipment_class":"text","work_center_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/mfg/maintenance-plans/{id}Change a maintenance plan
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 |
|---|---|---|---|
name | text | Yes | Name |
description | text | No | Description |
equipment_id | uuid | No | Machine |
equipment_class | text | No | Equipment class |
work_center_id | uuid | No | Work center |
maintenance_type | text | No | Type Allowed: preventive predictive condition_based inspection lubrication calibration statutory autonomous |
trigger_type | text | No | Triggered by Allowed: calendar meter condition event manual |
interval_days | integer | No | Interval (days) |
meter_type | text | No | Meter Allowed: running_hours cycles units_produced distance starts |
interval_meter | numeric | No | Interval (meter units) |
condition_rule_id | uuid | No | Condition rule |
lead_days | integer | No | Raise the order (days ahead) — A plan that raises its order on the due date is a plan that is always late. |
requires_shutdown | boolean | No | The machine has to stop |
estimated_hours | numeric | No | Estimated hours |
estimated_cost | numeric | No | Estimated cost |
currency | text | No | Currency |
crew_size | integer | No | Crew size |
trade | text | No | Trade |
failure_mode_id | uuid | No | Failure mode it prevents |
document_id | uuid | No | Procedure |
next_due_date | date | No | Next due |
next_due_meter | numeric | No | Next due at meter |
is_active | boolean | No | Active |
notes | text | No | Notes |
Sample body
{
"name": "Example",
"description": "text"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"plan_no": "PLA-000001",
"name": "Example",
"description": "text",
"equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"equipment_class": "text",
"work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"maintenance_type": "preventive",
"trigger_type": "calendar",
"interval_days": 10,
"meter_type": "running_hours",
"interval_meter": "1250.00",
"condition_rule_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/mfg/maintenance-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","description":"text"}'DELETE/api/mfg/maintenance-plans/{id}Delete a maintenance plan
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-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/mfg/maintenance-plans/{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-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/tasks" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/maintenance-plans/{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-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/tasks" \
-H "Authorization: Bearer $TOKEN"PUT/api/mfg/maintenance-plans/{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-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/tasks/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/mfg/maintenance-plans/{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-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/tasks/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/maintenance-plans/{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-plans/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-plans/generateGenerate
Request body
The keys this action reads (* = required; "one of" lists the only values):
planIdResponse
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-plans/generate" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"planId":"value"}'Data model
Every field of a maintenance plan, 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 |
plan_no | text | read only | Plan no |
name | text | read, write | Name |
description | text | read, write | Description |
equipment_id | uuid | read, write | Machine |
equipment_class | text | read, write | Equipment class |
work_center_id | uuid | read, write | Work center |
maintenance_type | text | read, write | Type Allowed: preventive predictive condition_based inspection lubrication calibration statutory autonomous |
trigger_type | text | read, write | Triggered by Allowed: calendar meter condition event manual |
interval_days | integer | read, write | Interval (days) |
meter_type | text | read, write | Meter Allowed: running_hours cycles units_produced distance starts |
interval_meter | numeric | read, write | Interval (meter units) |
condition_rule_id | uuid | read, write | Condition rule |
lead_days | integer | read, write | Raise the order (days ahead) — A plan that raises its order on the due date is a plan that is always late. |
requires_shutdown | boolean | read, write | The machine has to stop |
estimated_hours | numeric | read, write | Estimated hours |
estimated_cost | numeric | read, write | Estimated cost |
currency | text | read, write | Currency |
crew_size | integer | read, write | Crew size |
trade | text | read, write | Trade |
failure_mode_id | uuid | read, write | Failure mode it prevents |
document_id | uuid | read, write | Procedure |
last_performed_at | date | read only | Last performed at |
last_meter_value | numeric | read only | Last meter value |
next_due_date | date | read, write | Next due |
next_due_meter | numeric | read, write | Next due at meter |
is_active | boolean | read, write | Active |
notes | text | read, write | Notes |
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 Plans 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.