openapi: 3.1.0
info:
  title: IEC CIM 61968 Distribution Management Customers Network Assets 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: Network Assets
  description: Distribution network equipment – transformers, switches, lines, conductors
paths:
  /assets:
    get:
      operationId: listAssets
      summary: List network assets
      description: Returns distribution network assets including transformers, switches, sectionalizers, and overhead/underground lines. Supports filtering by asset type, substation, and location.
      tags:
      - Network Assets
      parameters:
      - name: assetType
        in: query
        schema:
          type: string
          enum:
          - PowerTransformer
          - Switch
          - Breaker
          - Recloser
          - Capacitor
          - Conductor
          - ACLineSegment
      - name: substationId
        in: query
        schema:
          type: string
      - name: limit
        in: query
        schema:
          type: integer
          default: 100
          maximum: 1000
      - name: offset
        in: query
        schema:
          type: integer
          default: 0
      responses:
        '200':
          description: Asset list returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssetList'
  /assets/{mRID}:
    get:
      operationId: getAsset
      summary: Get asset by mRID
      description: Returns a specific network asset identified by its CIM Master Resource Identifier (mRID).
      tags:
      - Network Assets
      parameters:
      - name: mRID
        in: path
        required: true
        schema:
          type: string
          format: uuid
        description: CIM Master Resource Identifier (UUID)
      responses:
        '200':
          description: Asset returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Asset'
        '404':
          description: Asset not found
components:
  schemas:
    Asset:
      type: object
      description: CIM IdentifiedObject representing a distribution network asset
      properties:
        mRID:
          type: string
          format: uuid
          description: Master Resource Identifier (CIM UUID)
        name:
          type: string
          description: Asset name
        aliasName:
          type: string
        description:
          type: string
        assetType:
          type: string
          description: CIM asset type class name
        location:
          $ref: '#/components/schemas/Location'
        inService:
          type: boolean
        installationDate:
          type: string
          format: date
        ratedVoltage:
          type: number
          description: Rated voltage in volts
        manufacturer:
          type: string
        model:
          type: string
        serialNumber:
          type: string
    AssetList:
      type: object
      properties:
        assets:
          type: array
          items:
            $ref: '#/components/schemas/Asset'
        total:
          type: integer
        offset:
          type: integer
        limit:
          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
  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/