v1

latestOpenAPI 3.0.42026-07-233182951.4 MB

BMRS Datasets

Demand control instructions (DCI) stream

This endpoint provides demand control instruction data, filtered by publish time.

This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

get/datasets/DCI/stream

Query parameters

publishDateTimeFromstring date-time

Example:2021-04-30T00:00Z

publishDateTimeTostring date-time

Example:2021-05-30T20:00Z

Response

Data retrieved

datasetstring nullable

mRIDstring nullable

revisionNumberinteger

publishTimestring date-time nullable

publishingPeriodCommencingTimestring date-time

affectedDsostring nullable

demandControlIdstring nullable

instructionSequenceinteger

demandControlEventFlagstring

timeFromstring date-time

timeTostring date-time nullable

volumenumber double

systemManagementActionFlagstring nullable

amendmentFlagstring nullable

Example response

[
  {
    "dataset": "DCI",
    "mRID": "DCI_202104300853_00000030",
    "revisionNumber": 1,
    "publishTime": "2021-04-30T08:53:39Z",
    "publishingPeriodCommencingTime": "2021-04-30T08:53:39Z",
    "affectedDso": "SP(D)",
    "demandControlId": "00135",
    "instructionSequence": 1,
    "demandControlEventFlag": "I",
    "timeFrom": "2021-04-30T12:45:00Z",
    "timeTo": "2021-04-30T13:09:00Z",
    "volume": 68,
    "systemManagementActionFlag": "T",
    "amendmentFlag": "ORI"
  }
]