POST api/CalculatedDevices?subLevels={subLevels}&includeLatestReading={includeLatestReading}

Converts the stored info to the info we want to send out via API..

Request Information

URI Parameters

Name	Description	Type	Additional information
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

Body Parameters

CalculatedDevice to convert

CalculatedDevice

Name	Description	Type	Additional information
Name	Name of the Device	string	None.
Description	Description of the Device	string	None.
NodeID	ID of the DataNode this device belongs to	globally unique identifier	None.
DataNode	DataNode this device belongs to	DataNode	None.
DisplayIndex	User-defined variable to define the order that the devices are displayed in	integer	None.
Category	Category of the Device	string	None.
Lifespan	The number of days to keep a device's logs stored within the database	integer	None.
Type	Gets or sets the Calculated Device Type	CalculatedDeviceType	None.
Option	Option field, dependent on the Type	string	None.
ReadingType	Default reading type	ReadingType	None.
ReadingUnitType	Default reading unit type	ReadingUnitType	None.
ReadingMinValue	Minimum value for readings, note this does not limit reading values but indicates a minimum expected value.	decimal number	None.
ReadingMaxValue	Maximum value for readings, note this does not limit reading values but indicates a maximum expected value.	decimal number	None.
ReadingValueBands	List of for the device	Collection of ReadingValueBand	None.
ObjectInfo	Basic information about this object	ObjectInfo	None.
SourceDb	Database where this Device stores logs to	DatabaseInformation	None.
DefaultDatabase	Whether or not to use the default logs database	boolean	None.
ClientIntID	Integer ID of the Client this Device belongs to	integer	None.
ClientID	ID of the Client this Device belongs to	globally unique identifier	None.
Client	Client that this Device belongs to (lazy loaded)	Client	None.
ID	Gets ID for this record	globally unique identifier	None.
IntID	Gets Integer ID for this record	integer	None.
ObjectType		OwnerType	None.

Request Formats

application/json, text/json, text/html

Sample:

{
  "ObjectType": 10,
  "Name": "sample string 1",
  "Description": "sample string 2",
  "NodeID": "93678917-7b04-4da7-8161-84bc58c55712",
  "DataNode": null,
  "DisplayIndex": 4,
  "Category": "sample string 5",
  "Lifespan": 6,
  "Type": 10,
  "Option": "sample string 7",
  "ReadingType": 0,
  "ReadingUnitType": 0,
  "ReadingMinValue": 1.0,
  "ReadingMaxValue": 1.0,
  "ReadingValueBands": [
    {
      "Description": "sample string 1",
      "BottomValue": 2.0,
      "TopValue": 3.0,
      "Color": "sample string 4",
      "OtherAlertTriggerValue": "sample string 5",
      "AlertTriggerType": 0,
      "AlertType": 0,
      "AlertResendWaitTime": 6,
      "MaxAlertRepeat": 7,
      "AutoAcknowledge": true,
      "NotifyAcknowledge": true,
      "ActionType": 0,
      "ActionTarget": 10,
      "ActionTargetID": 10,
      "ActionValue": 11.0,
      "UnderlyingPropertyItems": [
        {
          "ObjectPropertyID": "ad0a1f36-1a1f-43c7-96ca-46743cfca6bd",
          "PropertyName": "sample string 2",
          "Value": "sample string 3",
          "ID": "27ab1ce8-ee9d-4763-b132-d0dab9d21d74",
          "IntID": 0
        },
        {
          "ObjectPropertyID": "ad0a1f36-1a1f-43c7-96ca-46743cfca6bd",
          "PropertyName": "sample string 2",
          "Value": "sample string 3",
          "ID": "27ab1ce8-ee9d-4763-b132-d0dab9d21d74",
          "IntID": 0
        }
      ],
      "ID": "2c0a9e03-26b6-4a6b-ac23-e1d68a3acd00",
      "IntID": 0
    },
    {
      "Description": "sample string 1",
      "BottomValue": 2.0,
      "TopValue": 3.0,
      "Color": "sample string 4",
      "OtherAlertTriggerValue": "sample string 5",
      "AlertTriggerType": 0,
      "AlertType": 0,
      "AlertResendWaitTime": 6,
      "MaxAlertRepeat": 7,
      "AutoAcknowledge": true,
      "NotifyAcknowledge": true,
      "ActionType": 0,
      "ActionTarget": 10,
      "ActionTargetID": 10,
      "ActionValue": 11.0,
      "UnderlyingPropertyItems": [
        {
          "ObjectPropertyID": "ad0a1f36-1a1f-43c7-96ca-46743cfca6bd",
          "PropertyName": "sample string 2",
          "Value": "sample string 3",
          "ID": "27ab1ce8-ee9d-4763-b132-d0dab9d21d74",
          "IntID": 0
        },
        {
          "ObjectPropertyID": "ad0a1f36-1a1f-43c7-96ca-46743cfca6bd",
          "PropertyName": "sample string 2",
          "Value": "sample string 3",
          "ID": "27ab1ce8-ee9d-4763-b132-d0dab9d21d74",
          "IntID": 0
        }
      ],
      "ID": "2c0a9e03-26b6-4a6b-ac23-e1d68a3acd00",
      "IntID": 0
    }
  ],
  "ObjectInfo": {
    "ID": "df02d84b-8684-47ca-a75a-4225b61c5b4c",
    "IntID": 0,
    "Type": 11,
    "Valid": true
  },
  "SourceDb": {
    "DatabaseName": "agcLive_logs",
    "Type": 0,
    "ConnectionString": "Integrated Security=True; Connect Timeout=60; Min Pool Size=5; Max Pool Size=200;Initial Catalog=agcLive_logs;Data Source=localhost;",
    "ClientID": "00000000-0000-0000-0000-000000000000"
  },
  "DefaultDatabase": true,
  "ClientIntID": 0,
  "ClientID": "99fdefff-ab03-40d9-b747-de647db5abd2",
  "Client": {
    "ParentID": "aa2cb576-a2ba-4a7f-b0e0-7ef4edd1019c",
    "Name": "sample string 2",
    "Notes": "sample string 3",
    "Latitude": 4.1,
    "Longitude": 5.1,
    "GlobalOffset": "sample string 6",
    "GlobalDuration": "sample string 7",
    "ObjectInfo": {
      "ID": "99fdefff-ab03-40d9-b747-de647db5abd2",
      "IntID": 0,
      "Type": 50,
      "Valid": true
    },
    "DefaultDatabase": true,
    "SourceDb": {
      "DatabaseName": "agcLive_logs",
      "Type": 0,
      "ConnectionString": "Integrated Security=True; Connect Timeout=60; Min Pool Size=5; Max Pool Size=200;Initial Catalog=agcLive_logs;Data Source=localhost;",
      "ClientID": "00000000-0000-0000-0000-000000000000"
    },
    "ID": "99fdefff-ab03-40d9-b747-de647db5abd2",
    "IntID": 0
  },
  "ID": "df02d84b-8684-47ca-a75a-4225b61c5b4c",
  "IntID": 0
}

application/xml, text/xml

Sample:

<CalculatedDevice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RimikAPI.Models">
  <auditDelete xmlns="http://schemas.datacontract.org/2004/07/">false</auditDelete>
  <auditInsert xmlns="http://schemas.datacontract.org/2004/07/">false</auditInsert>
  <auditUpdate xmlns="http://schemas.datacontract.org/2004/07/">false</auditUpdate>
  <createDt i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
  <databaseInsertCols xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/" />
  <databaseKey xmlns="http://schemas.datacontract.org/2004/07/">ID</databaseKey>
  <databaseKeys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/" />
  <databaseTable i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
  <databaseTableWithBrackets i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
  <databaseUpdateCols xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/" />
  <hasCreateDt xmlns="http://schemas.datacontract.org/2004/07/">true</hasCreateDt>
  <hasUpdateDt xmlns="http://schemas.datacontract.org/2004/07/">true</hasUpdateDt>
  <id xmlns="http://schemas.datacontract.org/2004/07/">df02d84b-8684-47ca-a75a-4225b61c5b4c</id>
  <intID xmlns="http://schemas.datacontract.org/2004/07/">0</intID>
  <isModified xmlns="http://schemas.datacontract.org/2004/07/">false</isModified>
  <isNew xmlns="http://schemas.datacontract.org/2004/07/">true</isNew>
  <temp i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
  <updateDt i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
  <Category>sample string 5</Category>
  <Client>
    <auditDelete xmlns="http://schemas.datacontract.org/2004/07/">false</auditDelete>
    <auditInsert xmlns="http://schemas.datacontract.org/2004/07/">false</auditInsert>
    <auditUpdate xmlns="http://schemas.datacontract.org/2004/07/">false</auditUpdate>
    <createDt i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
    <databaseInsertCols xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/" />
    <databaseKey xmlns="http://schemas.datacontract.org/2004/07/">ID</databaseKey>
    <databaseKeys xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/" />
    <databaseTable i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
    <databaseTableWithBrackets i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
    <databaseUpdateCols xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/" />
    <hasCreateDt xmlns="http://schemas.datacontract.org/2004/07/">true</hasCreateDt>
    <hasUpdateDt xmlns="http://schemas.datacontract.org/2004/07/">true</hasUpdateDt>
    <id xmlns="http://schemas.datacontract.org/2004/07/">99fdefff-ab03-40d9-b747-de647db5abd2</id>
    <intID xmlns="http://schemas.datacontract.org/2004/07/">0</intID>
    <isModified xmlns="http://schemas.datacontract.org/2004/07/">false</isModified>
    <isNew xmlns="http://schemas.datacontract.org/2004/07/">true</isNew>
    <temp i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
    <updateDt i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
    <DefaultDatabase>true</DefaultDatabase>
    <GlobalDuration>sample string 7</GlobalDuration>
    <GlobalOffset>sample string 6</GlobalOffset>
    <Latitude>4.1</Latitude>
    <Longitude>5.1</Longitude>
    <Name>sample string 2</Name>
    <Notes>sample string 3</Notes>
    <ParentID>aa2cb576-a2ba-4a7f-b0e0-7ef4edd1019c</ParentID>
  </Client>
  <ClientID>99fdefff-ab03-40d9-b747-de647db5abd2</ClientID>
  <ClientIntID>0</ClientIntID>
  <DefaultDatabase>true</DefaultDatabase>
  <Description>sample string 2</Description>
  <DisplayIndex>4</DisplayIndex>
  <Lifespan>6</Lifespan>
  <Name>sample string 1</Name>
  <NodeID>93678917-7b04-4da7-8161-84bc58c55712</NodeID>
  <Option>sample string 7</Option>
  <ReadingMaxValue>1</ReadingMaxValue>
  <ReadingMinValue>1</ReadingMinValue>
  <ReadingType>Generic</ReadingType>
  <ReadingUnitType>Status</ReadingUnitType>
  <ReadingValueBands>
    <ReadingValueBand>
      <auditDelete xmlns="http://schemas.datacontract.org/2004/07/">false</auditDelete>
      <auditInsert xmlns="http://schemas.datacontract.org/2004/07/">false</auditInsert>
      <auditUpdate xmlns="http://schemas.datacontract.org/2004/07/">false</auditUpdate>
      <createDt i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
      <databaseInsertCols xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/" />
      <databaseKey xmlns="http://schemas.datacontract.org/2004/07/">ID</databaseKey>
      <databaseKeys xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/" />
      <databaseTable i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
      <databaseTableWithBrackets i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
      <databaseUpdateCols xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/" />
      <hasCreateDt xmlns="http://schemas.datacontract.org/2004/07/">true</hasCreateDt>
      <hasUpdateDt xmlns="http://schemas.datacontract.org/2004/07/">true</hasUpdateDt>
      <id xmlns="http://schemas.datacontract.org/2004/07/">2c0a9e03-26b6-4a6b-ac23-e1d68a3acd00</id>
      <intID xmlns="http://schemas.datacontract.org/2004/07/">0</intID>
      <isModified xmlns="http://schemas.datacontract.org/2004/07/">false</isModified>
      <isNew xmlns="http://schemas.datacontract.org/2004/07/">true</isNew>
      <temp i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
      <updateDt i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
      <ActionTarget>Device</ActionTarget>
      <ActionTargetID>10</ActionTargetID>
      <ActionType>None</ActionType>
      <ActionValue>11</ActionValue>
      <AlertResendWaitTime>6</AlertResendWaitTime>
      <AlertTriggerType>None</AlertTriggerType>
      <AlertType>Message</AlertType>
      <AutoAcknowledge>true</AutoAcknowledge>
      <BottomValue>2</BottomValue>
      <Color>sample string 4</Color>
      <Description>sample string 1</Description>
      <MaxAlertRepeat>7</MaxAlertRepeat>
      <NotifyAcknowledge>true</NotifyAcknowledge>
      <OtherAlertTriggerValue>sample string 5</OtherAlertTriggerValue>
      <TopValue>3</TopValue>
      <UnderlyingPropertyItems>
        <ObjectPropertyItem>
          <auditDelete xmlns="http://schemas.datacontract.org/2004/07/">false</auditDelete>
          <auditInsert xmlns="http://schemas.datacontract.org/2004/07/">false</auditInsert>
          <auditUpdate xmlns="http://schemas.datacontract.org/2004/07/">false</auditUpdate>
          <createDt i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
          <databaseInsertCols xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/" />
          <databaseKey xmlns="http://schemas.datacontract.org/2004/07/">ID</databaseKey>
          <databaseKeys xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/" />
          <databaseTable i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
          <databaseTableWithBrackets i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
          <databaseUpdateCols xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/" />
          <hasCreateDt xmlns="http://schemas.datacontract.org/2004/07/">true</hasCreateDt>
          <hasUpdateDt xmlns="http://schemas.datacontract.org/2004/07/">true</hasUpdateDt>
          <id xmlns="http://schemas.datacontract.org/2004/07/">27ab1ce8-ee9d-4763-b132-d0dab9d21d74</id>
          <intID xmlns="http://schemas.datacontract.org/2004/07/">0</intID>
          <isModified xmlns="http://schemas.datacontract.org/2004/07/">false</isModified>
          <isNew xmlns="http://schemas.datacontract.org/2004/07/">true</isNew>
          <temp i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
          <updateDt i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
          <ObjectPropertyID>ad0a1f36-1a1f-43c7-96ca-46743cfca6bd</ObjectPropertyID>
          <PropertyName>sample string 2</PropertyName>
          <Value>sample string 3</Value>
        </ObjectPropertyItem>
        <ObjectPropertyItem>
          <auditDelete xmlns="http://schemas.datacontract.org/2004/07/">false</auditDelete>
          <auditInsert xmlns="http://schemas.datacontract.org/2004/07/">false</auditInsert>
          <auditUpdate xmlns="http://schemas.datacontract.org/2004/07/">false</auditUpdate>
          <createDt i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
          <databaseInsertCols xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/" />
          <databaseKey xmlns="http://schemas.datacontract.org/2004/07/">ID</databaseKey>
          <databaseKeys xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/" />
          <databaseTable i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
          <databaseTableWithBrackets i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
          <databaseUpdateCols xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/" />
          <hasCreateDt xmlns="http://schemas.datacontract.org/2004/07/">true</hasCreateDt>
          <hasUpdateDt xmlns="http://schemas.datacontract.org/2004/07/">true</hasUpdateDt>
          <id xmlns="http://schemas.datacontract.org/2004/07/">27ab1ce8-ee9d-4763-b132-d0dab9d21d74</id>
          <intID xmlns="http://schemas.datacontract.org/2004/07/">0</intID>
          <isModified xmlns="http://schemas.datacontract.org/2004/07/">false</isModified>
          <isNew xmlns="http://schemas.datacontract.org/2004/07/">true</isNew>
          <temp i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
          <updateDt i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
          <ObjectPropertyID>ad0a1f36-1a1f-43c7-96ca-46743cfca6bd</ObjectPropertyID>
          <PropertyName>sample string 2</PropertyName>
          <Value>sample string 3</Value>
        </ObjectPropertyItem>
      </UnderlyingPropertyItems>
    </ReadingValueBand>
    <ReadingValueBand>
      <auditDelete xmlns="http://schemas.datacontract.org/2004/07/">false</auditDelete>
      <auditInsert xmlns="http://schemas.datacontract.org/2004/07/">false</auditInsert>
      <auditUpdate xmlns="http://schemas.datacontract.org/2004/07/">false</auditUpdate>
      <createDt i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
      <databaseInsertCols xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/" />
      <databaseKey xmlns="http://schemas.datacontract.org/2004/07/">ID</databaseKey>
      <databaseKeys xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/" />
      <databaseTable i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
      <databaseTableWithBrackets i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
      <databaseUpdateCols xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/" />
      <hasCreateDt xmlns="http://schemas.datacontract.org/2004/07/">true</hasCreateDt>
      <hasUpdateDt xmlns="http://schemas.datacontract.org/2004/07/">true</hasUpdateDt>
      <id xmlns="http://schemas.datacontract.org/2004/07/">2c0a9e03-26b6-4a6b-ac23-e1d68a3acd00</id>
      <intID xmlns="http://schemas.datacontract.org/2004/07/">0</intID>
      <isModified xmlns="http://schemas.datacontract.org/2004/07/">false</isModified>
      <isNew xmlns="http://schemas.datacontract.org/2004/07/">true</isNew>
      <temp i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
      <updateDt i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
      <ActionTarget>Device</ActionTarget>
      <ActionTargetID>10</ActionTargetID>
      <ActionType>None</ActionType>
      <ActionValue>11</ActionValue>
      <AlertResendWaitTime>6</AlertResendWaitTime>
      <AlertTriggerType>None</AlertTriggerType>
      <AlertType>Message</AlertType>
      <AutoAcknowledge>true</AutoAcknowledge>
      <BottomValue>2</BottomValue>
      <Color>sample string 4</Color>
      <Description>sample string 1</Description>
      <MaxAlertRepeat>7</MaxAlertRepeat>
      <NotifyAcknowledge>true</NotifyAcknowledge>
      <OtherAlertTriggerValue>sample string 5</OtherAlertTriggerValue>
      <TopValue>3</TopValue>
      <UnderlyingPropertyItems>
        <ObjectPropertyItem>
          <auditDelete xmlns="http://schemas.datacontract.org/2004/07/">false</auditDelete>
          <auditInsert xmlns="http://schemas.datacontract.org/2004/07/">false</auditInsert>
          <auditUpdate xmlns="http://schemas.datacontract.org/2004/07/">false</auditUpdate>
          <createDt i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
          <databaseInsertCols xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/" />
          <databaseKey xmlns="http://schemas.datacontract.org/2004/07/">ID</databaseKey>
          <databaseKeys xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/" />
          <databaseTable i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
          <databaseTableWithBrackets i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
          <databaseUpdateCols xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/" />
          <hasCreateDt xmlns="http://schemas.datacontract.org/2004/07/">true</hasCreateDt>
          <hasUpdateDt xmlns="http://schemas.datacontract.org/2004/07/">true</hasUpdateDt>
          <id xmlns="http://schemas.datacontract.org/2004/07/">27ab1ce8-ee9d-4763-b132-d0dab9d21d74</id>
          <intID xmlns="http://schemas.datacontract.org/2004/07/">0</intID>
          <isModified xmlns="http://schemas.datacontract.org/2004/07/">false</isModified>
          <isNew xmlns="http://schemas.datacontract.org/2004/07/">true</isNew>
          <temp i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
          <updateDt i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
          <ObjectPropertyID>ad0a1f36-1a1f-43c7-96ca-46743cfca6bd</ObjectPropertyID>
          <PropertyName>sample string 2</PropertyName>
          <Value>sample string 3</Value>
        </ObjectPropertyItem>
        <ObjectPropertyItem>
          <auditDelete xmlns="http://schemas.datacontract.org/2004/07/">false</auditDelete>
          <auditInsert xmlns="http://schemas.datacontract.org/2004/07/">false</auditInsert>
          <auditUpdate xmlns="http://schemas.datacontract.org/2004/07/">false</auditUpdate>
          <createDt i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
          <databaseInsertCols xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/" />
          <databaseKey xmlns="http://schemas.datacontract.org/2004/07/">ID</databaseKey>
          <databaseKeys xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/" />
          <databaseTable i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
          <databaseTableWithBrackets i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
          <databaseUpdateCols xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/" />
          <hasCreateDt xmlns="http://schemas.datacontract.org/2004/07/">true</hasCreateDt>
          <hasUpdateDt xmlns="http://schemas.datacontract.org/2004/07/">true</hasUpdateDt>
          <id xmlns="http://schemas.datacontract.org/2004/07/">27ab1ce8-ee9d-4763-b132-d0dab9d21d74</id>
          <intID xmlns="http://schemas.datacontract.org/2004/07/">0</intID>
          <isModified xmlns="http://schemas.datacontract.org/2004/07/">false</isModified>
          <isNew xmlns="http://schemas.datacontract.org/2004/07/">true</isNew>
          <temp i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
          <updateDt i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/" />
          <ObjectPropertyID>ad0a1f36-1a1f-43c7-96ca-46743cfca6bd</ObjectPropertyID>
          <PropertyName>sample string 2</PropertyName>
          <Value>sample string 3</Value>
        </ObjectPropertyItem>
      </UnderlyingPropertyItems>
    </ReadingValueBand>
  </ReadingValueBands>
  <Type>Sum</Type>
</CalculatedDevice>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Converted (loaded) device

CalculatedDeviceStruct

Name	Description	Type	Additional information
ID	This is the ID of the device	integer	None.
Name	The intuitive name of the Device	string	None.
Description	The description of the Device	string	None.
DataNodeID	The DataNode integer ID	integer	None.
DisplayIndex	User-defined variable to define the order that the devices are displayed in	integer	None.
Category	The user defined Category that can be used to group devices together	string	None.
Lifespan	The number of days logs are kept for this device	integer	None.
Type	The type of the Device e.g. Sum, Average, etc.	CalculatedDeviceType	None.
Option	Option field, dependent on the Type	string	None.
ReadingType	The type of reading the device is	ReadingType	None.
ReadingUnitType	The units of the device readings;	ReadingUnitType	None.
Reading	The latest reading available for this device (e.g. Status:ON/OFF, Pressure: 45PSI...)	Reading	None.
ReadingMinValue	The minimum expected value for this device.	decimal number	None.
ReadingMaxValue	The maximum expected value for this device.	decimal number	None.
ReadingValueBands	Array of .	Collection of ReadingValueBandStruct	None.
Items	Array of	Collection of CalculatedDeviceItem	None.
ConfiguredAlerts	Array of	Collection of ConfiguredAlert	None.

Response Formats

application/json, text/json, text/html

Sample:

{
  "ID": 1,
  "Name": "sample string 2",
  "Description": "sample string 3",
  "DataNodeID": 4,
  "DisplayIndex": 5,
  "Category": "sample string 6",
  "Lifespan": 1,
  "Type": 10,
  "Option": "sample string 7",
  "ReadingType": 0,
  "ReadingUnitType": 0,
  "Reading": {
    "LastReading": "2025-11-09T21:27:48.4444798+10:00",
    "Type": 0,
    "Units": 0,
    "Value": "sample string 2",
    "Notes": "sample string 3",
    "DelayFromStart": 4,
    "TimeToRun": 5
  },
  "ReadingMinValue": 1.0,
  "ReadingMaxValue": 1.0,
  "ReadingValueBands": [
    {
      "ID": 1,
      "Description": "sample string 2",
      "BottomValue": 3.0,
      "TopValue": 4.0,
      "Color": "sample string 5",
      "AlertTriggerType": 0,
      "AlertType": 0,
      "AlertResendWaitTime": 6,
      "MaxAlertRepeat": 7,
      "OtherAlertTriggerValue": "sample string 8",
      "AutoAcknowledge": true,
      "NotifyAcknowledge": true,
      "ActionType": 0,
      "ActionTarget": 10,
      "ActionTargetID": 11,
      "ActionValue": 12.0
    },
    {
      "ID": 1,
      "Description": "sample string 2",
      "BottomValue": 3.0,
      "TopValue": 4.0,
      "Color": "sample string 5",
      "AlertTriggerType": 0,
      "AlertType": 0,
      "AlertResendWaitTime": 6,
      "MaxAlertRepeat": 7,
      "OtherAlertTriggerValue": "sample string 8",
      "AutoAcknowledge": true,
      "NotifyAcknowledge": true,
      "ActionType": 0,
      "ActionTarget": 10,
      "ActionTargetID": 11,
      "ActionValue": 12.0
    }
  ],
  "Items": [
    {
      "ID": 1,
      "DeviceID": 2,
      "DisplayIndex": 3
    },
    {
      "ID": 1,
      "DeviceID": 2,
      "DisplayIndex": 3
    }
  ],
  "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
    }
  ]
}

application/xml, text/xml

Sample:

<APIStructs.CalculatedDevice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RimikAPI.Models">
  <Category>sample string 6</Category>
  <ConfiguredAlerts>
    <APIStructs.ConfiguredAlert>
      <AlertType>Message</AlertType>
      <CheckInControlled>true</CheckInControlled>
      <Description>sample string 4</Description>
      <Enabled>true</Enabled>
      <ID>1</ID>
      <MaxRepeats>5</MaxRepeats>
      <Name>sample string 3</Name>
      <OwnerID>7</OwnerID>
      <OwnerType>Device</OwnerType>
      <Type>None</Type>
      <WaitTime>6</WaitTime>
    </APIStructs.ConfiguredAlert>
    <APIStructs.ConfiguredAlert>
      <AlertType>Message</AlertType>
      <CheckInControlled>true</CheckInControlled>
      <Description>sample string 4</Description>
      <Enabled>true</Enabled>
      <ID>1</ID>
      <MaxRepeats>5</MaxRepeats>
      <Name>sample string 3</Name>
      <OwnerID>7</OwnerID>
      <OwnerType>Device</OwnerType>
      <Type>None</Type>
      <WaitTime>6</WaitTime>
    </APIStructs.ConfiguredAlert>
  </ConfiguredAlerts>
  <DataNodeID>4</DataNodeID>
  <Description>sample string 3</Description>
  <DisplayIndex>5</DisplayIndex>
  <ID>1</ID>
  <Items>
    <APIStructs.CalculatedDeviceItem>
      <DeviceID>2</DeviceID>
      <DisplayIndex>3</DisplayIndex>
      <ID>1</ID>
    </APIStructs.CalculatedDeviceItem>
    <APIStructs.CalculatedDeviceItem>
      <DeviceID>2</DeviceID>
      <DisplayIndex>3</DisplayIndex>
      <ID>1</ID>
    </APIStructs.CalculatedDeviceItem>
  </Items>
  <Lifespan>1</Lifespan>
  <Name>sample string 2</Name>
  <Option>sample string 7</Option>
  <Reading>
    <DelayFromStart>4</DelayFromStart>
    <LastReading>2025-11-09T21:27:48.4444798+10:00</LastReading>
    <Notes>sample string 3</Notes>
    <TimeToRun>5</TimeToRun>
    <Type>Generic</Type>
    <Units>Status</Units>
    <Value>sample string 2</Value>
  </Reading>
  <ReadingMaxValue>1</ReadingMaxValue>
  <ReadingMinValue>1</ReadingMinValue>
  <ReadingType>Generic</ReadingType>
  <ReadingUnitType>Status</ReadingUnitType>
  <ReadingValueBands>
    <APIStructs.ReadingValueBand>
      <ActionTarget>Device</ActionTarget>
      <ActionTargetID>11</ActionTargetID>
      <ActionType>None</ActionType>
      <ActionValue>12</ActionValue>
      <AlertResendWaitTime>6</AlertResendWaitTime>
      <AlertTriggerType>None</AlertTriggerType>
      <AlertType>Message</AlertType>
      <AutoAcknowledge>true</AutoAcknowledge>
      <BottomValue>3</BottomValue>
      <Color>sample string 5</Color>
      <Description>sample string 2</Description>
      <ID>1</ID>
      <MaxAlertRepeat>7</MaxAlertRepeat>
      <NotifyAcknowledge>true</NotifyAcknowledge>
      <OtherAlertTriggerValue>sample string 8</OtherAlertTriggerValue>
      <TopValue>4</TopValue>
    </APIStructs.ReadingValueBand>
    <APIStructs.ReadingValueBand>
      <ActionTarget>Device</ActionTarget>
      <ActionTargetID>11</ActionTargetID>
      <ActionType>None</ActionType>
      <ActionValue>12</ActionValue>
      <AlertResendWaitTime>6</AlertResendWaitTime>
      <AlertTriggerType>None</AlertTriggerType>
      <AlertType>Message</AlertType>
      <AutoAcknowledge>true</AutoAcknowledge>
      <BottomValue>3</BottomValue>
      <Color>sample string 5</Color>
      <Description>sample string 2</Description>
      <ID>1</ID>
      <MaxAlertRepeat>7</MaxAlertRepeat>
      <NotifyAcknowledge>true</NotifyAcknowledge>
      <OtherAlertTriggerValue>sample string 8</OtherAlertTriggerValue>
      <TopValue>4</TopValue>
    </APIStructs.ReadingValueBand>
  </ReadingValueBands>
  <Type>Sum</Type>
</APIStructs.CalculatedDevice>