Manufacturing · Connected Plant
Tag Bindings
What a tag MEANS, and the reason this integration is configuration rather than code. "DB10.DBW4" is meaningless; bound as "good count for PRESS-02" it feeds OEE, confirmations and kanban without anybody writing a transformation.
/api/mfg/plc-bindingsPublished as /api/v1/plc-bindingsOverview
| 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 › Tag Bindings 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.plc_bindings · 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
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/mfg/plc-bindingsList tag bindings
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",
"tag_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"binding": "good_count",
"equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"recipe_parameter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"spc_chart_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"kanban_loop_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"is_cumulative": true,
"rollover_at": "1250.00",
"last_raw_value": "1250.00",
"state_map": {},
"auto_post": true
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/mfg/plc-bindings?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/mfg/plc-bindings/{id}Read one tag binding
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",
"tag_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"binding": "good_count",
"equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"recipe_parameter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"spc_chart_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"kanban_loop_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"is_cumulative": true,
"rollover_at": "1250.00",
"last_raw_value": "1250.00",
"state_map": {},
"auto_post": true
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/mfg/plc-bindings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/plc-bindingsCreate a tag binding
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
tag_id | uuid | Yes | Tag |
binding | text | Yes | What it means Allowed: good_count total_count reject_count cycle_count machine_state running_flag fault_code cycle_time recipe_parameter setpoint kanban_signal meter_reading |
equipment_id | uuid | No | Machine |
work_center_id | uuid | No | Work center |
recipe_parameter_id | uuid | No | Recipe parameter |
spc_chart_id | uuid | No | Control chart |
kanban_loop_id | uuid | No | Kanban loop |
is_cumulative | boolean | No | Counter only goes up — A cumulative counter has to be differenced, and it wraps. Both have to be declared or the first rollover posts a confirmation for four billion parts. |
rollover_at | numeric | No | Rolls over at |
state_map | jsonb | No | State map — How a raw state number maps onto a state name. Every vendor numbers them differently. |
auto_post | boolean | No | Acts without a person |
is_active | boolean | No | Active |
notes | text | No | Notes |
Sample body
{
"tag_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"binding": "good_count",
"equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"recipe_parameter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"spc_chart_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"tag_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"binding": "good_count",
"equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"recipe_parameter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"spc_chart_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"kanban_loop_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"is_cumulative": true,
"rollover_at": "1250.00",
"last_raw_value": "1250.00",
"state_map": {},
"auto_post": true
}Sample request
curl -X POST "https://demo.tranxact.ai/api/mfg/plc-bindings" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"tag_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","binding":"good_count","equipment_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","work_center_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","recipe_parameter_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","spc_chart_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/mfg/plc-bindings/{id}Change a tag binding
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 |
|---|---|---|---|
tag_id | uuid | Yes | Tag |
binding | text | Yes | What it means Allowed: good_count total_count reject_count cycle_count machine_state running_flag fault_code cycle_time recipe_parameter setpoint kanban_signal meter_reading |
equipment_id | uuid | No | Machine |
work_center_id | uuid | No | Work center |
recipe_parameter_id | uuid | No | Recipe parameter |
spc_chart_id | uuid | No | Control chart |
kanban_loop_id | uuid | No | Kanban loop |
is_cumulative | boolean | No | Counter only goes up — A cumulative counter has to be differenced, and it wraps. Both have to be declared or the first rollover posts a confirmation for four billion parts. |
rollover_at | numeric | No | Rolls over at |
state_map | jsonb | No | State map — How a raw state number maps onto a state name. Every vendor numbers them differently. |
auto_post | boolean | No | Acts without a person |
is_active | boolean | No | Active |
notes | text | No | Notes |
Sample body
{
"tag_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"binding": "good_count"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"tag_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"binding": "good_count",
"equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"recipe_parameter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"spc_chart_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"kanban_loop_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"is_cumulative": true,
"rollover_at": "1250.00",
"last_raw_value": "1250.00",
"state_map": {},
"auto_post": true
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/mfg/plc-bindings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"tag_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","binding":"good_count"}'DELETE/api/mfg/plc-bindings/{id}Delete a tag binding
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/plc-bindings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/plc-bindings/{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/plc-bindings/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 tag binding, 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 |
tag_id | uuid | read, write | Tag |
binding | text | read, write | What it means Allowed: good_count total_count reject_count cycle_count machine_state running_flag fault_code cycle_time recipe_parameter setpoint kanban_signal meter_reading |
equipment_id | uuid | read, write | Machine |
work_center_id | uuid | read, write | Work center |
recipe_parameter_id | uuid | read, write | Recipe parameter |
spc_chart_id | uuid | read, write | Control chart |
kanban_loop_id | uuid | read, write | Kanban loop |
is_cumulative | boolean | read, write | Counter only goes up — A cumulative counter has to be differenced, and it wraps. Both have to be declared or the first rollover posts a confirmation for four billion parts. |
rollover_at | numeric | read, write | Rolls over at |
last_raw_value | numeric | read only | Last raw value |
state_map | jsonb | read, write | State map — How a raw state number maps onto a state name. Every vendor numbers them differently. |
auto_post | boolean | read, write | Acts without a person |
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 › Tag Bindings 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.