REP003 Enlight-Hierarchy

The Enlight-Hierarchy API is used to retrieve hierarchy information for a company that the consumer has access to in Enlight Centre. Below is a list of types of hierarchical Enlight components that are retrievable from the API:

• Company
• Sites
• Plants
• Systems
• Functional Locations
• Assets
• Bearings
• Measurement Locations
• Inspection Points
• Lubrication Points
• Ships

The consumer can only obtain data from their home company in Enlight, with this API.

To call the API you need to acquire an access token from Gravitee-Token API.

The URL for accessing this API is [BASE_URL]/enlight/hierarchy/[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. The available endpoints are listed here below.

Endpoints

All endpoints have the same set of input query parameters and support only the GET operation. The API will return a list of the components that have been created or updated in the time range you specify by using the fromDate and toDate parameters.

GET /company

[BASE_URL]/enlight/hierarchy/company

This endpoint is used to get information about the company of the authenticated user.

GET /sites

[BASE_URL]/enlight/hierarchy/sites

This endpoint is used to get information about sites in the company of the authenticated user.

GET /plants

[BASE_URL]/enlight/hierarchy/plants

This endpoint is used to get information about plants in the company of the authenticated user.

GET /systems

[BASE_URL]/enlight/hierarchy/systems

This endpoint is used to get information about systems in the company of the authenticated user.

GET /functionalLocations

[BASE_URL]/enlight/hierarchy/functionalLocations

This endpoint is used to get information about functional locations in the company of the authenticated user.

GET /assets

[BASE_URL]/enlight/hierarchy/assets

This endpoint is used to get information about assets in the company of the authenticated user.

GET /assets/{assetId}/components

[BASE_URL]/enlight/hierarchy/assets

This endpoint is used to get information about components (bearings and shafts) for a particular asset in the company of the authenticated user.

GET /assets/{assetId}/bearings

[BASE_URL]/enlight/hierarchy/assets

This endpoint is used to get information about bearings for a particular asset in the company of the authenticated user.

GET /assets/{assetId}/shafts

[BASE_URL]/enlight/hierarchy/assets

This endpoint is used to get information about shafts for a particular asset in the company of the authenticated user.

GET /bearings

[BASE_URL]/enlight/hierarchy/bearings

This endpoint is used to get information about bearings in the company of the authenticated user.

GET /measurementLocations

[BASE_URL]/enlight/hierarchy/measurementLocations

This endpoint is used to get information about measurement locations in the company of the authenticated user.

GET /inspectionPoints

[BASE_URL]/enlight/hierarchy/inspectionPoints

This endpoint is used to get information about inspection points in the company of the authenticated user.

GET /lubricationPoints

[BASE_URL]/enlight/hierarchy/lubricationPoints

This endpoint is used to get information about lubrication points in the company of the authenticated user.

GET /ships

[BASE_URL]/enlight/hierarchy/ships

This endpoint is used to get information about ships in the company of the authenticated user.

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.