Skip to main content

List Workspace Asset Division Unit Signals

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

List all Signals 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

Query Parameters

    size integer

    Possible values: > 0 and <= 100

    Default value: 100
    nextToken string
    sortBy string

    Possible values: [id, name, physicalUnit, dataType, description, longDescription]

    sortOrder string

    Possible values: [asc, desc]

    Default value: asc

Responses​

Success

Schema

    size integerrequired

    Possible values: > 0

    Example: 100

    data

    object[]

    required

  • Array [

    • id integerrequired

    ID of the Signal

    Possible values: > 0

    Example: 1000
    name stringrequired

    Name of the Signal

    Example: Signal 1
    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

  • ]

    • next

    object

    token stringrequired
    Example: eyJjdXJzb3IiOjEsInRva2VuIjoiIn0K
    href urirequired
    Example: /workspaces/Workspace1/assets/Asset1/divisions/Division1/units/Unit1/signals/api/v1?size=10&sortBy=name&sortOrder=asc&nextToken=eyJjdXJzb3IiOjEsInRva2VuIjoiIn0K
Loading...