POST api/Devices?fillWithData={fillWithData}

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

Request Information

URI Parameters

Name	Description	Type	Additional information
fillWithData	Whether or not to fill the reading with log data	boolean	Default value is False

Body Parameters

ConnectedDevice to convert

ConnectedDevice

Name	Description	Type	Additional information
Name	Name of the Device	string	None.
SerialNumber	Serial Number of the Device	string	None.
Code	Code for the device, used for specific configurations	string	None.
ReadingType	Type for this Device's Readings	ReadingType	None.
ReadingUnitType	Unit Type for this Device's Readings	ReadingUnitType	None.
Threshold	Customisable threshold for the device	decimal number	None.
ReadingOverride	Manual override for what the reading is	string	None.
Allowance	Allowance for the Device's readings	integer	None.
Specifications	Specifications for the Device	string	None.
NodeChannel	DataNode Channel this Device is connected to	integer	None.
NodeID	ID of the DataNode this device is connected to	globally unique identifier	None.
Category	Category of the Device	string	None.
Latitude	Latitude of the device.	decimal number	None.
Longitude	Longitude of the device.	decimal number	None.
LastDataNodeDt	Last read DateTime from the DataNode	date	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.
Lifespan	Number of days to keep a device's logs stored within the database	integer	None.
ReadingValueBands	List of associated with this Device	Collection of ReadingValueBand	None.
ObjectInfo	Basic information about this object	ObjectInfo	None.
Type	Type of Device (i.e. valve, pump, relay, etc)	DeviceType	None.
SignalType	Signal type for the Device	SignalType	None.
Controllable	Flags whether or not the device can be controlled	boolean	None.
DataNode	DataNode this device is connected to	DataNode	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.
InvertedUnits	Returns whether or not this Device is using Inverted units	boolean	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

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

text/html

Sample:

Sample not available.

Response Information

Resource Description

Converted (loaded) device

Device

Name	Description	Type	Additional information
ID	This is the ID of the device	integer	None.
DataNodeID	The data node integer id	integer	None.
NodeChannel	This is the physical channel the device is expected to be connected to on the DataNode.	integer	None.
SerialNumber	The Serial Number of the Device	string	None.
Type	The type of the Device e.g. valve, pump, switches, etc.	DeviceType	None.
SignalType	The type of signal the Device utilises	SignalType	None.
Controllable	Flags whether or not the device can be controlled	boolean	None.
ReadingType	The type of reading the device performs	ReadingType	None.
ReadingUnitType	The units of the device readings;	ReadingUnitType	None.
Threshold	Customisable threshold for the device	decimal number	None.
TypeName	The name for the device type	string	None.
Name	The intuitive name of the Device	string	None.
Category	The user defined Category that can be used to group devices together	string	None.
ReadingOverride	The user defined override for the Reading Value	string	None.
Reading	The latest reading available for this device (e.g. Status:ON/OFF, Pressure: 45PSI...)	Reading	None.
Specifications	notes of the device.. i.e. notes	string	None.
Latitude	The Latitude of the Device.	decimal number	None.
Longitude	The Longitude of the Device.	decimal number	None.
ReadingMinValue	The minimum expected value for this device.	decimal number	None.
ReadingMaxValue	The maximum expected value for this device.	decimal number	None.
Lifespan	The number of days logs are kept for this device	integer	None.
Code	The device code	string	None.
Allowance	Optional allowance for the transition of the Device's reading value within schedules	integer	None.
ReadingValueBands	Array of .	Collection of ReadingValueBandStruct	None.
ConfiguredAlerts	Array of	Collection of ConfiguredAlert	None.

Response Formats

application/json, text/json, text/html

Sample:

{
  "ID": 1,
  "DataNodeID": 2,
  "NodeChannel": 3,
  "SerialNumber": "sample string 4",
  "Type": 0,
  "SignalType": 0,
  "Controllable": true,
  "ReadingType": 0,
  "ReadingUnitType": 0,
  "Threshold": 6.1,
  "TypeName": "sample string 7",
  "Name": "sample string 8",
  "Category": "sample string 9",
  "ReadingOverride": "sample string 10",
  "Reading": {
    "LastReading": "2025-11-09T21:44:12.6260534+10:00",
    "Type": 0,
    "Units": 0,
    "Value": "sample string 2",
    "Notes": "sample string 3",
    "DelayFromStart": 4,
    "TimeToRun": 5
  },
  "Specifications": "sample string 11",
  "Latitude": 12.1,
  "Longitude": 13.1,
  "ReadingMinValue": 1.0,
  "ReadingMaxValue": 1.0,
  "Lifespan": 1,
  "Code": "sample string 14",
  "Allowance": 1,
  "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
    }
  ],
  "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.Device xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RimikAPI.Models">
  <Allowance>1</Allowance>
  <Category>sample string 9</Category>
  <Code>sample string 14</Code>
  <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>
  <Controllable>true</Controllable>
  <DataNodeID>2</DataNodeID>
  <ID>1</ID>
  <Latitude>12.1</Latitude>
  <Lifespan>1</Lifespan>
  <Longitude>13.1</Longitude>
  <Name>sample string 8</Name>
  <NodeChannel>3</NodeChannel>
  <Reading>
    <DelayFromStart>4</DelayFromStart>
    <LastReading>2025-11-09T21:44:12.6260534+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>
  <ReadingOverride>sample string 10</ReadingOverride>
  <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>
  <SerialNumber>sample string 4</SerialNumber>
  <SignalType>Digital</SignalType>
  <Specifications>sample string 11</Specifications>
  <Threshold>6.1</Threshold>
  <Type>Valve</Type>
  <TypeName>sample string 7</TypeName>
</APIStructs.Device>