GET HwStructure/getSensor?HwStructNodePath={HwStructNodePath}&Token={Token}

Retrieve sensor and relay detail data from the system. Application privilege "View" for licensed agenda "HW structure" required. Data may also be restricted by record permission "View" of agenda "HW structure"

Request Information

Authorization

Authorization by token required

Availability

Method can be used

URI Parameters

Name	Description	Type	Additional information
HwStructNodePath	Unique identification of the sensor in the system	string	Required
Token	The action is authorized by this token. Token should generated by calling action "POST login". Expiration time of each token is 20 seconds	globally unique identifier	Required

Body Parameters

None.

Response Information

Response Codes

Http Code	Error Number	Description
200 request succesfully done	0	Successfully done
400 bad request	1002	Entry parameter missing or parameter bindigs failed
401 unauthorized	1000	Token {0} not found
401 unauthorized	1001	Token {0} already expired
401 unauthorized	1006	Ip filter violated for ip client address [{0}]
401 unauthorized	1007	Ip filter [{0}] parsing failed
401 unauthorized	1008	Request rate policy violated for [{0}]
403 server refuses fo fulfill the request	1221	Privilege View of agenda HW structure violated for [{0}]
403 server refuses fo fulfill the request	1225	Record permission View of agenda HW structure violated for [{0}]
404 required resource does not exist on the server	1220	Hw structure unit not found
415 unsupported Media Type		The request entity has a media type which the server or resource does not support. Only application/json and application/xml are supported
500 internal error		Server exception description

Resource Description

HwStructureGetResp

Name	Description	Type	Additional information
HwStructNodePath	Unique identification of the unit node within hardware tree structure	string	None.
Title	The name of the hardware unit	string	None.
Description	The description of the hardware unit	string	None.
AddressPoint	The address point related to this hardware unit	string	None.
ParentUnit	The unique identification of the hw unit parent in the system.	string	None.
IsSensor	The sensor flag of the hw structure unit.	integer	None.
RelayIndex	The sensor flag of the hw structure unit.	integer	None.
TimeLastChange	The last change time of the data record. Can be used to check manual modification of data record	date	None.
UdsCollection	The collection of available user defined columns of the agenda in the system: Any user defined columns have not been found	Collection of UdsOut	None.

Response Formats

application/json

Sample:

{"HwStructNodePath":"HW Structure - 0000151515ff S3","Title":"Sensor S3","Description":"Sensor S3 of the hardware unit with MAC address 0000151515ff","AddressPoint":null,"ParentUnit":null,"IsSensor":0,"RelayIndex":null,"TimeLastChange":"\/Date(1732183510038)\/","UdsCollection":null}

application/xml

Sample:


<HwStructureGetResp>
  <HwStructNodePath>HW Structure - 0000151515ff S3</HwStructNodePath>
  <Title>Sensor S3</Title>
  <Description>Sensor S3 of the hardware unit with MAC address 0000151515ff</Description>
  <IsSensor>0</IsSensor>
  <TimeLastChange>2024-11-21T10:05:10.0380794Z</TimeLastChange>
</HwStructureGetResp>

text/json

Sample:

{
  "HwStructNodePath": "sample string 1",
  "AddressPoint": "sample string 4",
  "ParentUnit": "sample string 5",
  "IsSensor": 6,
  "UdsCollection": [
    {
      "SystemName": "sample string 1",
      "Name": "sample string 2",
      "Value": "sample string 3",
      "IsExtern": 4,
      "DataType": "sample string 5"
    },
    {
      "SystemName": "sample string 1",
      "Name": "sample string 2",
      "Value": "sample string 3",
      "IsExtern": 4,
      "DataType": "sample string 5"
    }
  ]
}

text/xml

Sample:

<HwStructureGetResp xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <HwStructNodePath>sample string 1</HwStructNodePath>
  <AddressPoint>sample string 4</AddressPoint>
  <ParentUnit>sample string 5</ParentUnit>
  <IsSensor>6</IsSensor>
  <UdsCollection>
    <UdsOut>
      <SystemName>sample string 1</SystemName>
      <Name>sample string 2</Name>
      <Value>sample string 3</Value>
      <IsExtern>4</IsExtern>
      <DataType>sample string 5</DataType>
    </UdsOut>
    <UdsOut>
      <SystemName>sample string 1</SystemName>
      <Name>sample string 2</Name>
      <Value>sample string 3</Value>
      <IsExtern>4</IsExtern>
      <DataType>sample string 5</DataType>
    </UdsOut>
  </UdsCollection>
</HwStructureGetResp>