Introduce limit and inclusive queries.

This commit is contained in:
Fabian Märki
2017-11-07 14:45:37 +01:00
parent 714c9b2e3d
commit 7b71a2a394
5 changed files with 728 additions and 7 deletions

View File

@ -326,6 +326,7 @@ A request is performed by sending a valid JSON object in the HTTP request body.
- **channels**: Array of channels to be queried (see [here](Readme.md#query_channel_names) and [here](Readme.md#define_channel_names)).
- **range**: The range of the query (see [here](Readme.md#query_range)).
- **limit**: An optional limit for the number of elements to retrieve. Limit together with aggregation does not make sense and thus is not supported.
- **ordering**: The ordering of the data (see [here](Readme.md#data_ordering)).
- **fields**: Array of requested fields (see [here](Readme.md#requested_fields)).
- **aggregation**: Setting this attribute activates data aggregation (see [here](Readme.md#data_aggregation) for its specification).
@ -374,12 +375,16 @@ Queries are applied to a range. The following types of ranges are supported.
```json
"range":{
"startPulseId":0,
"endPulseId":100
"startInclusive":true,
"endPulseId":100,
"endInclusive":true
}
```
- **startPulseId**: The start pulse-id of the range request.
- **startInclusive**: Defines if the start should be considered inclusive (values: **true**|false).
- **endPulseId**: The end pulse-id of the range request.
- **endInclusive**: Defines if the end should be considered inclusive (values: **true**|false).
#### By Date
@ -387,12 +392,16 @@ Queries are applied to a range. The following types of ranges are supported.
```json
"range":{
"startDate":"2015-08-06T18:00:00.000",
"endDate":"2015-08-06T18:59:59.999"
"startInclusive":true,
"endDate":"2015-08-06T18:59:59.999",
"endInclusive":true
}
```
- **startDate**: The start date of the time range in the ISO8601 format (such as 1997-07-16T19:20:30.123+02:00 or 1997-07-16T19:20:30.123456789+02:00 (omitting +02:00 falls back to the server's time zone)).
- **startInclusive**: Defines if the start should be considered inclusive (values: **true**|false).
- **endDate**: The end date of the time range.
- **endInclusive**: Defines if the end should be considered inclusive (values: **true**|false).
#### By Time
@ -400,12 +409,16 @@ Queries are applied to a range. The following types of ranges are supported.
```json
"range":{
"startSeconds":"0.0",
"endSeconds":"1.000999999"
"startInclusive":true,
"endSeconds":"1.000999999",
"endInclusive":true
}
```
- **startSeconds**: The start time of the range in seconds since midnight, January 1, 1970 UTC (the UNIX epoch) as a decimal value including fractional seconds.
- **startInclusive**: Defines if the start should be considered inclusive (values: **true**|false).
- **endSeconds**: The end time of the range in seconds.
- **endInclusive**: Defines if the end should be considered inclusive (values: **true**|false).
<a name="data_ordering"/>