POST api/CalculatedDevices/{id}/Reading

Posts a new Reading for the input CalculatedDevice ID

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The CalculatedDevice Integer ID

integer

Required

Body Parameters

The Payload for the CalculatedDevice Log

ReadingPayload
NameDescriptionTypeAdditional information
Reading

string

None.

ReadingDate

date

None.

Request Formats

application/json, text/json, text/html

Sample:
{
  "Reading": "sample string 1",
  "ReadingDate": "2025-11-09T21:30:20.8414955+10:00"
}

application/xml, text/xml

Sample:
<APIStructs.ReadingPayload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RimikAPI.Models">
  <Reading>sample string 1</Reading>
  <ReadingDate>2025-11-09T21:30:20.8414955+10:00</ReadingDate>
</APIStructs.ReadingPayload>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CalculatedDevice and Log information

GetCalculatedDeviceLogResponse
NameDescriptionTypeAdditional information
Device

The CalculatedDevice

CalculatedDeviceStruct

None.

DeviceLogs

Array of device log entries

Collection of CalculatedDevice_Log_Entry

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:
{
  "Device": {
    "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:30:20.8414955+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
      }
    ]
  },
  "DeviceLogs": [
    {
      "ID": 1,
      "Date": "2025-11-09T21:30:20.8414955+10:00",
      "Value": "sample string 3",
      "Type": 10,
      "ReadingUnitType": 0
    },
    {
      "ID": 1,
      "Date": "2025-11-09T21:30:20.8414955+10:00",
      "Value": "sample string 3",
      "Type": 10,
      "ReadingUnitType": 0
    }
  ],
  "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:30:20.8414955+10:00",
    "BuildDateUTC": "2025-11-09T21:30:20.8414955+10:00"
  },
  "VersionInformation": {
    "Major": 1,
    "Minor": 3,
    "Hotfix": 7,
    "Beta": false,
    "Version": "1.3.7"
  }
}

application/xml, text/xml

Sample:
<GetCalculatedDeviceLogResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RimikAPI.Models.Responses">
  <Messages xmlns:d2p1="http://schemas.datacontract.org/2004/07/RimikAPI.Services">
    <d2p1:Common.Message>
      <d2p1:CodeDesc>2</d2p1:CodeDesc>
      <d2p1:MessageCode>1</d2p1:MessageCode>
      <d2p1:MessageText>sample string 3</d2p1:MessageText>
      <d2p1:RecordNumber>4</d2p1:RecordNumber>
      <d2p1:Severity>Information</d2p1:Severity>
    </d2p1:Common.Message>
    <d2p1:Common.Message>
      <d2p1:CodeDesc>2</d2p1:CodeDesc>
      <d2p1:MessageCode>1</d2p1:MessageCode>
      <d2p1:MessageText>sample string 3</d2p1:MessageText>
      <d2p1:RecordNumber>4</d2p1:RecordNumber>
      <d2p1:Severity>Information</d2p1:Severity>
    </d2p1:Common.Message>
  </Messages>
  <ServerInformation xmlns:d2p1="http://schemas.datacontract.org/2004/07/RimikAPI.Services.Metadata">
    <d2p1:BuildDateUTC>2025-11-09T21:30:20.8414955+10:00</d2p1:BuildDateUTC>
    <d2p1:CurrentTimeUTC>2025-11-09T21:30:20.8414955+10:00</d2p1:CurrentTimeUTC>
  </ServerInformation>
  <VersionInformation xmlns:d2p1="http://schemas.datacontract.org/2004/07/RimikAPI.Services.Metadata" />
  <Device xmlns:d2p1="http://schemas.datacontract.org/2004/07/RimikAPI.Models">
    <d2p1:Category>sample string 6</d2p1:Category>
    <d2p1:ConfiguredAlerts>
      <d2p1:APIStructs.ConfiguredAlert>
        <d2p1:AlertType>Message</d2p1:AlertType>
        <d2p1:CheckInControlled>true</d2p1:CheckInControlled>
        <d2p1:Description>sample string 4</d2p1:Description>
        <d2p1:Enabled>true</d2p1:Enabled>
        <d2p1:ID>1</d2p1:ID>
        <d2p1:MaxRepeats>5</d2p1:MaxRepeats>
        <d2p1:Name>sample string 3</d2p1:Name>
        <d2p1:OwnerID>7</d2p1:OwnerID>
        <d2p1:OwnerType>Device</d2p1:OwnerType>
        <d2p1:Type>None</d2p1:Type>
        <d2p1:WaitTime>6</d2p1:WaitTime>
      </d2p1:APIStructs.ConfiguredAlert>
      <d2p1:APIStructs.ConfiguredAlert>
        <d2p1:AlertType>Message</d2p1:AlertType>
        <d2p1:CheckInControlled>true</d2p1:CheckInControlled>
        <d2p1:Description>sample string 4</d2p1:Description>
        <d2p1:Enabled>true</d2p1:Enabled>
        <d2p1:ID>1</d2p1:ID>
        <d2p1:MaxRepeats>5</d2p1:MaxRepeats>
        <d2p1:Name>sample string 3</d2p1:Name>
        <d2p1:OwnerID>7</d2p1:OwnerID>
        <d2p1:OwnerType>Device</d2p1:OwnerType>
        <d2p1:Type>None</d2p1:Type>
        <d2p1:WaitTime>6</d2p1:WaitTime>
      </d2p1:APIStructs.ConfiguredAlert>
    </d2p1:ConfiguredAlerts>
    <d2p1:DataNodeID>4</d2p1:DataNodeID>
    <d2p1:Description>sample string 3</d2p1:Description>
    <d2p1:DisplayIndex>5</d2p1:DisplayIndex>
    <d2p1:ID>1</d2p1:ID>
    <d2p1:Items>
      <d2p1:APIStructs.CalculatedDeviceItem>
        <d2p1:DeviceID>2</d2p1:DeviceID>
        <d2p1:DisplayIndex>3</d2p1:DisplayIndex>
        <d2p1:ID>1</d2p1:ID>
      </d2p1:APIStructs.CalculatedDeviceItem>
      <d2p1:APIStructs.CalculatedDeviceItem>
        <d2p1:DeviceID>2</d2p1:DeviceID>
        <d2p1:DisplayIndex>3</d2p1:DisplayIndex>
        <d2p1:ID>1</d2p1:ID>
      </d2p1:APIStructs.CalculatedDeviceItem>
    </d2p1:Items>
    <d2p1:Lifespan>1</d2p1:Lifespan>
    <d2p1:Name>sample string 2</d2p1:Name>
    <d2p1:Option>sample string 7</d2p1:Option>
    <d2p1:Reading>
      <d2p1:DelayFromStart>4</d2p1:DelayFromStart>
      <d2p1:LastReading>2025-11-09T21:30:20.8414955+10:00</d2p1:LastReading>
      <d2p1:Notes>sample string 3</d2p1:Notes>
      <d2p1:TimeToRun>5</d2p1:TimeToRun>
      <d2p1:Type>Generic</d2p1:Type>
      <d2p1:Units>Status</d2p1:Units>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:Reading>
    <d2p1:ReadingMaxValue>1</d2p1:ReadingMaxValue>
    <d2p1:ReadingMinValue>1</d2p1:ReadingMinValue>
    <d2p1:ReadingType>Generic</d2p1:ReadingType>
    <d2p1:ReadingUnitType>Status</d2p1:ReadingUnitType>
    <d2p1:ReadingValueBands>
      <d2p1:APIStructs.ReadingValueBand>
        <d2p1:ActionTarget>Device</d2p1:ActionTarget>
        <d2p1:ActionTargetID>11</d2p1:ActionTargetID>
        <d2p1:ActionType>None</d2p1:ActionType>
        <d2p1:ActionValue>12</d2p1:ActionValue>
        <d2p1:AlertResendWaitTime>6</d2p1:AlertResendWaitTime>
        <d2p1:AlertTriggerType>None</d2p1:AlertTriggerType>
        <d2p1:AlertType>Message</d2p1:AlertType>
        <d2p1:AutoAcknowledge>true</d2p1:AutoAcknowledge>
        <d2p1:BottomValue>3</d2p1:BottomValue>
        <d2p1:Color>sample string 5</d2p1:Color>
        <d2p1:Description>sample string 2</d2p1:Description>
        <d2p1:ID>1</d2p1:ID>
        <d2p1:MaxAlertRepeat>7</d2p1:MaxAlertRepeat>
        <d2p1:NotifyAcknowledge>true</d2p1:NotifyAcknowledge>
        <d2p1:OtherAlertTriggerValue>sample string 8</d2p1:OtherAlertTriggerValue>
        <d2p1:TopValue>4</d2p1:TopValue>
      </d2p1:APIStructs.ReadingValueBand>
      <d2p1:APIStructs.ReadingValueBand>
        <d2p1:ActionTarget>Device</d2p1:ActionTarget>
        <d2p1:ActionTargetID>11</d2p1:ActionTargetID>
        <d2p1:ActionType>None</d2p1:ActionType>
        <d2p1:ActionValue>12</d2p1:ActionValue>
        <d2p1:AlertResendWaitTime>6</d2p1:AlertResendWaitTime>
        <d2p1:AlertTriggerType>None</d2p1:AlertTriggerType>
        <d2p1:AlertType>Message</d2p1:AlertType>
        <d2p1:AutoAcknowledge>true</d2p1:AutoAcknowledge>
        <d2p1:BottomValue>3</d2p1:BottomValue>
        <d2p1:Color>sample string 5</d2p1:Color>
        <d2p1:Description>sample string 2</d2p1:Description>
        <d2p1:ID>1</d2p1:ID>
        <d2p1:MaxAlertRepeat>7</d2p1:MaxAlertRepeat>
        <d2p1:NotifyAcknowledge>true</d2p1:NotifyAcknowledge>
        <d2p1:OtherAlertTriggerValue>sample string 8</d2p1:OtherAlertTriggerValue>
        <d2p1:TopValue>4</d2p1:TopValue>
      </d2p1:APIStructs.ReadingValueBand>
    </d2p1:ReadingValueBands>
    <d2p1:Type>Sum</d2p1:Type>
  </Device>
  <DeviceLogs xmlns:d2p1="http://schemas.datacontract.org/2004/07/RimikAPI.Models">
    <d2p1:APIStructs.CalculatedDevice_Log_Entry>
      <d2p1:Date>2025-11-09T21:30:20.8414955+10:00</d2p1:Date>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:ReadingUnitType>Status</d2p1:ReadingUnitType>
      <d2p1:Type>Sum</d2p1:Type>
      <d2p1:Value>sample string 3</d2p1:Value>
    </d2p1:APIStructs.CalculatedDevice_Log_Entry>
    <d2p1:APIStructs.CalculatedDevice_Log_Entry>
      <d2p1:Date>2025-11-09T21:30:20.8414955+10:00</d2p1:Date>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:ReadingUnitType>Status</d2p1:ReadingUnitType>
      <d2p1:Type>Sum</d2p1:Type>
      <d2p1:Value>sample string 3</d2p1:Value>
    </d2p1:APIStructs.CalculatedDevice_Log_Entry>
  </DeviceLogs>
</GetCalculatedDeviceLogResponse>