PUT api/CalculatedDevices/BackCalculate/{id}?startDate={startDate}&endDate={endDate}&overwriteExisting={overwriteExisting}&includeDeviceProperties={includeDeviceProperties}&evaluateReliantDevices={evaluateReliantDevices}

Handles back-calculating readings for a specified Calculated Device (covering a date range specified by the inputs) and returns the new readings.Note: This will cache and return all new readings at the end of the call, which can have a high impact on memory usage. If back-calculating data over a large span of time, consider using BackCalculate2.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Integer ID of the Calculated Device to back-calculate for	integer	Required
startDate	Date to start from. This field is required	date	None.
endDate	Optional date to finish at. If not provided, it will use the current date	date	None.
overwriteExisting	Whether or not to overwrite existing readings with newly calculated data	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
evaluateReliantDevices	If this is enabled when handling a Timescaled device, all devices reliant on the device will also be back-calculated	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

with the results

GetCalculatedDeviceLogResponse

Name	Description	Type	Additional information
Device	The CalculatedDevice	CalculatedDevice	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": {
    "DisplayIndex": 1,
    "Type": 10,
    "TypeName": "Sum",
    "Timescale": true,
    "Option": "sample string 1",
    "CustomPeriodStart": "2025-11-09T21:30:03.0639082+10:00",
    "CustomPeriodEnd": "2025-11-09T21:30:03.0639082+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:30:03.0639082+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
      }
    ]
  },
  "DeviceLogs": [
    {
      "Type": 10,
      "ID": 1,
      "DeviceType": 10,
      "Date": "2025-11-09T21:30:03.0639082+10:00",
      "Value": "1.0",
      "NumericalValue": 1.0,
      "ReadingType": 4,
      "ReadingUnitType": 5
    },
    {
      "Type": 10,
      "ID": 1,
      "DeviceType": 10,
      "Date": "2025-11-09T21:30:03.0639082+10:00",
      "Value": "1.0",
      "NumericalValue": 1.0,
      "ReadingType": 4,
      "ReadingUnitType": 5
    }
  ],
  "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:03.0639082+10:00",
    "BuildDateUTC": "2025-11-09T21:30:03.0639082+10:00"
  },
  "VersionInformation": {
    "Major": 1,
    "Minor": 8,
    "Hotfix": 0,
    "Beta": true,
    "Version": "1.8.0.BETA"
  }
}