AEMO CDR Common

openapi: 3.0.1
info:
  title: CDR Common
  version: '3.0'
  x-origin:
  - format: openapi
    source: AEMO API Management developer portal
    url: https://dev.aemo.com.au/developer/apis/cdr-common/operations?api-version=2022-04-01-preview
servers:
- url: https://api-prd.aemo.local/NEMRetail/cds-au/v1/discovery
paths:
  /outages:
    get:
      operationId: getOutages
      summary: Get Outages
      tags:
      - CDR Common
      description: Obtain a list of scheduled outages for the implementation
      parameters:
      - name: x-v
        in: header
        required: true
        schema:
          type: string
        description: Version of the API end point requested by the client. Must be set to a positive integer.
          The data holder should respond with the highest supported version between [x-min-v](#request-headers)
          and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher
          than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should
          be treated as absent. If all versions requested are not supported then the data holder must
          respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
      - name: x-min-v
        in: header
        required: false
        schema:
          type: string
        description: Minimum version of the API end point requested by the client. Must be set to a positive
          integer if provided. The data holder should respond with the highest supported version between
          [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported
          then the data holder must respond with a 406 Not Acceptable.
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                data:
                  outages:
                  - duration: duration
                    outageTime: outageTime
                    isPartial: true
                    explanation: explanation
                  - duration: duration
                    outageTime: outageTime
                    isPartial: true
                    explanation: explanation
                meta: '{}'
                links:
                  self: self
        '400':
          description: The following error codes MUST be supported:<br/><ul class="error-code-list"><li>[400
            - Invalid Field](#error-400-field-invalid)</li><li>[400 - Missing Field](#error-400-field-missing)</li><li>[400
            - Invalid Version](#error-400-header-invalid-version)</li></ul>
          content:
            application/json:
              example:
                errors:
                - code: string
                  title: string
                  detail: string
                  meta:
                    urn: string
        '406':
          description: The following error codes MUST be supported:<br/><ul class="error-code-list"><li>[406
            - Unsupported Version](#error-406-header-unsupported-version)</li></ul>
          content:
            application/json:
              example:
                errors:
                - code: string
                  title: string
                  detail: string
                  meta:
                    urn: string
  /status:
    get:
      operationId: getStatus
      summary: Get Status
      tags:
      - CDR Common
      description: Obtain a health check status for the implementation
      parameters:
      - name: x-v
        in: header
        required: true
        schema:
          type: string
        description: Version of the API end point requested by the client. Must be set to a positive integer.
          The data holder should respond with the highest supported version between [x-min-v](#request-headers)
          and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher
          than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should
          be treated as absent. If all versions requested are not supported then the data holder must
          respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
      - name: x-min-v
        in: header
        required: false
        schema:
          type: string
        description: Minimum version of the API end point requested by the client. Must be set to a positive
          integer if provided. The data holder should respond with the highest supported version between
          [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported
          then the data holder must respond with a 406 Not Acceptable.
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                data:
                  updateTime: updateTime
                  explanation: explanation
                  expectedResolutionTime: expectedResolutionTime
                  detectionTime: detectionTime
                  status: OK
                meta: '{}'
                links:
                  self: self
        '400':
          description: The following error codes MUST be supported:<br/><ul class="error-code-list"><li>[400
            - Invalid Field](#error-400-field-invalid)</li><li>[400 - Missing Field](#error-400-field-missing)</li><li>[400
            - Invalid Version](#error-400-header-invalid-version)</li></ul>
          content:
            application/json:
              example:
                errors:
                - code: string
                  title: string
                  detail: string
                  meta:
                    urn: string
        '406':
          description: The following error codes MUST be supported:<br/><ul class="error-code-list"><li>[406
            - Unsupported Version](#error-406-header-unsupported-version)</li></ul>
          content:
            application/json:
              example:
                errors:
                - code: string
                  title: string
                  detail: string
                  meta:
                    urn: string
components:
  securitySchemes:
    apiKeyHeader:
      type: apiKey
      name: Ocp-Apim-Subscription-Key
      in: header
    apiKeyQuery:
      type: apiKey
      name: subscription-key
      in: query
security:
- {}
- apiKeyHeader: []
- apiKeyQuery: []
tags:
- name: CDR Common
  description: CDR Common