Skip to main content
GET
Get a machine data source

Authorizations

Authorization
string
header
required

OAuth 2.0 client credentials. Exchange your client_id and client_secret for an access token scoped to the organisation that provides data access.

Headers

Cula-Organisation-Id
string
required

ID of the organisation the request operates on behalf of (e.g. org_...). Must be an organisation the API client has access to.

Example:

"org_01k83mfmhgchya944v86ryvhpq"

Path Parameters

id
string
required
Example:

"mds_01kqzcjrpyf27tge7875y20mmr"

Response

Machine data source

id
string
required

Unique identifier of the machine data source.

Example:

"mds_01kqzcjrpyf27tge7875y20mmr"

name
string
required

Human-readable name of the machine data source.

Example:

"Truck Scale"

site
object
required

The site that owns this machine data source.

Example:
transport
enum<string> | null
required

How the values of the source reach Cula: mqtt_ixon (published over MQTT in the IXON format) or mqtt_dingx (published over MQTT in the DingX format). Null for sources whose values are pushed through this API, imported or generated.

Available options:
mqtt_ixon,
mqtt_dingx,
null
Example:

"mqtt_ixon"

protocol
enum<string> | null
required

Protocol between the gateway and the PLC or device behind the source. Null when the gateway does not report it, e.g. for a customer system publishing on its own.

Available options:
opc_ua,
siemens_s7,
modbus,
mc_protocol,
bacnet_ip,
ethernet_ip,
null
Example:

"opc_ua"