API

tekst

GET Signal/Get?accountId={accountId}

Get a list of Signals

Request Information

URI Parameters

Name	Description	Type	Additional information
accountId		integer	Default value is 0

Body Parameters

None.

Response Information

Resource Description

Collection of SignalDefinitionDTO

Name	Description	Type	Additional information
Id	The ID of the signal	integer	None.
StandardUnit		integer	None.
Name	The internal name of the signal	string	None.
Category	The category this signal is part of	string	None.
Metadata	Extra metadata about the signal	Dictionary of string [key] and Object [value]	None.
MetadataId		string	None.
DisplayName	The displayname of the signal	string	None.
Unit	The unit of the signal	string	None.
ValueType	The value type of the signal	IoValueType	None.
IoType	The type of the sygnal	IoTypeDto	None.
Ranges	Ranges defined for the signal	Collection of SignalRangeDTO	None.
Visible	The initial visibility of the signal, can be overwritten by a user setting	boolean	None.
Visibility	Defines the ability to show the signal	SignalVisibility	None.
HysteresisHighValue		decimal number	None.
HysteresisLowValue		decimal number	None.
Icon		string	None.
OnTextValue		string	None.
OffTextValue		string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "StandardUnit": 2,
    "Name": "sample string 3",
    "Category": "sample string 4",
    "Metadata": {
      "sample string 1": {},
      "sample string 3": {}
    },
    "MetadataId": "sample string 5",
    "DisplayName": "sample string 6",
    "Unit": "sample string 7",
    "ValueType": "Analog",
    "IoType": {
      "Id": 1,
      "Name": "sample string 2"
    },
    "Ranges": [
      {
        "From": 1.0,
        "To": 2.0,
        "PrimaryColor": "sample string 3",
        "SecondaryColor": "sample string 4"
      },
      {
        "From": 1.0,
        "To": 2.0,
        "PrimaryColor": "sample string 3",
        "SecondaryColor": "sample string 4"
      }
    ],
    "Visible": true,
    "Visibility": "None",
    "HysteresisHighValue": 1.0,
    "HysteresisLowValue": 1.0,
    "Icon": "sample string 9",
    "OnTextValue": "sample string 10",
    "OffTextValue": "sample string 11"
  },
  {
    "Id": 1,
    "StandardUnit": 2,
    "Name": "sample string 3",
    "Category": "sample string 4",
    "Metadata": {
      "sample string 1": {},
      "sample string 3": {}
    },
    "MetadataId": "sample string 5",
    "DisplayName": "sample string 6",
    "Unit": "sample string 7",
    "ValueType": "Analog",
    "IoType": {
      "Id": 1,
      "Name": "sample string 2"
    },
    "Ranges": [
      {
        "From": 1.0,
        "To": 2.0,
        "PrimaryColor": "sample string 3",
        "SecondaryColor": "sample string 4"
      },
      {
        "From": 1.0,
        "To": 2.0,
        "PrimaryColor": "sample string 3",
        "SecondaryColor": "sample string 4"
      }
    ],
    "Visible": true,
    "Visibility": "None",
    "HysteresisHighValue": 1.0,
    "HysteresisLowValue": 1.0,
    "Icon": "sample string 9",
    "OnTextValue": "sample string 10",
    "OffTextValue": "sample string 11"
  }
]