GET api/CalculatedDevices/{id}?subLevels={subLevels}&includeLatestReading={includeLatestReading}&includeDeviceProperties={includeDeviceProperties}
Get a specific CalculatedDevice by ID
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The ID of the CalculatedDevice |
integer |
Required |
| subLevels |
Levels to include under this object, as applicable. -1 (the default) returns all sublevels. |
integer |
Default value is -1 |
| includeLatestReading |
Whether or not to include the latest reading in the response |
boolean |
Default value is False |
| includeDeviceProperties |
Whether or not to include Device Properties (such as Reading Bands) in the response |
boolean |
Default value is True |
Body Parameters
None.
Response Information
Resource Description
Requested CalculatedDevice
GetCalculatedDevicesResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| CalculatedDevices |
Array of CalculatedDevice |
Collection of CalculatedDevice |
None. |
| Messages |
Array of messages |
Collection of Message |
None. |
| ServerInformation |
Relevant information regarding the Server |
ServerInformation |
None. |
| VersionInformation |
Relevant information regarding the API's version |
VersionInformation |
None. |
Response Formats
application/json, text/json, text/html
Sample:
{
"CalculatedDevices": [
{
"DisplayIndex": 1,
"Type": 10,
"TypeName": "Sum",
"Timescale": true,
"Option": "sample string 1",
"CustomPeriodStart": "2025-11-09T21:27:07.0726695+10:00",
"CustomPeriodEnd": "2025-11-09T21:27:07.0726695+10:00",
"EquationID": 1,
"EquationName": "sample string 2",
"EquationDescription": "sample string 3",
"Equation": "sample string 4",
"Valid": true,
"Hidden": true,
"Items": [
{
"ID": 1,
"Name": "sample string 2",
"ShortName": "sample string 3",
"Value": 1.0,
"Type": 0,
"Validation": 0,
"Option": 0,
"DeviceID": 1,
"DeviceName": "sample string 4",
"DisplayIndex": 1
},
{
"ID": 1,
"Name": "sample string 2",
"ShortName": "sample string 3",
"Value": 1.0,
"Type": 0,
"Validation": 0,
"Option": 0,
"DeviceID": 1,
"DeviceName": "sample string 4",
"DisplayIndex": 1
}
],
"ID": 6,
"Name": "sample string 7",
"Description": "sample string 8",
"DataNodeID": 1,
"DataNodeName": "sample string 9",
"DecimalPlaces": 1,
"ReadingType": 1,
"ReadingUnitType": 1,
"Category": "sample string 10",
"Reading": {
"DelayFromStart": 1,
"TimeToRun": 2,
"LastReading": "2025-11-09T21:27:07.0726695+10:00",
"Type": 4,
"Units": 5,
"Value": "1.0",
"NumericalValue": 1.0,
"Notes": "sample string 6"
},
"ReadingMinValue": 1.0,
"ReadingMaxValue": 1.0,
"Lifespan": 1,
"BandActionsEnabled": true,
"ReadingValueBands": [
{
"ID": 1,
"DisplayIndex": 2,
"Description": "sample string 3",
"BottomValue": 4.0,
"TopValue": 5.0,
"Color": "sample string 6",
"AlertTriggerType": 0,
"AlertType": 0,
"AlertResendWaitTime": 7,
"MaxAlertRepeat": 8,
"OtherAlertTriggerValue": "sample string 9",
"AutoAcknowledge": true,
"NotifyAcknowledge": true,
"ActionType": 0,
"ActionTargetType": 10,
"ActionTargetID": 12,
"ActionValue": 13.0,
"AlertCountRequired": 14
},
{
"ID": 1,
"DisplayIndex": 2,
"Description": "sample string 3",
"BottomValue": 4.0,
"TopValue": 5.0,
"Color": "sample string 6",
"AlertTriggerType": 0,
"AlertType": 0,
"AlertResendWaitTime": 7,
"MaxAlertRepeat": 8,
"OtherAlertTriggerValue": "sample string 9",
"AutoAcknowledge": true,
"NotifyAcknowledge": true,
"ActionType": 0,
"ActionTargetType": 10,
"ActionTargetID": 12,
"ActionValue": 13.0,
"AlertCountRequired": 14
}
],
"ConfiguredAlerts": [
{
"ID": 1,
"Enabled": true,
"Name": "sample string 3",
"Description": "sample string 4",
"AlertType": 0,
"MaxRepeats": 5,
"WaitTime": 6,
"OwnerID": 7,
"OwnerType": 10,
"Type": 0,
"CheckInControlled": true
},
{
"ID": 1,
"Enabled": true,
"Name": "sample string 3",
"Description": "sample string 4",
"AlertType": 0,
"MaxRepeats": 5,
"WaitTime": 6,
"OwnerID": 7,
"OwnerType": 10,
"Type": 0,
"CheckInControlled": true
}
]
},
{
"DisplayIndex": 1,
"Type": 10,
"TypeName": "Sum",
"Timescale": true,
"Option": "sample string 1",
"CustomPeriodStart": "2025-11-09T21:27:07.0726695+10:00",
"CustomPeriodEnd": "2025-11-09T21:27:07.0726695+10:00",
"EquationID": 1,
"EquationName": "sample string 2",
"EquationDescription": "sample string 3",
"Equation": "sample string 4",
"Valid": true,
"Hidden": true,
"Items": [
{
"ID": 1,
"Name": "sample string 2",
"ShortName": "sample string 3",
"Value": 1.0,
"Type": 0,
"Validation": 0,
"Option": 0,
"DeviceID": 1,
"DeviceName": "sample string 4",
"DisplayIndex": 1
},
{
"ID": 1,
"Name": "sample string 2",
"ShortName": "sample string 3",
"Value": 1.0,
"Type": 0,
"Validation": 0,
"Option": 0,
"DeviceID": 1,
"DeviceName": "sample string 4",
"DisplayIndex": 1
}
],
"ID": 6,
"Name": "sample string 7",
"Description": "sample string 8",
"DataNodeID": 1,
"DataNodeName": "sample string 9",
"DecimalPlaces": 1,
"ReadingType": 1,
"ReadingUnitType": 1,
"Category": "sample string 10",
"Reading": {
"DelayFromStart": 1,
"TimeToRun": 2,
"LastReading": "2025-11-09T21:27:07.0726695+10:00",
"Type": 4,
"Units": 5,
"Value": "1.0",
"NumericalValue": 1.0,
"Notes": "sample string 6"
},
"ReadingMinValue": 1.0,
"ReadingMaxValue": 1.0,
"Lifespan": 1,
"BandActionsEnabled": true,
"ReadingValueBands": [
{
"ID": 1,
"DisplayIndex": 2,
"Description": "sample string 3",
"BottomValue": 4.0,
"TopValue": 5.0,
"Color": "sample string 6",
"AlertTriggerType": 0,
"AlertType": 0,
"AlertResendWaitTime": 7,
"MaxAlertRepeat": 8,
"OtherAlertTriggerValue": "sample string 9",
"AutoAcknowledge": true,
"NotifyAcknowledge": true,
"ActionType": 0,
"ActionTargetType": 10,
"ActionTargetID": 12,
"ActionValue": 13.0,
"AlertCountRequired": 14
},
{
"ID": 1,
"DisplayIndex": 2,
"Description": "sample string 3",
"BottomValue": 4.0,
"TopValue": 5.0,
"Color": "sample string 6",
"AlertTriggerType": 0,
"AlertType": 0,
"AlertResendWaitTime": 7,
"MaxAlertRepeat": 8,
"OtherAlertTriggerValue": "sample string 9",
"AutoAcknowledge": true,
"NotifyAcknowledge": true,
"ActionType": 0,
"ActionTargetType": 10,
"ActionTargetID": 12,
"ActionValue": 13.0,
"AlertCountRequired": 14
}
],
"ConfiguredAlerts": [
{
"ID": 1,
"Enabled": true,
"Name": "sample string 3",
"Description": "sample string 4",
"AlertType": 0,
"MaxRepeats": 5,
"WaitTime": 6,
"OwnerID": 7,
"OwnerType": 10,
"Type": 0,
"CheckInControlled": true
},
{
"ID": 1,
"Enabled": true,
"Name": "sample string 3",
"Description": "sample string 4",
"AlertType": 0,
"MaxRepeats": 5,
"WaitTime": 6,
"OwnerID": 7,
"OwnerType": 10,
"Type": 0,
"CheckInControlled": true
}
]
}
],
"Messages": [
{
"Severity": 0,
"MessageCode": 1,
"CodeDesc": 2,
"MessageText": "sample string 3",
"RecordNumber": 4
},
{
"Severity": 0,
"MessageCode": 1,
"CodeDesc": 2,
"MessageText": "sample string 3",
"RecordNumber": 4
}
],
"ServerInformation": {
"CurrentTimeUTC": "2025-11-09T21:27:07.0726695+10:00",
"BuildDateUTC": "2025-11-09T21:27:07.0726695+10:00"
},
"VersionInformation": {
"Major": 1,
"Minor": 8,
"Hotfix": 0,
"Beta": true,
"Version": "1.8.0.BETA"
}
}