Readme
This commit is contained in:
14
Readme.md
14
Readme.md
@ -126,8 +126,8 @@ The following attributes can be specified:
|
||||
- **binSize**: Activates data binning. Specifies the number of pulses per bin for pulse-range queries or the number of milliseconds per bin for time-range queries (using number of pulses and number of milliseconds makes this binning strategy consistent between channel with different update frequencies).
|
||||
- **aggregations**: Activates data aggregation. Array of requested aggregations (see [here](https://github.psi.ch/sf_daq/ch.psi.daq.query/blob/master/src/main/java/ch/psi/daq/query/model/Aggregation.java) for possible values). These values will be added to the *data* array response.
|
||||
- **aggregationType**: Specifies the type of aggregation (see [here](https://github.psi.ch/sf_daq/ch.psi.daq.query/blob/master/src/main/java/ch/psi/daq/query/model/AggregationType.java)). The default type is *value* aggregation (e.g., sum([1,2,3])=6). Alternatively, it is possible to define *index* aggregation for multiple arrays in combination with binning (e.g., sum([1,2,3], [3,2,1]) = [4,4,4]).
|
||||
- **responseFormat**: Specifies the format the response of the requested data is in, either in JSON or CSV format, default value **JSON**, see all values [here](https://github.psi.ch/sf_daq/ch.psi.daq.query/blob/master/src/main/java/ch/psi/daq/query/model/ResponseFormat.java))
|
||||
- **compression**: Defines the compression algorithm to use, default value is **none**, see all values [here](https://github.psi.ch/sf_daq/ch.psi.daq.query/blob/master/src/main/java/ch/psi/daq/query/model/Compression.java))
|
||||
- **responseFormat**: Specifies the format the response of the requested data (see [here](https://github.psi.ch/sf_daq/ch.psi.daq.query/blob/master/src/main/java/ch/psi/daq/query/model/ResponseFormat.java) for possible values).
|
||||
- **compression**: Defines how the response should be compressed (see [here](https://github.psi.ch/sf_daq/ch.psi.daq.query/blob/master/src/main/java/ch/psi/daq/query/model/Compression.java) for possible values).
|
||||
|
||||
<a name="define_channel_names"/>
|
||||
|
||||
@ -206,7 +206,7 @@ Queries are applied to a range. The following types of ranges are supported.
|
||||
|
||||
### Response Format
|
||||
|
||||
The format of the response can be defined through the field `responseFormat` (values: **JSON**|CSV). Please note that CSV does not support `index` and `extrema` aggregations.
|
||||
The format of the response can be defined through the field `responseFormat` (values: **json**|csv). Please note that CSV does not support `index` and `extrema` aggregations.
|
||||
|
||||
|
||||
### Response Compression
|
||||
@ -648,7 +648,7 @@ curl -H "Content-Type: application/json" -X POST -d '{"aggregationType":"value"
|
||||
|
||||
```
|
||||
|
||||
Illustration of array value [aggregation](https://github.psi.ch/sf_daq/ch.psi.daq.query/blob/master/src/main/java/ch/psi/daq/query/model/Aggregation.java):
|
||||
Illustration of array value aggregation:
|
||||
|
||||

|
||||
|
||||
@ -706,7 +706,7 @@ curl -H "Content-Type: application/json" -X POST -d '{"nrOfBins":2,"aggregation
|
||||
|
||||
```
|
||||
|
||||
Illustration of array value [aggregation](https://github.psi.ch/sf_daq/ch.psi.daq.query/blob/master/src/main/java/ch/psi/daq/query/model/Aggregation.java) with additional binning:
|
||||
Illustration of array value aggregation with additional binning:
|
||||
|
||||

|
||||
|
||||
@ -765,7 +765,7 @@ curl -H "Content-Type: application/json" -X POST -d '{"binSize":10,"aggregation
|
||||
|
||||
```
|
||||
|
||||
Illustration of array value [aggregation](https://github.psi.ch/sf_daq/ch.psi.daq.query/blob/master/src/main/java/ch/psi/daq/query/model/Aggregation.java) with additional binning:
|
||||
Illustration of array value aggregation with additional binning:
|
||||
|
||||

|
||||
|
||||
@ -834,7 +834,7 @@ curl -H "Content-Type: application/json" -X POST -d '{"nrOfBins":1,"aggregation
|
||||
]
|
||||
```
|
||||
|
||||
Illustration of array index [aggregation](https://github.psi.ch/sf_daq/ch.psi.daq.query/blob/master/src/main/java/ch/psi/daq/query/model/Aggregation.java) with additional with binning (several nrOfBins are also possible):
|
||||
Illustration of array index aggregation with additional with binning (several nrOfBins are also possible):
|
||||
|
||||

|
||||
|
||||
|
Reference in New Issue
Block a user