Better and smarter enterprise asset management with one of the world's leading Enterprise Asset Management (EAM) systems.

Welcome to the On Key REST API Reference!

The On Key API is a HTTP-based RESTful API. It has predictable resource URLs. The On Key API accepts JSON request bodies. Most GET API calls allow you to specify one or more optional query parameters on the request URI.

The On Key API returns HTTP status codes. Some API calls also return JSON response bodies that include information about the resource including one or more contextual hypermedia links. Use these links to request more information about and construct an API flow that is relative to a specific request.

Create request

To construct a REST API request, combine these components:

Element	Description
HTTP Method	GET - Request data from a resource. POST- Submits data to a resource to process. PATCH - Partially updates a resource. DELETE - Deletes a resource.
URL	https://{server}/api/tenants/{client}/{connection}: server - Server host client- Client name connection - Client connection/environment (i.e. sandbox, qa or prod)
Request Headers	Includes headers such as the Authorization header with the access token
Request Body	Required for most POST, PATCH and DELETE calls.
Query Parameters	Optional. Controls which data appears in the response. Use to limit, filter, page, sort, join and parameterize the data returned in the API response.

Example request

This sample request updates the description for a Meter:

curl -v -X PATCH https://{server}/api/tenants/{client}/{connection}/modules/aom/meters/50000120 \
-H 'Content-Type:application/vnd.onkey.entitypatch+json' \
-H 'Authorization: Bearer {accessToken}' \
-d '{
        "version" : 1
        "operations": [
            {
                "path": "description",
                "value": "fuel level gauge"
            }
        ]
    }'