List Data Connections

GET 
/api/v1/live-data/connections

List Data Connections

Request

Query Parameters

size integer
Possible values: > 0 and <= 100
Default value: 100
nextToken string
sortBy string

Possible values: [name, workspaceId, signals, format]

sortOrder string
Possible values: [asc, desc]
Default value: asc
workspaceId integerrequired

Possible values: > 0

ID of the Workspace

Responses

200

Success

application/json

Schema

Schema

size integerrequired
Possible values: > 0
Example: 100

data

object[]

required

Array [

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

]

]

next

object

token stringrequired

Example: eyJjdXJzb3IiOjEsInRva2VuIjoiIn0K

href urirequired

Example: /connections/api/v1?size=10&sortBy=name&sortOrder=asc&nextToken=eyJjdXJzb3IiOjEsInRva2VuIjoiIn0K

Example (from schema)

{
  "size": 100,
  "data": [
    {
      "id": 1000,
      "name": "string",
      "workspaceId": 1000,
      "brokerUrl": "mqtts://live.data.apps.nor.tech",
      "topics": [
        {
          "signalId": 1000,
          "name": "string"
        }
      ]
    }
  ],
  "next": {
    "token": "eyJjdXJzb3IiOjEsInRva2VuIjoiIn0K",
    "href": "/connections/api/v1?size=10&sortBy=name&sortOrder=asc&nextToken=eyJjdXJzb3IiOjEsInRva2VuIjoiIn0K"
  }
}

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"
}

Loading...