Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

TODO:

  •  validate(): use validation method (org.apache.commons.validator.routines.InetAddressValidator) instead of regex check


REST API

DataLakeNoUserResourceV3

org.apache.streampipes.rest.impl.datalake

This class contains the basic interface definition for setting up a new measurement series in Data Lake including the related paths and calls the underlying methods of org.apache.streampipes.dataexplorer.DataLakeNoUserManagementV3. Usage of the related API calls does not require any authentification with valid username and password.

method namerequest typepathdescription
addDataLake

POST

/{measure}adds new measurement series with specified measure name and related event properties (column names) in InfluxDB

DataLakeResourceV3

org.apache.streampipes.ps

This class contains the extended interface definition including the related paths and calls the underlying methods of org.apache.streampipes.dataexplorer.DataLakeManagementV3 and org.apache.streampipes.dataexplorer.utils.DataExplorerUtils when invoked. Usage of below mentioned API calls requires authentification with valid username and password.

method namerequest typepathdescription

getPage

GET

/data/{index}/paging

returns pages with predefined number of events per page of a specific measurement series from InfluxDB

getAllInfos

GET

/info

returns list with ids of all existing measurement series from InfluxDB

getAllData

GET

/data/{index}

/data/{index}/last/{value}/{unit}

/data/{index}/{startdate}/{enddate}

returns all stored events of a specific mesurement series from InfluxDB

returns an aggregated set of all stored events of a specific mesurement series from InfluxDB

returns all stored events within the specified time frame of a specific mesurement series from InfluxDB

getAllDataGroupingGET/data/{index}/{startdate}/{enddate}/grouping/{groupingTag}returns all events within a specified time frame of a specific mesurement series grouped by a specific tag from InfluxDB

removeAllData

DELETE

/data/delete/all

removes all stored events from InfluxDB
downloadDataGET

/data/{index}/download

/data/{index}/{startdate}/{enddate}/download


downloads all events of a specific mesurement series from InfluxDB in desired format

downloads all events within a specified time frame of a specific mesurement series from InfluxDB in desired format

getImage

GET

/data/image/{route}/file

returns png image from file route

saveImageCoco

POST

/data/image/{route}/coco

stores image as file at file route

getImageCoco

GET

/data/image/{route}/coco

returns image at file route as application/json
labelDataPOST

/data/{index}/{startdate}/{enddate}/labeling/{column}/{timestampColumn}?label=

updates label in specified column for all events within specified time frame to provided label value

...