Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

iec-cim Work Orders API

Maintenance and construction work orders

iec-cim Work Orders API is one of 7 APIs that iec-cim publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Work Orders. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 1 operation across 1 path, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://dms-gateway.utility.example.com/cim/61968/v1.

1 operations 1 paths 3 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://ami-gateway.utility.example.com/cim/61968
Authentication
OAuth 2.0, HTTP Basic
Resource Areas
1

Authentication & Security 2

iec-cim Work Orders API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2) using the clientCredentials flow, exposing 2 scopes. It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Work Orders 1

Maintenance and construction work orders

GET
/work-orders
List work orders
listWorkOrders 3 params → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are WorkOrder (11 properties), Location (4 properties), WorkOrderList (2 properties). Each schema is shown below with its type and property counts.

WorkOrderList
object
2 properties
WorkOrder
object
CIM Work – a work order for utility field operations
11 properties
Location
object
CIM Location with coordinates
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

iec-cim-work-orders-api-openapi.yml Raw ↑

Other APIs iec-cim publishes across the network.

IEC CIM 61970 Energy Management API
IEC CIM AMI Smart Meter API
iec-cim Customers API
iec-cim Metering API
iec-cim Network Assets API
iec-cim Outages API