REP013 Enlight-Measurements

Enlight-Measurements API is used to retrieve the latest measurements of different measurement points in
Enlight for Enlight users. To be able to access the API a enlight user is required.
 

The data that can be retrieved:

• Hierarchy information
• Scalar values
• Inspection results
• Measurement values
• Alarm point status
• Point notes

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

The URL for accessing this API is [BASE_URL]/v1/measurements/[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.

To call the API you need to acquire an access token from Gravitee-Token API and provide it in the calls.

Endpoints

This API has two endpoints: /data and /history.

/data

[BASE_URL]/v1/measurements/data

The /data endpoint returns the most recent measurement for each measurement point in the company, if it falls inside the specified time interval. The data includes information about the hierarchical components which contain the measurement point for which the measurement was collected, as well as alarm status.

This endpoint uses two mandatory parameters: fromDate and toDate, which determine the time range in which to look for measurements.

/history

[BASE_URL]/v1/measurements/history

The /history endpoint returns more measurements, but with less information. Here you can see the measurement value and unit as well as the measurement point and asset id.

This endpoint uses two mandatory parameters: fromDate and toDate, which determine the time range in which to look for measurements, as well as an optional parameter limit, a number which controls the maximum number of measurements to be returned. No more than 500 measurements can be returned, however, even if you set the limit higher.

For more details download the open API specification.

Open API Specifications:

The Open API specification is available under 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.