REST API
This Time Series Database is designed with the Web in mind and it use the REST architectural style. It is implemented targeting the highest level (3) of the Richardson Maturity Model
Bellow you will find a comprehensive list of all the kind of resources exposed as part of the Time Series Database API, the supported operations over those resources and the relations established between them.
Note for developers:
Do not hardcode path to resources exposed by the Time Series
Database API. This could render your client useless if a
resource is relocated for any reason. Use the relations
described below to drive your client interactions with the
Time Series Database.
Root Resource
The Root Resource is the only publicly known entry point into the Time Series Database API. It offers information about the implementation of the Time Series Database (such as version, capacity, etc.) and provide links to other Time Series Database resources that are part of its API.
Links on the Root Resource are identified by the following possible relations:
- https://zephyrec.github.io/tsdb/rest-api/#has-ts-collection: Is used to mark the link on the Root Resource leading to the Time Series Collection.
Time Series Collection
The Time Series collection provide access to the set of Time Series stored on the Time Series Database. It support pagination trough the standard link relations prev and next.
Pagination is controlled trough the start
and items
query
parameters. The prev link will only be available on the
collection representation if the start
query parameter is a valid
number. The next link will only be available if the items
query parameter is a valid number.
Has TS Collection
https://zephyrec.github.io/tsdb/rest-api/#has-ts-collection is a link relation used on the Time Series Database to indicate that the current resource has a associated Time Series Collection. This relation is valid for the following elements:
- The Root Resource