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 Network Assets API

Distribution network equipment – transformers, switches, lines, conductors

iec-cim Network Assets 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 Network Assets. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 2 operations across 2 paths, 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.

2 operations 2 paths 3 schemas 2 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 Network Assets 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 2

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

Network Assets 2

Distribution network equipment – transformers, switches, lines, conductors

GET
/assets
List network assets
listAssets 4 params → 200
GET
/assets/{mRID}
Get asset by mRID
getAsset 1 param → 200404

Schemas 3

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

Asset
object
CIM IdentifiedObject representing a distribution network asset
12 properties
AssetList
object
4 properties
Location
object
CIM Location with coordinates
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

iec-cim-network-assets-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 Outages API
iec-cim Work Orders API