Get Workspace Asset Division Unit Signal

GET 
/api/v1/workspaces/:workspace/assets/:asset/divisions/:division/units/:unit/signals/:signal

Get a Signal in a Workspace/Asset/Division/Unit group by their Names.

Request

Path Parameters

workspace stringrequired

Name of the Workspace

asset stringrequired

Name of the Asset

division stringrequired

Name of the Division

unit stringrequired

Name of the Unit

signal stringrequired

Name of the Signal

Responses

200

Success

application/json

Schema

Schema

id integerrequired
ID of the Signal
Possible values: > 0
Example: 1000
name stringrequired
Name of the Signal
Example: Signal 1
createdAt date-timerequired
Creation Date of the Signal
Example: 2025-03-12T18:12:44.466Z
updatedAt date-timerequired
Update Date of the Signal
Example: 2025-03-12T18:12:44.466Z
physicalUnit stringrequired
Physical unit of the Signal
Example: m/s
dataType stringrequired
Data type of the Signal
Possible values: [float, boolean, string, json]
Example: float
description stringnullablerequired
Description of the Signal
Example: Description
longDescription stringnullablerequired

Long description of the Signal

workspace

object

required

id integerrequired

ID of the Workspace

Possible values: > 0

Example: 1000

name stringrequired

Name of the Workspace

Example: Workspace 1

asset

object

required

id integerrequired

ID of the Asset

Possible values: > 0

Example: 1000

name stringrequired

Name of the Asset

Example: Asset 1

division

object

required

id integerrequired

ID of the Division

Possible values: > 0

Example: 1000

name stringrequired

Name of the Division

Example: Division 1

unit

object

required

id integerrequired

ID of the Unit

Possible values: > 0

Example: 1000

name stringrequired

Name of the Unit

Example: Unit 1

device

object

required

id integerrequired

ID of the Device

Possible values: > 0

Example: 1000

name stringrequired

Name of the Device

Example: Device 1

Example (from schema)

{
  "id": 1000,
  "name": "Signal 1",
  "createdAt": "2025-03-12T18:12:44.466Z",
  "updatedAt": "2025-03-12T18:12:44.466Z",
  "physicalUnit": "m/s",
  "dataType": "float",
  "description": "Description",
  "longDescription": "string",
  "workspace": {
    "id": 1000,
    "name": "Workspace 1"
  },
  "asset": {
    "id": 1000,
    "name": "Asset 1"
  },
  "division": {
    "id": 1000,
    "name": "Division 1"
  },
  "unit": {
    "id": 1000,
    "name": "Unit 1"
  },
  "device": {
    "id": 1000,
    "name": "Device 1"
  }
}

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

Signal not found

application/json

Schema

Schema

status stringrequired

Possible values: [Signal not found]

Example (from schema)

{
  "status": "Signal not found"
}

Loading...