How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

OpenADR Alliance Resources API

The resources API from OpenADR Alliance — 2 operation(s) for resources.

OpenADR Alliance Resources 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 Resources. 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 17 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://virtserver.swaggerhub.com/OPENADR3_1/openADR3.1.0/1.0.0.

5 operations 2 paths 17 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Server
https://virtserver.swaggerhub.com/OPENADR3_1/openADR3.1.0/1.0.0
Authentication
OAuth 2.0, HTTP Bearer
License
Resource Areas
1

Authentication & Security 2

OpenADR Alliance Resources API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (oAuth2ClientCredentials) using the clientCredentials flow, exposing 8 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.

resources 5
GET
/resources
search ven resources
searchVenResources 5 params → 200400401403404500
POST
/resources
create resource
createResource body → 201400401403404409500
GET
/resources/{resourceID}
search ven resources by ID
searchVenResourceByID 1 param → 200400401403404500
PUT
/resources/{resourceID}
update ven resource
updateVenResource 1 param body → 200400401403404409500
DELETE
/resources/{resourceID}
delete ven resource
deleteVenResource 1 param → 200400401403404500

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are BlResourceRequest (6 properties), BlResourceRequest_2 (5 properties), problem (5 properties), objectMetadata (4 properties). Each schema is shown below with its type and property counts.

valuesMap
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
object
Server provided representation of resource
target
string
User generated target string.
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
resourceName
string
User generated identifier. A value of AGGREGATEDREPORT indicates an aggregation of more that one resource's data
point
object
A pair of floats typically used as a point on a 2 dimensional grid.
2 properties 2 required
dateTime
string
datetime in RFC 3339 format
VenResourceRequest
object
Business Logic provided representation of ven resource.
4 properties 3 required
BlResourceRequest
object
Business Logic provided representation of ven resource.
6 properties 4 required
objectID
string
URL safe VTN assigned object ID.
clientID
string
ClientID as provisioned by Auhtentication Service and associated with client's bearer token
resourceRequest
problem
object
reusable error response. From https://opensource.zalando.com/problem/schema.yaml.
5 properties
resourceName_2
string
User generated identifier. A value of AGGREGATEDREPORT indicates an aggregation of more that one resource's data
VenResourceRequest_2
object
Business Logic provided representation of ven resource.
3 properties 2 required
BlResourceRequest_2
object
Business Logic provided representation of ven resource.
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openadr-alliance-resources-api-openapi.yml Raw ↑

Other APIs OpenADR Alliance publishes across the network.

OpenADR Alliance Auth API
OpenADR Alliance Events API
OpenADR Alliance MQTT Notifier API
OpenADR Alliance Notifiers API
OpenADR Alliance Programs API
OpenADR Alliance Reports API
OpenADR Alliance Subscriptions API
OpenADR Alliance Vens API
Where this information came from

This is an independent, third-party profile of OpenADR Alliance Resources 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.