Daniel Ebi created STREAMPIPES-349:
--------------------------------------
Summary: Redesign and harmonization of the Data Lake REST API
Key: STREAMPIPES-349
URL: https://issues.apache.org/jira/browse/STREAMPIPES-349
Project: StreamPipes
Issue Type: Improvement
Components: Backend, Data Lake
Reporter: Daniel Ebi
Assignee: Daniel Ebi
The objective of the REST API redesign is to increase usability by adapting the
endpoint design and simplifying the code.
The redesign is done according to the draft developed and discussed in
Confluence [1]
||functionality||request type||path||query parameters||payload||
|listing all existing measurement series (incl. event
schema)|GET|/measurements|-| |
|removing all existing measurement series|DELETE|/measurements|-| |
|getting data points of a specific measurement
series|GET|/measurements/\{measurementID}|+slicing data by timestamp criterion+
* startDate
_start date, if not specified: first element_
* endDate
_end date, if not specified: last element_
+paging+ * page:
_page number_
* itemsPerPage / limit:
_limit rows per page_
* offset:
_specify offset (time_offset)_
+grouping+ * groupBy:
_grouping tags (comma-seperated)_
* aggregationFunction:
_aggregation function (e.g. mean)_
* timeInterval:
_time interval for aggregation (e.g. 1m - one minute), if specified: performing
group by time_
+downloading
+_can be combined with slicing operators_ * format
_data format (csv, json)_| |
|removing a specific measurement series or selected measurements from that
series|DELETE|/measurements/\{measurementID}| * startDate: optional
_start date, if not specified: first element_
* endDate: optional
_end date, if not specified: last element_| |
|labeling of measurements|POST/
GET
|/measurements/\{measurementID}/labeling| * startDate:
_start date, if not specified: first element_
* endDate:
_end date, if not specified: last element_| * column:
_label column_
* label:
_class label_|
|specifying configuration parameters for a specific measurement
series|POST|/measurements/\{measurementID}/configuration|-| *
key/value-pairs:_{parameter_name: value}_|
|getting current configuration parameters for a specific measurement
series|GET|/measurements/\{measurementID}/configuration|-| |
----
[1] https://cwiki.apache.org/confluence/display/STREAMPIPES/Data+Lake+Sink
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
