REP002 Enlight-WorkNotifications

Enlight-WorkNotifications API is used by customers to retrieve information about measurement points with critical measurements, allowing them to act on these alarms in time. The customer can retrieve information about assets in a company they have access to in Enlight. To access the API you need an Enlight user.

The URL for accessing this API is [BASE_URL]/v1/work-notifications/[ENDPOINT_PATH]. The [BASE_URL] depends on the environment you are communicating with, and should be given to you as part of the onboarding process. The [ENDPOINT_PATH] depends on which particular endpoint of the API you want to call.

Endpoints

There are two endpoints in the API; /data and /media.

/data

[BASE_URL]/v1/work-notifications/data

The /data endpoint is called by the customer to retrieve notifications about measurement points that have critical measured values. The API response includes the alarm status, threshold, measurement, and timestamp values of each alarm point along with its hierarchy details like asset name, description, functional location name, and plant name. The data is filtered based on from and to dates and other query parameters supplied by the customer in the API request.

The API also enables the consumer to further filter the data returned as follows:

• Receive both alert and danger-level work notifications OR only send danger-level work notifications
• Receive all work notifications (danger and alert) OR only receive work notifications that have a more severe alarm status level than the previous measurement on the same measurement point
• Long description fields can be delimited with any character (default: space)

The data is filtered to a single company in Enlight which the Enlight user has access to.

To call the API you need to acquire an access token from Gravitee-Token API and provide two query parameters fromDate and toDate.

/media

[BASE_URL]/v1/work-notifications/media

/media is called by the customer to fetch media content associated with the worknotifications received via the /data endpoint. This is done via a separate endpoint in order to avoid large response payloads. The media content is returned from Enlight without any modification.

To call the endpoint two path parameter are used, nodeId and mediaId, both are available in the response from /data.

For more details, download the OpenAPI specification.

OpenAPI Specification (Swagger)

The OpenAPI specification can be found here.

Field descriptions:

Details of API request and response field descriptions are available in the OpenAPI specification attached to this article.

Support Instructions:

If you need support or to get started create a ticket in Zendesk and the team responsible within SKF will be contacted.