iec-cim Outages API

openapi: 3.1.0
info:
  title: IEC CIM 61968 Distribution Management Customers Outages API
  description: REST API for distribution utility systems based on IEC 61968 Common Information Model (CIM) standards. Provides access to network assets, outage management, customer information, meter reading, and work management data using CIM-compliant resource representations. Implements IEC 61968 Parts 3, 4, 9, and 11 interfaces for distribution management systems (DMS) integration.
  version: 1.0.0
  contact:
    name: CIM User Group
    url: https://cimug.ucaiug.org/
  license:
    name: IEC License
    url: https://www.iec.ch/
servers:
- url: https://dms-gateway.utility.example.com/cim/61968/v1
  description: Distribution Management System CIM API gateway
security:
- OAuth2: []
- BasicAuth: []
tags:
- name: Outages
  description: Outage events and management
paths:
  /outages:
    get:
      operationId: listOutages
      summary: List outage events
      description: Returns current and historical outage events including cause, affected customers, and restoration status.
      tags:
      - Outages
      parameters:
      - name: status
        in: query
        schema:
          type: string
          enum:
          - Active
          - Restored
          - Cancelled
      - name: startTime
        in: query
        schema:
          type: string
          format: date-time
      - name: endTime
        in: query
        schema:
          type: string
          format: date-time
      - name: limit
        in: query
        schema:
          type: integer
          default: 50
      responses:
        '200':
          description: Outage list returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutageList'
  /outages/{mRID}:
    get:
      operationId: getOutage
      summary: Get outage details
      description: Returns detailed information about a specific outage event including affected assets, customers, and restoration actions.
      tags:
      - Outages
      parameters:
      - name: mRID
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Outage returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Outage'
        '404':
          description: Outage not found
components:
  schemas:
    OutageList:
      type: object
      properties:
        outages:
          type: array
          items:
            $ref: '#/components/schemas/Outage'
        total:
          type: integer
    Location:
      type: object
      description: CIM Location with coordinates
      properties:
        mRID:
          type: string
          format: uuid
        name:
          type: string
        addressGeneral:
          type: string
        positionPoints:
          type: array
          items:
            type: object
            properties:
              sequenceNumber:
                type: integer
              xPosition:
                type: string
                description: Longitude
              yPosition:
                type: string
                description: Latitude
    Outage:
      type: object
      description: CIM Outage event
      properties:
        mRID:
          type: string
          format: uuid
        name:
          type: string
        status:
          type: string
          enum:
          - Active
          - Restored
          - Cancelled
        startTime:
          type: string
          format: date-time
        endTime:
          type: string
          format: date-time
        cause:
          type: string
        affectedCustomers:
          type: integer
        location:
          $ref: '#/components/schemas/Location'
        affectedAssets:
          type: array
          items:
            $ref: '#/components/schemas/AssetRef'
    AssetRef:
      type: object
      properties:
        mRID:
          type: string
          format: uuid
        name:
          type: string
        assetType:
          type: string
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://auth.utility.example.com/oauth/token
          scopes:
            cim.read: Read CIM data
            cim.write: Write CIM data
    BasicAuth:
      type: http
      scheme: basic
externalDocs:
  description: IEC CIM User Group
  url: https://cimug.ucaiug.org/