TRANXACT.AI Help

Manufacturing · Connected Plant

PLC Writes

Every value this platform sends to a machine, requested and approved separately, with the old value recorded. This is the table an auditor asks for after an incident.

Type REST9 operationsBase path /api/mfg/plc-commandsPublished as /api/v1/plc-commands

Download specification (OpenAPI 3.1) Screen: PLC Writes

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 › PLC Writes 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.plc_commands · kept per company (and organisational unit where it has one)
RecordRead only; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

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

GET/api/mfg/plc-commandsList plc writes

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",
      "command_no": "COM-000001",
      "controller_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "tag_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "production_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "batch_record_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "intent": "text",
      "value_to_write": "text",
      "previous_value": "text",
      "reason": "text",
      "requested_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "requested_at": "2026-10-30T09:00:00Z"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "command_no": "COM-000001",
  "controller_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tag_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "production_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "batch_record_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "intent": "text",
  "value_to_write": "text",
  "previous_value": "text",
  "reason": "text",
  "requested_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "requested_at": "2026-10-30T09:00:00Z"
}

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

Sample request

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

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

Path parameters

NameTypeDescription
idstring (uuid)The record's id, 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/plc-commands/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/mfg/plc-commands/{id}Delete plc writes

Path parameters

NameTypeDescription
idstring (uuid)The record's id, 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/plc-commands/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/plc-commands/requestRequest

Request body

The keys this action reads (* = required; "one of" lists the only values):

reason*, tagId, value, productionOrderId, batchRecordId, intent; intent one of setpoint|recipe_download|reset_counter|acknowledge|mode_change|start|stop|other

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/plc-commands/request" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"reason":"value","tagId":"value","value":"value","productionOrderId":"value","batchRecordId":"value","intent;":"value"}'
POST/api/mfg/plc-commands/{id}/approveApprove

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

decision, reason

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/plc-commands/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approve" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"decision":"value","reason":"value"}'
POST/api/mfg/plc-commands/{id}/resultResult

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

result, detail; result one of ok|refused|timeout|out_of_range|not_writable|error

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/plc-commands/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/result" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"result":"value","detail;":"value"}'

Data model

Every field of a plc write, 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
command_notextread onlyCommand no
controller_iduuidread onlyController id
tag_iduuidread onlyTag id
equipment_iduuidread onlyEquipment id
production_order_iduuidread onlyProduction order id
batch_record_iduuidread onlyBatch record id
intenttextread onlyIntent
value_to_writetextread onlyValue to write
previous_valuetextread onlyPrevious value
reasontextread onlyReason
requested_byuuidread onlyRequested by
requested_attimestamp with time zoneread onlyRequested at
approved_byuuidread onlyApproved by
approved_attimestamp with time zoneread onlyApproved at
rejected_reasontextread onlyRejected reason
executed_attimestamp with time zoneread onlyExecuted at
resulttextread onlyResult
result_detailtextread onlyResult detail
statustextread onlyStatus
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_attimestamp with time zoneread onlyCreated at
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 › PLC Writes 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.