Overview

EcoStruxure™ Asset Advisor data API allows customers to collect and manage status and health of critical assets in electrical distribution networks.

This API is available as an optional module of EcoStruxure™ Asset Advisor for Electrical Distribution. For more information please contact us.

API overview and usage

This API enables the following operations:

Sites and Assets

  • Browse and discover sites and assets information.
  • Provide sites and assets specific details (e.g. risk level, health indexes).

Tickets

  • Access all tickets generated on all assets from all sites.
  • Access all tickets for a given asset of a site.
  • Provide tickets specific details.

Webhook Subscriptions

  • Get notifications on ticket changes.
  • Get notifications on asset health index changes.
  • Get notifications on site risk level changes.

How it works

This API works for any Schneider Electric customer who has an identity in the Schneider Electric cIAM system. Nevertheless, customers must subscribe to this API to use it. The current version of the API is including the operations that are described below.

Explore Sites

This set of APIs allows customers to browse all their Sites registered in Asset Advisor.

It is possible to access basic information of each site, such as ID, name, address, and location, which allows customers to do a mapping of Asset Advisor sites with their own representation and IDs, and also to locate all Sites in a map.

With the detailed view of a Site, customers are able to access information such as the Service Level subscribed for the Site, the Global Risk Level of the Site and the Health Matrix of the Site (including criticality and health index).

Explore Assets

This set of APIs allows customers to browse all Assets for a specific Site registered in Asset Advisor.

It is possible to have two different views of the Assets within a given Site. The first one is the List View, providing a standard list of assets for a given Site, including asset information such as ID, name, description, type, and criticality. The second view is a Tree View, providing the entire hierarchy of assets for a given Site, allowing customers to build a complete Site topology.

Finally, it is possible to get specific details of each Asset, including the health index, maintenance information, and many other technical details.

Access Tickets

This set of APIs allows customers to retrieve all tickets in Asset Advisor, including both alarms and recommendations. These tickets are either triggered by the Asset Advisor Analytics modules or manually created by Schneider Electric experts. This information allows customers to create their own customized dashboards with all tickets from their electrical distribution networks.

It is possible to query tickets using some filters such as:

  • Date range (ticket creation date)

  • Status (e.g. only "Opened" tickets)

  • Priority (e.g. Only "High" priority tickets)

Besides the above filters, it's also possible to limit the number of tickets in the response or retrieving specific range of tickets by setting the offset & limit filters for pagination capability. These queries return a list of "light" tickets, providing basic information such as title, description, asset, site, priority, status and creation date.

It is also possible to retrieve all tickets for a particular Asset of a Site, with similar filtering and pagination capabilities. This allows customers to create a consolidated view of tickets for a particular Asset of a Site.

Finally, it is possible to get specific details of each Ticket, including information such as priority, status, creation date, history of changes, comments and attachments. This allows customers to create a detailed view of each ticket.

Webhook Subscriptions

This set of APIs allows customers to manage event notifications through webhook subscriptions. The customer will be able to register/update/remove a subscription, list available subscriptions, and get details of a given subscription. The webhook subscriptions will provide notifications to customers based on some topics.

Currently, the topics concerning are:

Ticket

  • Notified on any ticket modification.
  • Currenlty, notification are sent when the ticket "priority" has changed or when an "activity" has been performed on the ticket (e.g. close the ticket).
  • Set "All" for both priority and activity filters during subscription to get notified for all ticket events.

Asset Health

  • Notified when the asset health changed.
  • "healthIndexThreshold" is a mandatory filter to create a subscription and get notified only when the asset health value has changed with a value equals or above this threshold.
  • "sitesScope" is an optional filter to restrict the notification to a particular list of Site IDs.

Site Risk Level

  • Notified when the site global risk level changed.
  • "riskLevelThreshold" is a mandatory filter to create a subscription and get notified only when the site risk level value has changed with a value equals or above this threshold.
  • "sitesScope" is an optional filter to restrict the notification to a particular list of Site IDs.

For all topics explained above, customers must provide a callback URL to receive the event notifications. When any event matching a webhook subscription is available, the callback URL will be notified with a call from Asset Advisor.

The callback URL must meet the following requirements for the event notification to properly arrive:

  • Must be reachable over the internet.
  • Its domain name must be resolvable by DNS service over the internet.
  • Its domain name must have a valid certificate.

For all topics, the message format sent to the callback URL is the following:

{

    "topic": "{topicName}", // enum {Ticket, AssetHealth, SiteRiskLevel}

    "id": "{topic id string}", // "guid" of the Ticket, Asset, or Site

    "siteId": "string", // "guid" of the Site

    "assetId": "string", // "guid" of the Asset

    "timestamp" : "string", // ISO 8601 format, "2023-02-08T17:09:44+00:00"        

    "events": [

        {

            "key": "{event property name}", 

            "oldValue": "{Previous value if possible}",

            "newValue": "{New Value}"

        }

      ]    

}

Documentation

How to sign up

The current version of the API does not allow subscriptions on demand.

Selected customers will be signed up manually, based on specific agreements with Schneider Electric, and will be able to access the API with the following information:

Step 1: Receive the Exchange URL access for the API product.

Step 2: Register or login with an Exchange account.

Step 3: Generate a Personal Access Token (PAT) in the developer portal (API credentials and usage details are also available).

Code Sample

You can leverage the following code samples to integrate the API faster in your application:

Support

Contact the SE Exchange support team at exchange.support@se.com and include:

- Endpoint URL

- Request/Response of the URL

- Any additional information like Screenshots, Postman collections, etc.


Visit the community to discover related discussions and questions.