TRANXACT.AI Help

Manufacturing · Maintenance

Failure Modes

How this KIND of equipment fails, with the effect and the detection method. Kept at the class rather than the machine, or the same bearing failure is entered forty times and never groups.

Type REST6 operationsBase path /api/mfg/failure-modesPublished as /api/v1/failure-modes

Download specification (OpenAPI 3.1) Screen: Failure Modes

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 › Failure Modes 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.failure_modes · 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

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

GET/api/mfg/failure-modesList failure modes

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",
      "code": "COD-000001",
      "name": "Example",
      "equipment_class": "text",
      "equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "component": "text",
      "failure_mode": "text",
      "effect": "text",
      "cause": "text",
      "detection_method": "text",
      "severity": 10,
      "occurrence": 10,
      "detection": 10
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/mfg/failure-modes?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/mfg/failure-modes/{id}Read one failure mode

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",
  "code": "COD-000001",
  "name": "Example",
  "equipment_class": "text",
  "equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "component": "text",
  "failure_mode": "text",
  "effect": "text",
  "cause": "text",
  "detection_method": "text",
  "severity": 10,
  "occurrence": 10,
  "detection": 10
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/mfg/failure-modes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/failure-modesCreate a failure mode

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
nametextYesName
equipment_classtextNoEquipment class
equipment_iduuidNoMachine
componenttextNoComponent
failure_modetextYesHow it fails
effecttextNoEffect
causetextNoCause
detection_methodtextNoHow it is detected
severityintegerNoSeverity (1-10)
occurrenceintegerNoOccurrence (1-10)
detectionintegerNoDetection (1-10)
rpnintegerNoRisk priority number — The product alone is misleading — a 10/2/5 and a 5/5/4 both come to 100 and are not the same problem, which is why the three factors are kept.
recommended_actiontextNoRecommended action
typical_downtime_hoursnumericNoTypical downtime (hours)
typical_costnumericNoTypical cost
is_activebooleanNoActive

Sample body

{
  "name": "Example",
  "failure_mode": "text",
  "equipment_class": "text",
  "equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "component": "text",
  "effect": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "equipment_class": "text",
  "equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "component": "text",
  "failure_mode": "text",
  "effect": "text",
  "cause": "text",
  "detection_method": "text",
  "severity": 10,
  "occurrence": 10,
  "detection": 10
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/mfg/failure-modes" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Example","failure_mode":"text","equipment_class":"text","equipment_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","component":"text","effect":"text"}'
PUT/api/mfg/failure-modes/{id}Change a failure mode

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
equipment_classtextNoEquipment class
equipment_iduuidNoMachine
componenttextNoComponent
failure_modetextYesHow it fails
effecttextNoEffect
causetextNoCause
detection_methodtextNoHow it is detected
severityintegerNoSeverity (1-10)
occurrenceintegerNoOccurrence (1-10)
detectionintegerNoDetection (1-10)
rpnintegerNoRisk priority number — The product alone is misleading — a 10/2/5 and a 5/5/4 both come to 100 and are not the same problem, which is why the three factors are kept.
recommended_actiontextNoRecommended action
typical_downtime_hoursnumericNoTypical downtime (hours)
typical_costnumericNoTypical cost
is_activebooleanNoActive

Sample body

{
  "name": "Example",
  "failure_mode": "text"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "equipment_class": "text",
  "equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "component": "text",
  "failure_mode": "text",
  "effect": "text",
  "cause": "text",
  "detection_method": "text",
  "severity": 10,
  "occurrence": 10,
  "detection": 10
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/mfg/failure-modes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Example","failure_mode":"text"}'
DELETE/api/mfg/failure-modes/{id}Delete a failure mode

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/failure-modes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/failure-modes/{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/failure-modes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'

Data model

Every field of a failure mode, 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
codetextread onlyCode
nametextread, writeName
equipment_classtextread, writeEquipment class
equipment_iduuidread, writeMachine
componenttextread, writeComponent
failure_modetextread, writeHow it fails
effecttextread, writeEffect
causetextread, writeCause
detection_methodtextread, writeHow it is detected
severityintegerread, writeSeverity (1-10)
occurrenceintegerread, writeOccurrence (1-10)
detectionintegerread, writeDetection (1-10)
rpnintegerread, writeRisk priority number — The product alone is misleading — a 10/2/5 and a 5/5/4 both come to 100 and are not the same problem, which is why the three factors are kept.
recommended_actiontextread, writeRecommended action
typical_downtime_hoursnumericread, writeTypical downtime (hours)
typical_costnumericread, writeTypical cost
is_activebooleanread, writeActive
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 › Failure Modes 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.