generated: '2026-07-27'
method: derived
source: openapi/openadr-3-1-1-openapi.yaml
spec_version: 3.1.1
description: Example payloads assembled from the example values published inline in the OpenADR 3.1.1
  OpenAPI component schemas (allOf composition resolved). Every scalar value below appears verbatim in
  the specification; none were invented. Fields the spec supplies no example for are omitted rather than
  guessed.
examples:
- name: program
  schema: program
  value:
    id: object-999
    createdDateTime: '2023-06-15T09:30:00Z'
    modificationDateTime: '2023-06-15T09:30:00Z'
    objectType: EVENT
    programName: ResTOU
    intervalPeriod:
      start: '2023-06-15T09:30:00Z'
      duration: PT1H
      randomizeStart: PT1H
    programDescriptions:
    - URL: https://www.myCorporation.com/myProgramDescription
    attributes:
    - type: PRICE
      values:
      - 0.17
    targets:
    - group-1
- name: programRequest
  schema: programRequest
  value:
    programName: ResTOU
    intervalPeriod:
      start: '2023-06-15T09:30:00Z'
      duration: PT1H
      randomizeStart: PT1H
    programDescriptions:
    - URL: https://www.myCorporation.com/myProgramDescription
    attributes:
    - type: PRICE
      values:
      - 0.17
    targets:
    - group-1
- name: event
  schema: event
  value:
    id: object-999
    createdDateTime: '2023-06-15T09:30:00Z'
    modificationDateTime: '2023-06-15T09:30:00Z'
    objectType: EVENT
    programID: object-999
    eventName: price event 11-18-2022
    duration: PT1H
    priority: 0
    targets:
    - group-1
    reportDescriptors:
    - payloadType: USAGE
      readingType: DIRECT_READ
      units: KWH
      targets:
      - group-1
      aggregate: false
      startInterval: -1
      numIntervals: -1
      historical: true
      frequency: -1
      repeat: 1
      reportIntervals: INTERVALS
    payloadDescriptors:
    - objectType: EVENT_PAYLOAD_DESCRIPTOR
      payloadType: PRICE
      units: KWH
      currency: USD
    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
- name: eventRequest
  schema: eventRequest
  value:
    programID: object-999
    eventName: price event 11-18-2022
    duration: PT1H
    priority: 0
    targets:
    - group-1
    reportDescriptors:
    - payloadType: USAGE
      readingType: DIRECT_READ
      units: KWH
      targets:
      - group-1
      aggregate: false
      startInterval: -1
      numIntervals: -1
      historical: true
      frequency: -1
      repeat: 1
      reportIntervals: INTERVALS
    payloadDescriptors:
    - objectType: EVENT_PAYLOAD_DESCRIPTOR
      payloadType: PRICE
      units: KWH
      currency: USD
    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
- name: report
  schema: report
  value:
    id: object-999
    createdDateTime: '2023-06-15T09:30:00Z'
    modificationDateTime: '2023-06-15T09:30:00Z'
    objectType: EVENT
    eventID: object-999
    clientName: VEN-999
    reportName: Battery_usage_04112023
    payloadDescriptors:
    - objectType: REPORT_PAYLOAD_DESCRIPTOR
      payloadType: USAGE
      readingType: DIRECT_READ
      units: KWH
      accuracy: 0.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
    clientID: 249rj49jiej
- name: reportRequest
  schema: reportRequest
  value:
    eventID: object-999
    clientName: VEN-999
    reportName: Battery_usage_04112023
    payloadDescriptors:
    - objectType: REPORT_PAYLOAD_DESCRIPTOR
      payloadType: USAGE
      readingType: DIRECT_READ
      units: KWH
      accuracy: 0.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
- name: subscription
  schema: subscription
  value:
    id: object-999
    createdDateTime: '2023-06-15T09:30:00Z'
    modificationDateTime: '2023-06-15T09:30:00Z'
    objectType: EVENT
    clientName: VEN-999
    programID: object-999
    objectOperations:
    - objects:
      - EVENT
      operations:
      - CREATE
      callbackUrl: https://myserver.com/send/callback/here
      bearerToken: NCEJGI9E8ER9802UT9HUG
    targets:
    - group-1
    clientID: 249rj49jiej
- name: subscriptionRequest
  schema: subscriptionRequest
  value:
    clientName: VEN-999
    programID: object-999
    objectOperations:
    - objects:
      - EVENT
      operations:
      - CREATE
      callbackUrl: https://myserver.com/send/callback/here
      bearerToken: NCEJGI9E8ER9802UT9HUG
    targets:
    - group-1
- name: ven
  schema: ven
  value:
    id: object-999
    createdDateTime: '2023-06-15T09:30:00Z'
    modificationDateTime: '2023-06-15T09:30:00Z'
    objectType: BL_VEN_REQUEST
    clientID: 249rj49jiej
    targets:
    - group-1
    venName: VEN-999
    attributes:
    - type: PRICE
      values:
      - 0.17
- name: venRequest
  schema: venRequest
  value:
    objectType: VEN_VEN_REQUEST
    venName: VEN-999
    attributes:
    - type: PRICE
      values:
      - 0.17
- name: resource
  schema: resource
  value:
    id: object-999
    createdDateTime: '2023-06-15T09:30:00Z'
    modificationDateTime: '2023-06-15T09:30:00Z'
    objectType: BL_RESOURCE_REQUEST
    targets:
    - group-1
    resourceName: RESOURCE-999
    venID: object-999
    attributes:
    - type: PRICE
      values:
      - 0.17
- name: resourceRequest
  schema: resourceRequest
  value:
    objectType: BL_RESOURCE_REQUEST
    targets:
    - group-1
    resourceName: RESOURCE-999
    venID: object-999
    attributes:
    - type: PRICE
      values:
      - 0.17
- name: notification
  schema: notification
  value:
    objectType: EVENT
    operation: UPDATE
    object:
      id: object-999
      objectType: PROGRAM
      createdDateTime: '2023-06-15T09:30:00Z'
      modificationDateTime: '2023-06-15T09:30:00Z'
      programName: ResTOU
    targets:
    - group-1
- name: notifiersResponse
  schema: notifiersResponse
  value:
    WEBHOOK: true
    MQTT:
      URIS:
      - mqtts://broker.vtn.company.com
      serialization: JSON
      authentication:
        method: ANONYMOUS
- name: notifierTopicsResponse
  schema: notifierTopicsResponse
  value:
    topics:
      CREATE: '{objectType}s/create'
      UPDATE: '{objectType}s/update'
      DELETE: '{objectType}s/delete'
      ALL: '{objectType}s/+'
- name: clientCredentialRequest
  schema: clientCredentialRequest
  value:
    grant_type: client_credentials
    client_id: ven_client_99
    client_secret: ven_secret_99
    scope: read_all
- name: clientCredentialResponse
  schema: clientCredentialResponse
  value:
    access_token: MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3
    token_type: Bearer
    expires_in: 3600
    refresh_token: IwOGYzYTlmM2YxOTQ5MGE3YmNmMDFkNTVk
    scope: read_all
- name: problem
  schema: problem
  value:
    type: https://zalando.github.io/problem/constraint-violation
    status: 503
    detail: Connection to database timed out
- name: authError
  schema: authError
  value:
    error: invalid_request
    error_description: Request was missing the 'client_id' parameter.
    error_uri: https://example.com/docs/oauth-errors
- name: interval
  schema: interval
  value:
    id: 0
    intervalPeriod:
      start: '2023-06-15T09:30:00Z'
      duration: PT1H
      randomizeStart: PT1H
    payloads:
    - type: PRICE
      values:
      - 0.17
- name: intervalPeriod
  schema: intervalPeriod
  value:
    start: '2023-06-15T09:30:00Z'
    duration: PT1H
    randomizeStart: PT1H
- name: valuesMap
  schema: valuesMap
  value:
    type: PRICE
    values:
    - 0.17
- name: eventPayloadDescriptor
  schema: eventPayloadDescriptor
  value:
    objectType: EVENT_PAYLOAD_DESCRIPTOR
    payloadType: PRICE
    units: KWH
    currency: USD
- name: reportPayloadDescriptor
  schema: reportPayloadDescriptor
  value:
    objectType: REPORT_PAYLOAD_DESCRIPTOR
    payloadType: USAGE
    readingType: DIRECT_READ
    units: KWH
    accuracy: 0.0
    confidence: 100
- name: reportDescriptor
  schema: reportDescriptor
  value:
    payloadType: USAGE
    readingType: DIRECT_READ
    units: KWH
    targets:
    - group-1
    aggregate: false
    startInterval: -1
    numIntervals: -1
    historical: true
    frequency: -1
    repeat: 1
    reportIntervals: INTERVALS