Create Data Connection

POST 
/api/v1/live-data/connection

Request

application/json

Body

Body

name stringrequired

Name of the Data Cnnection

workspaceId integerrequired
ID of the Workspace
Possible values: > 0
Example: 1000

signals

object

required

Array of Signal ID's or Search JSON's

oneOf

MOD1

Signal search JSON

Array [

workspace stringrequired

Name of the Workspace

Example: Workspace 1

asset stringrequired

Name of the Asset

Example: Asset 1

division stringrequired

Name of the Division

Example: Division 1

unit stringrequired

Name of the Unit

Example: Unit 1

signal stringrequired

Name of the Signal

Example: Signal 1

]

MOD2

ID of the Signal

Array [

integer

Possible values: > 0

]

format stringrequired

Serialization format of the data

Possible values: [json, protobuf]

Responses

200

Success

application/json

Schema

Schema

id integerrequired
ID of the Data Connection
Possible values: > 0
Example: 1000
name stringrequired

Name of the Data Connection

workspaceId integerrequired
ID of the Workspace
Possible values: > 0
Example: 1000
brokerUrl urirequired
URL of the broker to connect to
Example: mqtts://live.data.apps.nor.tech

topics

object[]

required

Array of topics to subscribe to

Array [

signalId integerrequired

ID of the Signal

Possible values: > 0

Example: 1000

name stringrequired

Name of the topic exposing the Signal data

]

Example (from schema)

{
  "id": 1000,
  "name": "string",
  "workspaceId": 1000,
  "brokerUrl": "mqtts://live.data.apps.nor.tech",
  "topics": [
    {
      "signalId": 1000,
      "name": "string"
    }
  ]
}

400

Validation Error

application/json

Schema

Schema

status stringrequired

Possible values: [Validation Error]

errors

object[]

required

Array [

error stringrequired

location stringrequired

Possible values: [body, query, path, headers]

]

Example (from schema)

{
  "status": "Validation Error",
  "errors": [
    {
      "error": "string",
      "location": "body"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

status stringrequired

Possible values: [Unauthorized]

Example (from schema)

{
  "status": "Unauthorized"
}

404

Signals not found

application/json

Schema

Schema

status stringrequired

Possible values: [Signals not found]

signals

object

required

Array of Signal ID's or Search JSON's

oneOf

MOD1

Signal search JSON

Array [

workspace stringrequired

Name of the Workspace

Example: Workspace 1

asset stringrequired

Name of the Asset

Example: Asset 1

division stringrequired

Name of the Division

Example: Division 1

unit stringrequired

Name of the Unit

Example: Unit 1

signal stringrequired

Name of the Signal

Example: Signal 1

]

MOD2

ID of the Signal

Array [

integer

Possible values: > 0

]

Example (from schema)

{
  "status": "Signals not found",
  "signals": [
    {
      "workspace": "Workspace1",
      "asset": "Asset1",
      "division": "Division1",
      "unit": "Unit1",
      "signal": "Signal1"
    },
    {
      "workspace": "Workspace1",
      "asset": "Asset1",
      "division": "Division1",
      "unit": "Unit1",
      "signal": "Signal2"
    }
  ]
}

409

Conflict

application/json

Schema

Schema

status stringrequired

Possible values: [Data connection already exists]

Example (from schema)

{
  "status": "Data connection already exists"
}

Loading...