Reports

searches all reports

get

List all reports known to the server. May filter results by programID, eventID, and clientName as query param. Use skip and pagination query params to limit response size.

Required scopes

This endpoint requires the following scopes:

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

programIDstring · min: 1 · max: 128Optional

URL safe VTN assigned object ID.

Example: object-999Pattern: ^[a-zA-Z0-9_-]*$

eventIDstring · min: 1 · max: 128Optional

URL safe VTN assigned object ID.

Example: object-999Pattern: ^[a-zA-Z0-9_-]*$

clientNamestringOptional

filter results to reports with clientName.

Example: 999

skipinteger · int32Optional

number of records to skip for pagination.

limitinteger · int32 · max: 50Optional

maximum number of records to return.

x-startstring · date-timeOptional

start of timeperiod for which to return reports (extension - not part of the OpenADR specification)

x-endstring · date-timeOptional

end of timeperiod for which to return reports (extension - not part of the OpenADR specification)

Responses

200

OK.

application/json

400

Bad Request.

application/json

403

Forbidden.

application/json

500

Internal Server Error.

application/json

get

/reports

HTTPcURLJavaScriptPython

GET /api/openadr/v1/reports HTTP/1.1
Host: qa-vtn3.switchmarket.se
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "object-999",
    "createdDateTime": "2023-06-15T09:30:00Z",
    "modificationDateTime": "2023-06-15T09:30:00Z",
    "objectType": "REPORT",
    "programID": "object-999",
    "eventID": "object-999",
    "clientName": "VEN-999",
    "reportName": "Battery_usage_04112023",
    "payloadDescriptors": [
      {
        "objectType": "REPORT_PAYLOAD_DESCRIPTOR",
        "payloadType": "USAGE",
        "readingType": "DIRECT_READ",
        "units": "KWH",
        "accuracy": 0,
        "confidence": 100
      }
    ],
    "resources": [
      {
        "resourceName": "RESOURCE-999",
        "intervalPeriod": {
          "start": "2023-06-15T09:30:00Z",
          "duration": "PT1H",
          "randomizeStart": "PT1H"
        },
        "intervals": [
          {
            "id": 0,
            "intervalPeriod": {
              "start": "2023-06-15T09:30:00Z",
              "duration": "PT1H",
              "randomizeStart": "PT1H"
            },
            "payloads": [
              {
                "type": "PRICE",
                "values": [
                  0.17
                ]
              }
            ]
          }
        ]
      }
    ]
  }
]

add a report

post

Create a new report in the server.

Required scopes

This endpoint requires the following scopes:

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

report object.

idstring · min: 1 · max: 128Optional

URL safe VTN assigned object ID.

Example: object-999Pattern: ^[a-zA-Z0-9_-]*$

createdDateTimestring · date-timeOptional

datetime in ISO 8601 format

Example: 2023-06-15T09:30:00Z

modificationDateTimestring · date-timeOptional

datetime in ISO 8601 format

Example: 2023-06-15T09:30:00Z

objectTypestring · enumOptional

Used as discriminator

Possible values:

programIDstring · min: 1 · max: 128Required

URL safe VTN assigned object ID.

Example: object-999Pattern: ^[a-zA-Z0-9_-]*$

eventIDstring · min: 1 · max: 128Required

URL safe VTN assigned object ID.

Example: object-999Pattern: ^[a-zA-Z0-9_-]*$

clientNamestring · min: 1 · max: 128Required

User generated identifier; may be VEN ID provisioned out-of-band.

Example: VEN-999

reportNamestring · max: 255 · nullableOptional

User defined string for use in debugging or User Interface.

Default: nullExample: Battery_usage_04112023

Responses

201

Created.

application/json

400

Bad Request.

application/json

403

Forbidden.

application/json

409

Conflict. Implementation dependent response if identical report exists.

application/json

500

Internal Server Error.

application/json

post

/reports

HTTPcURLJavaScriptPython

POST /api/openadr/v1/reports HTTP/1.1
Host: qa-vtn3.switchmarket.se
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 696

{
  "id": "object-999",
  "createdDateTime": "2023-06-15T09:30:00Z",
  "modificationDateTime": "2023-06-15T09:30:00Z",
  "objectType": "REPORT",
  "programID": "object-999",
  "eventID": "object-999",
  "clientName": "VEN-999",
  "reportName": "Battery_usage_04112023",
  "payloadDescriptors": [
    {
      "objectType": "REPORT_PAYLOAD_DESCRIPTOR",
      "payloadType": "USAGE",
      "readingType": "DIRECT_READ",
      "units": "KWH",
      "accuracy": 0,
      "confidence": 100
    }
  ],
  "resources": [
    {
      "resourceName": "RESOURCE-999",
      "intervalPeriod": {
        "start": "2023-06-15T09:30:00Z",
        "duration": "PT1H",
        "randomizeStart": "PT1H"
      },
      "intervals": [
        {
          "id": 0,
          "intervalPeriod": {
            "start": "2023-06-15T09:30:00Z",
            "duration": "PT1H",
            "randomizeStart": "PT1H"
          },
          "payloads": [
            {
              "type": "PRICE",
              "values": [
                0.17
              ]
            }
          ]
        }
      ]
    }
  ]
}

{
  "id": "object-999",
  "createdDateTime": "2023-06-15T09:30:00Z",
  "modificationDateTime": "2023-06-15T09:30:00Z",
  "objectType": "REPORT",
  "programID": "object-999",
  "eventID": "object-999",
  "clientName": "VEN-999",
  "reportName": "Battery_usage_04112023",
  "payloadDescriptors": [
    {
      "objectType": "REPORT_PAYLOAD_DESCRIPTOR",
      "payloadType": "USAGE",
      "readingType": "DIRECT_READ",
      "units": "KWH",
      "accuracy": 0,
      "confidence": 100
    }
  ],
  "resources": [
    {
      "resourceName": "RESOURCE-999",
      "intervalPeriod": {
        "start": "2023-06-15T09:30:00Z",
        "duration": "PT1H",
        "randomizeStart": "PT1H"
      },
      "intervals": [
        {
          "id": 0,
          "intervalPeriod": {
            "start": "2023-06-15T09:30:00Z",
            "duration": "PT1H",
            "randomizeStart": "PT1H"
          },
          "payloads": [
            {
              "type": "PRICE",
              "values": [
                0.17
              ]
            }
          ]
        }
      ]
    }
  ]
}

searches reports by reportID

get

Fetch the report specified by the reportID in path.

Required scopes

This endpoint requires the following scopes:

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

reportIDstring · min: 1 · max: 128Required

URL safe VTN assigned object ID.

Example: object-999Pattern: ^[a-zA-Z0-9_-]*$

Responses

200

OK.

application/json

400

Bad Request.

application/json

403

Forbidden.

application/json

404

Not Found.

application/json

500

Internal Server Error.

application/json

get

/reports/{reportID}

HTTPcURLJavaScriptPython

GET /api/openadr/v1/reports/{reportID} HTTP/1.1
Host: qa-vtn3.switchmarket.se
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "object-999",
  "createdDateTime": "2023-06-15T09:30:00Z",
  "modificationDateTime": "2023-06-15T09:30:00Z",
  "objectType": "REPORT",
  "programID": "object-999",
  "eventID": "object-999",
  "clientName": "VEN-999",
  "reportName": "Battery_usage_04112023",
  "payloadDescriptors": [
    {
      "objectType": "REPORT_PAYLOAD_DESCRIPTOR",
      "payloadType": "USAGE",
      "readingType": "DIRECT_READ",
      "units": "KWH",
      "accuracy": 0,
      "confidence": 100
    }
  ],
  "resources": [
    {
      "resourceName": "RESOURCE-999",
      "intervalPeriod": {
        "start": "2023-06-15T09:30:00Z",
        "duration": "PT1H",
        "randomizeStart": "PT1H"
      },
      "intervals": [
        {
          "id": 0,
          "intervalPeriod": {
            "start": "2023-06-15T09:30:00Z",
            "duration": "PT1H",
            "randomizeStart": "PT1H"
          },
          "payloads": [
            {
              "type": "PRICE",
              "values": [
                0.17
              ]
            }
          ]
        }
      ]
    }
  ]
}

update a report

put

Update the report specified by the reportID in path.

Required scopes

This endpoint requires the following scopes:

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

reportIDstring · min: 1 · max: 128Required

URL safe VTN assigned object ID.

Example: object-999Pattern: ^[a-zA-Z0-9_-]*$

Body

application/json

report object.

idstring · min: 1 · max: 128Optional

URL safe VTN assigned object ID.

Example: object-999Pattern: ^[a-zA-Z0-9_-]*$

createdDateTimestring · date-timeOptional

datetime in ISO 8601 format

Example: 2023-06-15T09:30:00Z

modificationDateTimestring · date-timeOptional

datetime in ISO 8601 format

Example: 2023-06-15T09:30:00Z

objectTypestring · enumOptional

Used as discriminator

Possible values:

programIDstring · min: 1 · max: 128Required

URL safe VTN assigned object ID.

Example: object-999Pattern: ^[a-zA-Z0-9_-]*$

eventIDstring · min: 1 · max: 128Required

URL safe VTN assigned object ID.

Example: object-999Pattern: ^[a-zA-Z0-9_-]*$

clientNamestring · min: 1 · max: 128Required

User generated identifier; may be VEN ID provisioned out-of-band.

Example: VEN-999

reportNamestring · max: 255 · nullableOptional

User defined string for use in debugging or User Interface.

Default: nullExample: Battery_usage_04112023

Responses

200

OK.

application/json

400

Bad Request.

application/json

403

Forbidden.

application/json

404

Not Found.

application/json

409

Conflict. Implementation dependent response if program with the same programName exists.

application/json

500

Internal Server Error.

application/json

put

/reports/{reportID}

HTTPcURLJavaScriptPython

PUT /api/openadr/v1/reports/{reportID} HTTP/1.1
Host: qa-vtn3.switchmarket.se
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 696

{
  "id": "object-999",
  "createdDateTime": "2023-06-15T09:30:00Z",
  "modificationDateTime": "2023-06-15T09:30:00Z",
  "objectType": "REPORT",
  "programID": "object-999",
  "eventID": "object-999",
  "clientName": "VEN-999",
  "reportName": "Battery_usage_04112023",
  "payloadDescriptors": [
    {
      "objectType": "REPORT_PAYLOAD_DESCRIPTOR",
      "payloadType": "USAGE",
      "readingType": "DIRECT_READ",
      "units": "KWH",
      "accuracy": 0,
      "confidence": 100
    }
  ],
  "resources": [
    {
      "resourceName": "RESOURCE-999",
      "intervalPeriod": {
        "start": "2023-06-15T09:30:00Z",
        "duration": "PT1H",
        "randomizeStart": "PT1H"
      },
      "intervals": [
        {
          "id": 0,
          "intervalPeriod": {
            "start": "2023-06-15T09:30:00Z",
            "duration": "PT1H",
            "randomizeStart": "PT1H"
          },
          "payloads": [
            {
              "type": "PRICE",
              "values": [
                0.17
              ]
            }
          ]
        }
      ]
    }
  ]
}

{
  "id": "object-999",
  "createdDateTime": "2023-06-15T09:30:00Z",
  "modificationDateTime": "2023-06-15T09:30:00Z",
  "objectType": "REPORT",
  "programID": "object-999",
  "eventID": "object-999",
  "clientName": "VEN-999",
  "reportName": "Battery_usage_04112023",
  "payloadDescriptors": [
    {
      "objectType": "REPORT_PAYLOAD_DESCRIPTOR",
      "payloadType": "USAGE",
      "readingType": "DIRECT_READ",
      "units": "KWH",
      "accuracy": 0,
      "confidence": 100
    }
  ],
  "resources": [
    {
      "resourceName": "RESOURCE-999",
      "intervalPeriod": {
        "start": "2023-06-15T09:30:00Z",
        "duration": "PT1H",
        "randomizeStart": "PT1H"
      },
      "intervals": [
        {
          "id": 0,
          "intervalPeriod": {
            "start": "2023-06-15T09:30:00Z",
            "duration": "PT1H",
            "randomizeStart": "PT1H"
          },
          "payloads": [
            {
              "type": "PRICE",
              "values": [
                0.17
              ]
            }
          ]
        }
      ]
    }
  ]
}

delete a report

delete

Delete the report specified by the reportID in path.

Required scopes

This endpoint requires the following scopes:

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

reportIDstring · min: 1 · max: 128Required

URL safe VTN assigned object ID.

Example: object-999Pattern: ^[a-zA-Z0-9_-]*$

Responses

200

OK.

application/json

400

Bad Request.

application/json

403

Forbidden.

application/json

404

Not Found.

application/json

500

Internal Server Error.

application/json

delete

/reports/{reportID}

HTTPcURLJavaScriptPython

DELETE /api/openadr/v1/reports/{reportID} HTTP/1.1
Host: qa-vtn3.switchmarket.se
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "object-999",
  "createdDateTime": "2023-06-15T09:30:00Z",
  "modificationDateTime": "2023-06-15T09:30:00Z",
  "objectType": "REPORT",
  "programID": "object-999",
  "eventID": "object-999",
  "clientName": "VEN-999",
  "reportName": "Battery_usage_04112023",
  "payloadDescriptors": [
    {
      "objectType": "REPORT_PAYLOAD_DESCRIPTOR",
      "payloadType": "USAGE",
      "readingType": "DIRECT_READ",
      "units": "KWH",
      "accuracy": 0,
      "confidence": 100
    }
  ],
  "resources": [
    {
      "resourceName": "RESOURCE-999",
      "intervalPeriod": {
        "start": "2023-06-15T09:30:00Z",
        "duration": "PT1H",
        "randomizeStart": "PT1H"
      },
      "intervals": [
        {
          "id": 0,
          "intervalPeriod": {
            "start": "2023-06-15T09:30:00Z",
            "duration": "PT1H",
            "randomizeStart": "PT1H"
          },
          "payloads": [
            {
              "type": "PRICE",
              "values": [
                0.17
              ]
            }
          ]
        }
      ]
    }
  ]
}