TRANXACT.AI Help

Manufacturing · Connected Plant

PLC Controllers

Writes are OFF by default, and that is deliberate: a write to a running machine is a physical action, and the safest configuration is the one where a misconfigured screen cannot take one.

Type REST10 operationsBase path /api/mfg/plc-controllersPublished as /api/v1/plc-controllers

Download specification (OpenAPI 3.1) Screen: PLC Controllers

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 Controllers 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_controllers · 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

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

GET/api/mfg/plc-controllersList plc controllers

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",
      "controller_no": "CON-000001",
      "name": "Example",
      "vendor": "siemens",
      "model": "text",
      "protocol": "text",
      "endpoint": "text",
      "rack": 10,
      "slot": 10,
      "unit_id": 10,
      "security_mode": "none",
      "secret_ref": "text",
      "equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "controller_no": "CON-000001",
  "name": "Example",
  "vendor": "siemens",
  "model": "text",
  "protocol": "text",
  "endpoint": "text",
  "rack": 10,
  "slot": 10,
  "unit_id": 10,
  "security_mode": "none",
  "secret_ref": "text",
  "equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
nametextYesName
vendortextNoVendor
Allowed: siemens rockwell mitsubishi omron schneider beckhoff abb delta keyence fanuc other
modeltextNoModel
protocoltextNoProtocol — OPC UA subscribes and Modbus polls, and the difference decides how the whole integration behaves under a network fault.
endpointtextNoEndpoint
rackintegerNoRack
slotintegerNoSlot
unit_idintegerNoUnit id
security_modetextNoSecurity
Allowed: none sign sign_encrypt tls vpn_only
secret_reftextNoCredential reference
equipment_iduuidNoMachine
work_center_iduuidNoWork center
gateway_iduuidNoReached through gateway
poll_interval_msintegerNoPoll interval (ms)
writes_enabledbooleanNoThis platform may write to it
write_requires_approvalbooleanNoA write needs a second person
statustextNoStatus
Allowed: configured connected degraded disconnected disabled
notestextNoNotes

Sample body

{
  "name": "Example",
  "vendor": "siemens",
  "model": "text",
  "protocol": "text",
  "endpoint": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "controller_no": "CON-000001",
  "name": "Example",
  "vendor": "siemens",
  "model": "text",
  "protocol": "text",
  "endpoint": "text",
  "rack": 10,
  "slot": 10,
  "unit_id": 10,
  "security_mode": "none",
  "secret_ref": "text",
  "equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/mfg/plc-controllers" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Example","vendor":"siemens","model":"text","protocol":"text","endpoint":"text"}'
PUT/api/mfg/plc-controllers/{id}Change a plc controller

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
vendortextNoVendor
Allowed: siemens rockwell mitsubishi omron schneider beckhoff abb delta keyence fanuc other
modeltextNoModel
protocoltextNoProtocol — OPC UA subscribes and Modbus polls, and the difference decides how the whole integration behaves under a network fault.
endpointtextNoEndpoint
rackintegerNoRack
slotintegerNoSlot
unit_idintegerNoUnit id
security_modetextNoSecurity
Allowed: none sign sign_encrypt tls vpn_only
secret_reftextNoCredential reference
equipment_iduuidNoMachine
work_center_iduuidNoWork center
gateway_iduuidNoReached through gateway
poll_interval_msintegerNoPoll interval (ms)
writes_enabledbooleanNoThis platform may write to it
write_requires_approvalbooleanNoA write needs a second person
statustextNoStatus
Allowed: configured connected degraded disconnected disabled
notestextNoNotes

Sample body

{
  "name": "Example",
  "vendor": "siemens"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "controller_no": "CON-000001",
  "name": "Example",
  "vendor": "siemens",
  "model": "text",
  "protocol": "text",
  "endpoint": "text",
  "rack": 10,
  "slot": 10,
  "unit_id": 10,
  "security_mode": "none",
  "secret_ref": "text",
  "equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

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

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

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

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

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

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/plc-controllers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/tags/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/plc-controllers/{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-controllers/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 plc controller, 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
controller_notextread onlyController no
nametextread, writeName
vendortextread, writeVendor
Allowed: siemens rockwell mitsubishi omron schneider beckhoff abb delta keyence fanuc other
modeltextread, writeModel
protocoltextread, writeProtocol — OPC UA subscribes and Modbus polls, and the difference decides how the whole integration behaves under a network fault.
endpointtextread, writeEndpoint
rackintegerread, writeRack
slotintegerread, writeSlot
unit_idintegerread, writeUnit id
security_modetextread, writeSecurity
Allowed: none sign sign_encrypt tls vpn_only
secret_reftextread, writeCredential reference
equipment_iduuidread, writeMachine
work_center_iduuidread, writeWork center
gateway_iduuidread, writeReached through gateway
poll_interval_msintegerread, writePoll interval (ms)
writes_enabledbooleanread, writeThis platform may write to it
write_requires_approvalbooleanread, writeA write needs a second person
last_connected_attimestamp with time zoneread onlyLast connected at
last_errortimestamp with time zoneread onlyLast error
last_error_texttextread onlyLast error text
tag_countintegerread onlyTag count
statustextread, writeStatus
Allowed: configured connected degraded disconnected disabled
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 › PLC Controllers 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.