TRANXACT.AI Help

Manufacturing · Connected Plant

Signals

What a device measures, one row per quantity. The scaling lives here because it is a property of the measurement — applied downstream, every consumer has to know it and one of them eventually will not.

Type REST6 operationsBase path /api/mfg/iot-signalsPublished as /api/v1/iot-signals

Download specification (OpenAPI 3.1) Screen: Signals

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 › Signals 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.iot_signals · 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

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

GET/api/mfg/iot-signalsList signals

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",
      "device_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "signal_key": "text",
      "name": "Example",
      "measurement": "temperature",
      "uom": "text",
      "scale_factor": "1250.00",
      "offset_value": "1250.00",
      "deadband": "1250.00",
      "normal_min": "1250.00",
      "normal_max": "1250.00",
      "binds_to": "none",
      "recipe_parameter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "spc_chart_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "device_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "signal_key": "text",
  "name": "Example",
  "measurement": "temperature",
  "uom": "text",
  "scale_factor": "1250.00",
  "offset_value": "1250.00",
  "deadband": "1250.00",
  "normal_min": "1250.00",
  "normal_max": "1250.00",
  "binds_to": "none",
  "recipe_parameter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "spc_chart_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/iot-signals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/iot-signalsCreate a signal

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
device_iduuidYesDevice
signal_keytextYesSignal key
nametextYesName
measurementtextNoMeasures
Allowed: temperature pressure vibration current voltage power energy flow level humidity speed torque
uomtextNoUnit
scale_factornumericNoScale factor
offset_valuenumericNoOffset
deadbandnumericNoDeadband
normal_minnumericNoNormal minimum
normal_maxnumericNoNormal maximum
binds_totextNoWhat it means here — A temperature is a temperature until it is bound to a recipe parameter — at which point capturing it into a batch record becomes configuration rather than code.
Allowed: none recipe_parameter oee_count oee_state spc_characteristic condition_monitor
recipe_parameter_iduuidNoRecipe parameter
spc_chart_iduuidNoControl chart
retention_daysintegerNoRetention (days)
is_activebooleanNoActive

Sample body

{
  "device_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "signal_key": "text",
  "name": "Example",
  "measurement": "temperature",
  "uom": "text",
  "scale_factor": "1250.00",
  "offset_value": "1250.00"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "device_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "signal_key": "text",
  "name": "Example",
  "measurement": "temperature",
  "uom": "text",
  "scale_factor": "1250.00",
  "offset_value": "1250.00",
  "deadband": "1250.00",
  "normal_min": "1250.00",
  "normal_max": "1250.00",
  "binds_to": "none",
  "recipe_parameter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "spc_chart_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/mfg/iot-signals" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"device_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","signal_key":"text","name":"Example","measurement":"temperature","uom":"text","scale_factor":"1250.00","offset_value":"1250.00"}'
PUT/api/mfg/iot-signals/{id}Change a signal

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
device_iduuidYesDevice
signal_keytextYesSignal key
nametextYesName
measurementtextNoMeasures
Allowed: temperature pressure vibration current voltage power energy flow level humidity speed torque
uomtextNoUnit
scale_factornumericNoScale factor
offset_valuenumericNoOffset
deadbandnumericNoDeadband
normal_minnumericNoNormal minimum
normal_maxnumericNoNormal maximum
binds_totextNoWhat it means here — A temperature is a temperature until it is bound to a recipe parameter — at which point capturing it into a batch record becomes configuration rather than code.
Allowed: none recipe_parameter oee_count oee_state spc_characteristic condition_monitor
recipe_parameter_iduuidNoRecipe parameter
spc_chart_iduuidNoControl chart
retention_daysintegerNoRetention (days)
is_activebooleanNoActive

Sample body

{
  "device_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "signal_key": "text"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "device_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "signal_key": "text",
  "name": "Example",
  "measurement": "temperature",
  "uom": "text",
  "scale_factor": "1250.00",
  "offset_value": "1250.00",
  "deadband": "1250.00",
  "normal_min": "1250.00",
  "normal_max": "1250.00",
  "binds_to": "none",
  "recipe_parameter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "spc_chart_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

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

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/iot-signals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/iot-signals/{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/iot-signals/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 signal, 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
device_iduuidread, writeDevice
signal_keytextread, writeSignal key
nametextread, writeName
measurementtextread, writeMeasures
Allowed: temperature pressure vibration current voltage power energy flow level humidity speed torque
uomtextread, writeUnit
scale_factornumericread, writeScale factor
offset_valuenumericread, writeOffset
deadbandnumericread, writeDeadband
normal_minnumericread, writeNormal minimum
normal_maxnumericread, writeNormal maximum
binds_totextread, writeWhat it means here — A temperature is a temperature until it is bound to a recipe parameter — at which point capturing it into a batch record becomes configuration rather than code.
Allowed: none recipe_parameter oee_count oee_state spc_characteristic condition_monitor
recipe_parameter_iduuidread, writeRecipe parameter
spc_chart_iduuidread, writeControl chart
retention_daysintegerread, writeRetention (days)
is_activebooleanread, writeActive
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread onlyOrg unit id
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 › Signals 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.