OpenADR Alliance Programs 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 Programs. 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.
The identity and technical contract details declared by the specification.
OpenADR Alliance Programs 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.
valuesMap
object
Represents one or more values associated with a type. E.g. a type of PRICE contains a single float value.
2 properties
2 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 properties
1 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 properties
1 required
eventPayloadDescriptor
object
Contextual information used to interpret event valuesMap values. E.g. a PRICE payload simply contains a price value, an associated descriptor provides necessar…
4 properties
1 required
point
object
A pair of floats typically used as a point on a 2 dimensional grid.
2 properties
2 required
program
object
Provides program specific metadata from VTN to VEN.
18 properties
1 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 properties
2 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 properties
1 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 properties
1 required
eventPayloadDescriptor_2
object
Contextual information used to interpret event valuesMap values. E.g. a PRICE payload simply contains a price value, an associated descriptor provides necessar…
4 properties
1 required
point_2
object
A pair of floats typically used as a point on a 2 dimensional grid.
2 properties
2 required
program_2
object
Provides program specific metadata from VTN to VEN.
18 properties
1 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 properties
2 required
target
string
User generated target string.
readingType
stringnull
Represents the type of reading. See enumerations in Definitions for defined string values, or use privately defined strings
objectTypes
string
Types of objects addressable through API.
objectMetadata
object
metadata common to all addressable objects. Values provided by VTN on object creation.
4 properties
4 required
duration_3
string
duration in ISO 8601 format
units
stringnull
Units of measure.
point_3
object
A pair of floats typically used as a point on a 2 dimensional grid.
2 properties
2 required
programRequest
object
Client provided description of program
6 properties
1 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
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 properties
2 required
program_3
object
Server provided representation of program
problem_2
object
reusable error response. From https://opensource.zalando.com/problem/schema.yaml.
5 properties
eventPayloadDescriptor_3
object
Contextual information used to interpret event valuesMap values. E.g. a PRICE payload simply contains a price value, an associated descriptor provides necessar…
4 properties
2 required
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 properties
2 required
objectMetadata_2
object
metadata common to all addressable objects. Values provided by VTN on object creation.
4 properties
4 required
duration_4
string
duration in ISO 8601 format
point_4
object
A pair of floats typically used as a point on a 2 dimensional grid.
2 properties
2 required
programRequest_2
object
Client provided description of program
6 properties
1 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 properties
2 required
program_4
object
Server provided representation of program
problem_3
object
reusable error response. From https://opensource.zalando.com/problem/schema.yaml.
5 properties
eventPayloadDescriptor_4
object
Contextual information used to interpret event valuesMap values. E.g. a PRICE payload simply contains a price value, an associated descriptor provides necessar…
4 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs OpenADR Alliance publishes across the network.
