OpenADR Alliance Reports API is one of 9 APIs that OpenADR Alliance publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
This API exposes 1 JSON Schema definition.
Tagged areas include Reports. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and 1 JSON Schema.
This API exposes
5 operations
across 2 paths,
and defines 44 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against 3 base URLs: http://localhost:8081/openadr3, http://localhost:8081/openadr3/3.0.1, https://virtserver.swaggerhub.com/OPENADR3_1/openADR3.1.0/1.0.0.
5 operations2 paths44 schemas1 DELETE2 GET1 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
OpenADR Alliance Reports API declares
2 security schemes
for authenticating requests.
It supports OAuth 2.0 (oAuth2ClientCredentials) using the clientCredentials flow, exposing 6 scopes.
It accepts HTTP bearer tokens (JWT) (bearerAuth).
oAuth2ClientCredentials — Client credential flow.
Paths & Operations 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
reports 5
GET
/reports
searches all reports
searchAllReports4 params→ 200400403500
POST
/reports
add a report
createReportbody→ 201400403409500
GET
/reports/{reportID}
searches reports by reportID
searchReportsByReportID1 param→ 200400403500
PUT
/reports/{reportID}
update a report
updateReport1 parambody→ 200400403409500
DELETE
/reports/{reportID}
delete a report
deleteReport1 param→ 200400403500
Schemas 44
The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are report (10 properties), report_2 (10 properties), reportPayloadDescriptor_2 (6 properties), reportPayloadDescriptor (6 properties). Each schema is shown below with its type and property counts.
valuesMap
object
Represents one or more values associated with a type. E.g. a type of PRICE contains a single float value.
2 properties2 required
dateTime
stringnull
datetime in ISO 8601 format
intervalPeriod
object
Defines temporal aspects of intervals. A duration of default null indicates infinity. A randomizeStart of default null indicates no randomization.
3 properties1 required
problem
object
reusable error response. From https://opensource.zalando.com/problem/schema.yaml.
5 properties
duration
stringnull
duration in ISO 8601 format
objectID
string
URL safe VTN assigned object ID.
reportPayloadDescriptor
object
Contextual information used to interpret report payload values. E.g. a USAGE payload simply contains a usage value, an associated descriptor provides necessary…
6 properties1 required
report
object
report object.
10 properties4 required
point
object
A pair of floats typically used as a point on a 2 dimensional grid.
2 properties2 required
interval
object
An object defining a temporal window and a list of valuesMaps. if intervalPeriod present may set temporal aspects of interval or override event.intervalPeriod.
3 properties2 required
valuesMap_2
object
Represents one or more values associated with a type. E.g. a type of PRICE contains a single float value.
2 properties2 required
dateTime_2
string
datetime in ISO 8601 format
intervalPeriod_2
object
Defines temporal aspects of intervals. A duration of default PT0S indicates instantaneous or infinity, depending on payloadType. A randomizeStart of default nu…
3 properties1 required
duration_2
string
duration in ISO 8601 format
reportPayloadDescriptor_2
object
Contextual information used to interpret report payload values. E.g. a USAGE payload simply contains a usage value, an associated descriptor provides necessary…
6 properties1 required
report_2
object
report object.
10 properties4 required
point_2
object
A pair of floats typically used as a point on a 2 dimensional grid.
2 properties2 required
valuesMap_3
object
Represents one or more values associated with a type. See enumerations in Definitions for defined string values, or use privately defined strings
2 properties2 required
readingType
stringnull
Represents the type of reading. See enumerations in Definitions for defined string values, or use privately defined strings
report_3
object
Server provided representation of report
objectTypes
string
Types of objects addressable through API.
objectMetadata
object
metadata common to all addressable objects. Values provided by VTN on object creation.
4 properties4 required
resourceName
string
User generated identifier. A value of AGGREGATEDREPORT indicates an aggregation of more that one resource's data
duration_3
string
duration in ISO 8601 format
units
stringnull
Units of measure.
reportRequest
object
report object.
5 properties3 required
point_3
object
A pair of floats typically used as a point on a 2 dimensional grid.
2 properties2 required
dateTime_3
string
datetime in RFC 3339 format
intervalPeriod_3
object
Defines temporal aspects of intervals. A start of "0001-01-01" or "0001-01-01T00:00:00" may indicate 'now'. See User Guide. A duration of "P9999Y" may indicate…
3 properties
clientName
string
User generated identifier, may be VEN identifier provisioned out-of-band.
reportPayloadDescriptor_3
object
Contextual information used to interpret report payload values. E.g. a USAGE payload simply contains a usage value, an associated descriptor provides necessary…
6 properties2 required
clientID
string
ClientID as provisioned by Auhtentication Service and associated with client's bearer token
problem_2
object
reusable error response. From https://opensource.zalando.com/problem/schema.yaml.
5 properties
valuesMap_4
object
Represents one or more values associated with a type. See enumerations in Definitions for defined string values, or use privately defined strings
2 properties2 required
report_4
object
Server provided representation of report
objectMetadata_2
object
metadata common to all addressable objects. Values provided by VTN on object creation.
4 properties4 required
resourceName_2
string
User generated identifier. A value of AGGREGATEDREPORT indicates an aggregation of more that one resource's data
duration_4
string
duration in ISO 8601 format
reportRequest_2
object
report object.
5 properties3 required
point_4
object
A pair of floats typically used as a point on a 2 dimensional grid.
2 properties2 required
dateTime_4
string
datetime in RFC 3339 format
intervalPeriod_4
object
Defines temporal aspects of intervals. A start of "0001-01-01" or "0001-01-01T00:00:00" may indicate 'now'. See User Guide. A duration of "P9999Y" may indicate…
3 properties
reportPayloadDescriptor_4
object
Contextual information used to interpret report payload values. E.g. a USAGE payload simply contains a usage value, an associated descriptor provides necessary…
6 properties2 required
problem_3
object
reusable error response. From https://opensource.zalando.com/problem/schema.yaml.
5 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of OpenADR Alliance Reports API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
