OpenADR Alliance Subscriptions 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 Subscription. 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 87 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.
reportDescriptor
object
An object that may be used to request a report from a VEN. See OpenADR REST User Guide for detailed description of how configure a report request.
9 properties
1 required
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
resource
object
A resource is an energy device or system subject to control by a VEN.
8 properties
1 required
report
object
report object.
10 properties
4 required
objectTypes
string
Types of objects addressable through API.
duration
stringnull
duration in ISO 8601 format
point
object
A pair of floats typically used as a point on a 2 dimensional grid.
2 properties
2 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 properties
2 required
dateTime
stringnull
datetime in ISO 8601 format
notification
object
VTN generated object included in request to subscription callbackUrl.
4 properties
3 required
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
event
object
Event object to communicate a Demand Response request to VEN. If intervalPeriod is present, sets start time and duration of intervals.
12 properties
2 required
objectID
string
URL safe VTN assigned object ID.
subscription
object
An object created by a client to receive notification of operations on objects. Clients may subscribe to be notified when a type of object is created, updated,…
8 properties
3 required
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
program
object
Provides program specific metadata from VTN to VEN.
18 properties
1 required
ven
object
Ven represents a client with the ven role.
8 properties
1 required
problem
object
reusable error response. From https://opensource.zalando.com/problem/schema.yaml.
5 properties
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
reportDescriptor_2
object
An object that may be used to request a report from a VEN.
10 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
resource_2
object
A resource is an energy device or system subject to control by a VEN.
8 properties
1 required
report_2
object
report object.
10 properties
4 required
duration_2
string
duration in ISO 8601 format
point_2
object
A pair of floats typically used as a point on a 2 dimensional grid.
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
event_2
object
Event object to communicate a Demand Response request to VEN. If intervalPeriod is present, sets default start time and duration of intervals.
12 properties
2 required
subscription_2
object
An object created by a client to receive notification of operations on objects. Clients may subscribe to be notified when a type of object is created, updated,…
8 properties
3 required
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
program_2
object
Provides program specific metadata from VTN to VEN.
18 properties
1 required
ven_2
object
Ven represents a client with the ven role.
8 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
reportDescriptor_3
object
An object that may be used to request a report from a VEN.
11 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
resource_3
object
Server provided representation of resource
eventRequest
object
Event object to communicate a Demand Response request to VEN. If intervalPeriod is present, sets default start time and duration of intervals.
9 properties
1 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
report_3
object
Server provided representation of report
objectMetadata
object
metadata common to all addressable objects. Values provided by VTN on object creation.
4 properties
4 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.
BlVenRequest
object
Business Logic provided representation of ven.
5 properties
3 required
reportRequest
object
report object.
5 properties
3 required
programRequest
object
Client provided description of program
6 properties
1 required
point_3
object
A pair of floats typically used as a point on a 2 dimensional grid.
2 properties
2 required
subscriptionRequest
object
An object created by a client to receive notification of operations on objects. Clients may subscribe to be notified when a type of object is created, updated,…
4 properties
2 required
dateTime_3
string
datetime in RFC 3339 format
notification_2
object
VTN generated object included in request to subscription callbackUrl.
4 properties
3 required
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.
BlResourceRequest
object
Business Logic provided representation of ven resource.
6 properties
4 required
event_3
object
Server provided representation of event
subscription_3
object
Server provided representation of subscription
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
clientID
string
ClientID as provisioned by Auhtentication Service and associated with client's bearer token
program_3
object
Server provided representation of program
venName
string
User generated identifier, may be VEN identifier provisioned out-of-band. venName is expected to be unique within the scope of a VTN
ven_3
object
Server provided representation of ven
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
reportDescriptor_4
object
An object that may be used to request a report from a VEN.
11 properties
1 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
resource_4
object
Server provided representation of resource
eventRequest_2
object
Event object to communicate a Demand Response request to VEN. If intervalPeriod is present, sets default start time and duration of intervals.
9 properties
1 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 properties
4 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
BlVenRequest_2
object
Business Logic provided representation of ven.
5 properties
3 required
reportRequest_2
object
report object.
5 properties
3 required
programRequest_2
object
Client provided description of program
6 properties
1 required
point_4
object
A pair of floats typically used as a point on a 2 dimensional grid.
2 properties
2 required
subscriptionRequest_2
object
An object created by a client to receive notification of operations on objects. Clients may subscribe to be notified when a type of object is created, updated,…
4 properties
2 required
dateTime_4
string
datetime in RFC 3339 format
notification_3
object
VTN generated object included in request to subscription callbackUrl.
4 properties
3 required
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
BlResourceRequest_2
object
Business Logic provided representation of ven resource.
5 properties
3 required
event_4
object
Server provided representation of event
subscription_4
object
Server provided representation of subscription
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
ven_4
object
Server provided representation of ven
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.
