Skip to main content

List Workspace Signals

GET 
/api/v1/workspaces/:workspace/signals

List all Signals in a Workspace by its IDs.

Request​

Path Parameters

    workspace integerrequired

    Possible values: > 0

    ID of the Workspace

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/1000/signals/api/v1?size=10&sortBy=name&sortOrder=asc&nextToken=eyJjdXJzb3IiOjEsInRva2VuIjoiIn0K
Loading...