Supported Data Flows

All data flows are implemented as REST web services.

Outgoing Flows

Publish Outage Information

Outage information is published as a POST request to the URL specified by the configuration parameter config.publish.url. Request payload is the published outage information according to the CIM IEC 61968-3 standard. Payload can be represented either as XML or JSON according to the configuration parameter config.publish.format.

Note: When publishing data to the ODIN website the XML format must be used.

Supported Authentication Methods

When publishing outage information the adapter can use the following authentication methods.

Basic HTTP Authentication

With this authentication method the credentials needed to access the web service where outage information is being published are passed directly in the Authorization HTTP header of the outgoing message. This method is used when the configuration parameter config.auth.url is not specified.

Note: With this authentication method only HTTPS transport should be used to publish outage data to avoid security credentials from being compromised.

OAuth Authentication

The adapter can use the OAuth 2.0 client credentials flow to obtain a token from the OAuth server using configured credentials and (optionally) scope, and then use the obtained token when publishing outage information. This method is used when the configuration parameter ‘config.auth.url’ is specified.

Note: When publishing data to the ODIN website the OAuth authentication method must be used.