TRANXACT.AI Help

Manufacturing · Equipment & OEE

Equipment

The physical machine, which is neither the work center (a scheduling object) nor the fixed asset (a ledger one). It names both.

Type REST11 operationsBase path /api/mfg/equipmentPublished as /api/v1/equipment

Download specification (OpenAPI 3.1) Screen: Equipment

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 › Equipment 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.equipment · 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/equipmentList equipment

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",
      "equipment_no": "EQU-000001",
      "name": "Example",
      "description": "text",
      "parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "equipment_type": "machine",
      "work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "asset_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "manufacturer": "text",
      "model": "text",
      "serial_no": "SER-000001"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "equipment_no": "EQU-000001",
  "name": "Example",
  "description": "text",
  "parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "equipment_type": "machine",
  "work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "asset_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "manufacturer": "text",
  "model": "text",
  "serial_no": "SER-000001"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
nametextYesName
descriptiontextNoDescription
parent_iduuidNoPart of — Site, area, line, machine, component — as a parent pointer rather than five tables.
equipment_typetextNoType
Allowed: machine site area line cell component tool utility vehicle instrument
work_center_iduuidNoWork center
location_iduuidNoLocation
asset_iduuidNoFixed asset — The same machine as the ledger sees it. A fully written-down machine still runs and still has OEE.
cost_center_iduuidNoCost center
manufacturertextNoManufacturer
modeltextNoModel
serial_notextNoSerial number
year_installedintegerNoYear installed
commissioned_atdateNoCommissioned
ideal_cycle_secondsnumericNoIdeal cycle (seconds) — The NAMEPLATE rate, not the standard. A standard already has losses in it, and performance measured against one measures nothing.
nameplate_rate_per_hournumericNoNameplate rate per hour
rate_uomtextNoRate unit
criticalitytextNoCriticality
Allowed: critical high medium low
is_constraintbooleanNoIs the constraint
oee_target_pctnumericNoOEE target %
statustextNoStatus
Allowed: active standby maintenance breakdown decommissioned disposed
notestextNoNotes

Sample body

{
  "name": "Example",
  "description": "text",
  "parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "equipment_type": "machine",
  "work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "equipment_no": "EQU-000001",
  "name": "Example",
  "description": "text",
  "parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "equipment_type": "machine",
  "work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "asset_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "manufacturer": "text",
  "model": "text",
  "serial_no": "SER-000001"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/mfg/equipment" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Example","description":"text","parent_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","equipment_type":"machine","work_center_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
PUT/api/mfg/equipment/{id}Change a equipment

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
parent_iduuidNoPart of — Site, area, line, machine, component — as a parent pointer rather than five tables.
equipment_typetextNoType
Allowed: machine site area line cell component tool utility vehicle instrument
work_center_iduuidNoWork center
location_iduuidNoLocation
asset_iduuidNoFixed asset — The same machine as the ledger sees it. A fully written-down machine still runs and still has OEE.
cost_center_iduuidNoCost center
manufacturertextNoManufacturer
modeltextNoModel
serial_notextNoSerial number
year_installedintegerNoYear installed
commissioned_atdateNoCommissioned
ideal_cycle_secondsnumericNoIdeal cycle (seconds) — The NAMEPLATE rate, not the standard. A standard already has losses in it, and performance measured against one measures nothing.
nameplate_rate_per_hournumericNoNameplate rate per hour
rate_uomtextNoRate unit
criticalitytextNoCriticality
Allowed: critical high medium low
is_constraintbooleanNoIs the constraint
oee_target_pctnumericNoOEE target %
statustextNoStatus
Allowed: active standby maintenance breakdown decommissioned disposed
notestextNoNotes

Sample body

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "equipment_no": "EQU-000001",
  "name": "Example",
  "description": "text",
  "parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "equipment_type": "machine",
  "work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "asset_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "manufacturer": "text",
  "model": "text",
  "serial_no": "SER-000001"
}

Sample request

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

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/equipment/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/mfg/equipment/{parentId}/sparesSpares

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/equipment/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/spares" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/equipment/{parentId}/sparesSpares

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/equipment/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/spares" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/mfg/equipment/{parentId}/spares/{lineId}Spares

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/equipment/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/spares/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/mfg/equipment/{parentId}/spares/{lineId}Spares

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/equipment/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/spares/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/equipment/{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/equipment/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/equipment/{id}/stateState

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

state, reasonId, productionOrderId, shiftId, source, comment; state one of running|idle|setup|down|planned_stop|starved|blocked|off; source one of plc|iot|operator|supervisor|system|import

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/equipment/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/state" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"state":"value","reasonId":"value","productionOrderId":"value","shiftId":"value","source":"value","comment;":"value"}'

Data model

Every field of a equipment, 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
equipment_notextread onlyEquipment no
nametextread, writeName
descriptiontextread, writeDescription
parent_iduuidread, writePart of — Site, area, line, machine, component — as a parent pointer rather than five tables.
equipment_typetextread, writeType
Allowed: machine site area line cell component tool utility vehicle instrument
work_center_iduuidread, writeWork center
location_iduuidread, writeLocation
asset_iduuidread, writeFixed asset — The same machine as the ledger sees it. A fully written-down machine still runs and still has OEE.
cost_center_iduuidread, writeCost center
manufacturertextread, writeManufacturer
modeltextread, writeModel
serial_notextread, writeSerial number
year_installedintegerread, writeYear installed
commissioned_atdateread, writeCommissioned
ideal_cycle_secondsnumericread, writeIdeal cycle (seconds) — The NAMEPLATE rate, not the standard. A standard already has losses in it, and performance measured against one measures nothing.
nameplate_rate_per_hournumericread, writeNameplate rate per hour
rate_uomtextread, writeRate unit
criticalitytextread, writeCriticality
Allowed: critical high medium low
is_constraintbooleanread, writeIs the constraint
oee_target_pctnumericread, writeOEE target %
running_hoursnumericread onlyRunning hours
cycle_countbigintread onlyCycle count
current_statetextread onlyCurrent state
state_sincetimestamp with time zoneread onlyState since
statustextread, writeStatus
Allowed: active standby maintenance breakdown decommissioned disposed
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 › Equipment 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.