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.
/api/mfg/equipmentPublished as /api/v1/equipmentOverview
| 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 › 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. |
| Table | mfg.equipment · 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/equipmentList equipment
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",
"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
| 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",
"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.
| Field | Type | Required | Description |
|---|---|---|---|
name | text | Yes | Name |
description | text | No | Description |
parent_id | uuid | No | Part of — Site, area, line, machine, component — as a parent pointer rather than five tables. |
equipment_type | text | No | Type Allowed: machine site area line cell component tool utility vehicle instrument |
work_center_id | uuid | No | Work center |
location_id | uuid | No | Location |
asset_id | uuid | No | Fixed asset — The same machine as the ledger sees it. A fully written-down machine still runs and still has OEE. |
cost_center_id | uuid | No | Cost center |
manufacturer | text | No | Manufacturer |
model | text | No | Model |
serial_no | text | No | Serial number |
year_installed | integer | No | Year installed |
commissioned_at | date | No | Commissioned |
ideal_cycle_seconds | numeric | No | Ideal 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_hour | numeric | No | Nameplate rate per hour |
rate_uom | text | No | Rate unit |
criticality | text | No | Criticality Allowed: critical high medium low |
is_constraint | boolean | No | Is the constraint |
oee_target_pct | numeric | No | OEE target % |
status | text | No | Status Allowed: active standby maintenance breakdown decommissioned disposed |
notes | text | No | Notes |
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
| 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 |
parent_id | uuid | No | Part of — Site, area, line, machine, component — as a parent pointer rather than five tables. |
equipment_type | text | No | Type Allowed: machine site area line cell component tool utility vehicle instrument |
work_center_id | uuid | No | Work center |
location_id | uuid | No | Location |
asset_id | uuid | No | Fixed asset — The same machine as the ledger sees it. A fully written-down machine still runs and still has OEE. |
cost_center_id | uuid | No | Cost center |
manufacturer | text | No | Manufacturer |
model | text | No | Model |
serial_no | text | No | Serial number |
year_installed | integer | No | Year installed |
commissioned_at | date | No | Commissioned |
ideal_cycle_seconds | numeric | No | Ideal 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_hour | numeric | No | Nameplate rate per hour |
rate_uom | text | No | Rate unit |
criticality | text | No | Criticality Allowed: critical high medium low |
is_constraint | boolean | No | Is the constraint |
oee_target_pct | numeric | No | OEE target % |
status | text | No | Status Allowed: active standby maintenance breakdown decommissioned disposed |
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",
"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
| 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/equipment/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/mfg/equipment/{parentId}/sparesSpares
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/equipment/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/spares" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/equipment/{parentId}/sparesSpares
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/equipment/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/spares" \
-H "Authorization: Bearer $TOKEN"PUT/api/mfg/equipment/{parentId}/spares/{lineId}Spares
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/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
| 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/equipment/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/spares/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/equipment/{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/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
| 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):
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|importResponse
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.
| 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 |
equipment_no | text | read only | Equipment no |
name | text | read, write | Name |
description | text | read, write | Description |
parent_id | uuid | read, write | Part of — Site, area, line, machine, component — as a parent pointer rather than five tables. |
equipment_type | text | read, write | Type Allowed: machine site area line cell component tool utility vehicle instrument |
work_center_id | uuid | read, write | Work center |
location_id | uuid | read, write | Location |
asset_id | uuid | read, write | Fixed asset — The same machine as the ledger sees it. A fully written-down machine still runs and still has OEE. |
cost_center_id | uuid | read, write | Cost center |
manufacturer | text | read, write | Manufacturer |
model | text | read, write | Model |
serial_no | text | read, write | Serial number |
year_installed | integer | read, write | Year installed |
commissioned_at | date | read, write | Commissioned |
ideal_cycle_seconds | numeric | read, write | Ideal 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_hour | numeric | read, write | Nameplate rate per hour |
rate_uom | text | read, write | Rate unit |
criticality | text | read, write | Criticality Allowed: critical high medium low |
is_constraint | boolean | read, write | Is the constraint |
oee_target_pct | numeric | read, write | OEE target % |
running_hours | numeric | read only | Running hours |
cycle_count | bigint | read only | Cycle count |
current_state | text | read only | Current state |
state_since | timestamp with time zone | read only | State since |
status | text | read, write | Status Allowed: active standby maintenance breakdown decommissioned disposed |
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 › Equipment 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.