TRANXACT.AI Help

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.

Type REST11 operationsBase path /api/mfg/maintenance-plansPublished as /api/v1/maintenance-plans

Download specification (OpenAPI 3.1) Screen: Maintenance Plans

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 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.
Tablemfg.maintenance_plans · 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

11 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/mfg/maintenance-plansList maintenance plans

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",
      "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

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",
  "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.

FieldTypeRequiredDescription
nametextYesName
descriptiontextNoDescription
equipment_iduuidNoMachine
equipment_classtextNoEquipment class
work_center_iduuidNoWork center
maintenance_typetextNoType
Allowed: preventive predictive condition_based inspection lubrication calibration statutory autonomous
trigger_typetextNoTriggered by
Allowed: calendar meter condition event manual
interval_daysintegerNoInterval (days)
meter_typetextNoMeter
Allowed: running_hours cycles units_produced distance starts
interval_meternumericNoInterval (meter units)
condition_rule_iduuidNoCondition rule
lead_daysintegerNoRaise the order (days ahead) — A plan that raises its order on the due date is a plan that is always late.
requires_shutdownbooleanNoThe machine has to stop
estimated_hoursnumericNoEstimated hours
estimated_costnumericNoEstimated cost
currencytextNoCurrency
crew_sizeintegerNoCrew size
tradetextNoTrade
failure_mode_iduuidNoFailure mode it prevents
document_iduuidNoProcedure
next_due_datedateNoNext due
next_due_meternumericNoNext due at meter
is_activebooleanNoActive
notestextNoNotes

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

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
nametextYesName
descriptiontextNoDescription
equipment_iduuidNoMachine
equipment_classtextNoEquipment class
work_center_iduuidNoWork center
maintenance_typetextNoType
Allowed: preventive predictive condition_based inspection lubrication calibration statutory autonomous
trigger_typetextNoTriggered by
Allowed: calendar meter condition event manual
interval_daysintegerNoInterval (days)
meter_typetextNoMeter
Allowed: running_hours cycles units_produced distance starts
interval_meternumericNoInterval (meter units)
condition_rule_iduuidNoCondition rule
lead_daysintegerNoRaise the order (days ahead) — A plan that raises its order on the due date is a plan that is always late.
requires_shutdownbooleanNoThe machine has to stop
estimated_hoursnumericNoEstimated hours
estimated_costnumericNoEstimated cost
currencytextNoCurrency
crew_sizeintegerNoCrew size
tradetextNoTrade
failure_mode_iduuidNoFailure mode it prevents
document_iduuidNoProcedure
next_due_datedateNoNext due
next_due_meternumericNoNext due at meter
is_activebooleanNoActive
notestextNoNotes

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

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-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/mfg/maintenance-plans/{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-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/tasks" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/maintenance-plans/{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-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/tasks" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/mfg/maintenance-plans/{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-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

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

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-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):

planId

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

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
plan_notextread onlyPlan no
nametextread, writeName
descriptiontextread, writeDescription
equipment_iduuidread, writeMachine
equipment_classtextread, writeEquipment class
work_center_iduuidread, writeWork center
maintenance_typetextread, writeType
Allowed: preventive predictive condition_based inspection lubrication calibration statutory autonomous
trigger_typetextread, writeTriggered by
Allowed: calendar meter condition event manual
interval_daysintegerread, writeInterval (days)
meter_typetextread, writeMeter
Allowed: running_hours cycles units_produced distance starts
interval_meternumericread, writeInterval (meter units)
condition_rule_iduuidread, writeCondition rule
lead_daysintegerread, writeRaise the order (days ahead) — A plan that raises its order on the due date is a plan that is always late.
requires_shutdownbooleanread, writeThe machine has to stop
estimated_hoursnumericread, writeEstimated hours
estimated_costnumericread, writeEstimated cost
currencytextread, writeCurrency
crew_sizeintegerread, writeCrew size
tradetextread, writeTrade
failure_mode_iduuidread, writeFailure mode it prevents
document_iduuidread, writeProcedure
last_performed_atdateread onlyLast performed at
last_meter_valuenumericread onlyLast meter value
next_due_datedateread, writeNext due
next_due_meternumericread, writeNext due at meter
is_activebooleanread, writeActive
notestextread, writeNotes
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 Plans 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.