Querying data with OpenAPI

Using OpenAPI

You can use the OpenAPI specification to query data from hyperfluid over simple http requests.

You can see every available endpoint and test them in the bifrost’s swagger view of the data dock.

Limiting data

You can limit the data you get by using the __limit query parameter.

https://your-datadock-endpoint/catalog/schema/table?__limit=10

(This will show rows 1 to 10)

You can also use the __offset query parameter to skip a number of rows.

https://your-datadock-endpoint/catalog/schema/table?__limit=10&__offset=10

(This will show rows 11 to 20)

Filtering data

You can filter data directly using query params. For that, you just need the column name, the operator and the value you want to filter.

The operator can be one of the following:

And you need to format it as column.operator=value.

https://your-datadock-endpoint/catalog/schema/table?name.eq=John

You can filter more than one column at a time by using the & separator.

https://your-datadock-endpoint/catalog/schema/table?name.eq=John&age.gt=18

Security

In order to query data from the data dock, you need to be authenticated. For that, you need to pass the Authorization header with the value Bearer <your-token> in the request headers. You can see how to obtain your access token here.