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

Handles starting the process of back-calculating readings for a specified Calculated Device (covering a date range specified by the inputs). Calling this endpoint will have it return immediately to notify if the process has started or not.Note: It is recommended to use this if back-calculating a large quantity of data. This does not return the new readings in the response, only the number of new readings made. If back-calculating data over a small span of time or the results are desired, consider using BackCalculate.

Request Information

URI Parameters

NameDescriptionTypeAdditional 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

Body Parameters

None.

Response Information

Resource Description

with indicating if the process has started or not

GetBooleanResponse
NameDescriptionTypeAdditional information
Bool

The boolean result

boolean

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:
{
  "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:44:14.3314072+10:00",
    "BuildDateUTC": "2025-11-09T21:44:14.3314072+10:00"
  },
  "VersionInformation": {
    "Major": 1,
    "Minor": 8,
    "Hotfix": 0,
    "Beta": true,
    "Version": "1.8.0.BETA"
  },
  "Bool": true
}