Relesys API Docs

v1.1

https://api.relesysapp.net/api/v1.1

Concept

Scopes

It is possible to authenticate with several scopes by providing a list of space-separated scopes.


If a request is performed, but insufficient scopes are allowed on the OAuth token, a 403 response is returned with a list of the accepted scopes for the requested endpoint.


Area Scope Access Description
Global relesys.api Read & Write This will give unlimited access to the full extent of the API.
relesys.api:read Read This will give read access to the full extent of the API.
relesys.api:write Write This will give write access to the full extent of the API.
User Management relesys.api.users Read & Write This will give unlimited access to all Users, Departments, and User Groups resources.
relesys.api.users:read Read This will give read access to all Users, Departments, and User Groups resources.
relesys.api.users:write Write This will give write access to all Users, Departments, and User Groups resources.
KPI Management relesys.api.kpis Read & Write This will give unlimited access to all Data Sets and Data Points resources.
relesys.api.kpis:read Read This will give read access to all Data Sets and Data Points resources.
relesys.api.kpis:write Write This will give write access to all Data Sets and Data Points resources.
Training relesys.api.training Read & Write This will give unlimited access to all Training resources.
relesys.api.training:read Read This will give read access to all Training resources.
relesys.api.training:write Write This will give write access to all Training resources.