Get a Signal in a Unit

GET 
/metadata/scopes/:scope/units/:unit/signals/:signal

Get a Signal in a Unit by its ID.

Request

Path Parameters

scope stringrequired

The Scope to get the Signal in.

unit stringrequired

The Unit to get the Signal in.

signal stringrequired

The Signal to get.

Responses

200

Success

application/json

Schema

Schema

name stringrequired
physicalUnit string
description string
longDescription string
dataType stringrequired

Possible values: [float, boolean, json, string]

Example (from schema)

{
  "name": "string",
  "physicalUnit": "string",
  "description": "string",
  "longDescription": "string",
  "dataType": "float"
}

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

403

Device not yet provisioned

application/json

Schema

Schema

status stringrequired

Possible values: [Device not yet provisioned]

Example (from schema)

{
  "status": "Device not yet provisioned"
}

404

404

application/json

Schema

Schema

oneOf

MOD1

Signal not found

status stringrequired

Possible values: [Signal not found]

MOD2

Scope not found

status stringrequired

Possible values: [Scope not found]

MOD3

Unit not found

status stringrequired

Possible values: [Unit not found]

Example (from schema)

{}

Loading...