Skip to content

Api v1.0

knutsenm edited this page Oct 16, 2014 · 9 revisions

The base url for all the API calls is https://api.global-registry.org/. The API generally (though not perfectly) follows the REST standards for GET, PUT, PATCH, POST and DELETE. Every request must include an access token. All responses are in JSON format.

Authorization

Access to the Global Registry is managed through an access token. This access token must be supplied with every request.

Authorization Header

Recommended

The first method for supplying the access token is through an Authorization HTTP header. The format is Authorization: Bearer xxxxxxxxx where xxxxxxxxx is replaced with your actual access token. Example:

Authorization: Bearer abcdefghijklmnopqrstuvwxyz0123456789

Query string parameter

The second method for supplying the access token is through a query parameter added to all requests. The format is access_token=xxxxxxxxx where xxxxxxxxx is replaced with your actual access token. Example:

GET /entities/12345678?access_token=abcdefghijklmnopqrstuvwxyz0123456789

Supported Endpoints

Endpoint Description
[[entity_types Entity-Types]]
entities Entities roughly correspond to rows and values in a regular database table. This endpoint exposes all the functionality needed to manipulate entities.
[[enum_values Enum-Values]]
[[relationship_types Relationship-Types]]
relationships There is no endpoint for Relationships. Rather, Relationships are expressed as attributes of Entities and are manipulated with that endpoint.
[[subscriptions Subscriptions-API]]
systems List of systems that are potentially pushing data into GR
[[measurement_types Measurement-Types]]
measurements Use this endpoint to add and delete individual measurements.

Pagination

By default results are paginated and show the first 25 entries.

Clone this wiki locally
You can’t perform that action at this time.