GET api/controlplanrequests/zones/{zoneId}/tstypes/{tsTypeId}?fromDate={fromDate}&toDate={toDate}

Gets control plan requests for the given zone and timeseries type.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
zoneId

Zone ID

integer

Required

tsTypeId

Timeseries type ID

integer

Required

fromDate

From datetime in UTC inclusive. Default is UTC Now.

date

None.

toDate

To datetime in UTC; up to not inclusive. Default is UTC Now + 1 day - 1 tick.

date

None.

Body Parameters

None.

Response Information

Resource Description

Object with control plan request values

ControlPlanRequestTs
NameDescriptionTypeAdditional information
ZoneId

integer

None.

TsTypeId

integer

None.

UserId

string

None.

Values

Collection of ControlPlanRequestTsValue

None.

Response Formats

application/json, text/json

Sample:
{
  "ZoneId": 1,
  "TsTypeId": 2,
  "UserId": "sample string 3",
  "Values": [
    {
      "Time": "2025-05-19T19:24:06.8830961+00:00",
      "Value": 2.1
    },
    {
      "Time": "2025-05-19T19:24:06.8830961+00:00",
      "Value": 2.1
    }
  ]
}

text/html

Sample:
{"ZoneId":1,"TsTypeId":2,"UserId":"sample string 3","Values":[{"Time":"2025-05-19T19:24:06.8830961+00:00","Value":2.1},{"Time":"2025-05-19T19:24:06.8830961+00:00","Value":2.1}]}