This project has retired. For details please refer to its Attic page.
SavedQueryResource

SavedQueryResource

The following resources are applicable:

/queryapi/savedqueries

Mount Point: /queryapi/savedqueries

GET

Gets a list of saved queries matching the criteria (url parameters) windowed by count and start.

Parameters

name description type default
sessionid The sessionid in which user is working query
start Offset to start from the search result query 0
count Number of records to fetch from start query

Response Body

element: listResponse
media types: application/xml
application/json

org.apache.lens.api.query.save.ListResponse ListResponse object

POST

Creates a new saved query.

Parameters

name description type default
sessionid The sessionid in which user is working query

Request Body

element: savedQuery
media types: application/xml
application/json

Saved query object

Response Body

element: resourceModifiedResponse
media types: application/xml
application/json

org.apache.lens.api.query.save.ResourceModifiedResponse ResourceModifiedResponse object

/queryapi/savedqueries/{id}

Mount Point: /queryapi/savedqueries/{id}

The following operations are supported on this resource:

GET

Gets the saved query with the given id.

Parameters

name description type default
sessionid The sessionid in which user is working query
id id of the saved query path

Response Body

element: savedQuery
media types: application/xml
application/json

org.apache.lens.api.query.save.SavedQuery SavedQuery object

DELETE

Deletes the saved query with the given id.

Parameters

name description type default
sessionid The sessionid in which user is working query
id id of the saved query path

Response Body

element: resourceModifiedResponse
media types: application/xml
application/json

org.apache.lens.api.query.save.ResourceModifiedResponse ResourceModifiedResponse object

PUT

Updates the saved query {id} with the new payload.

Parameters

name description type default
sessionid The sessionid in which user is working query
id (no documentation provided) path

Request Body

element: savedQuery
media types: application/xml
application/json

Saved query object

Response Body

element: resourceModifiedResponse
media types: application/xml
application/json

org.apache.lens.api.query.save.ResourceModifiedResponse ResourceModifiedResponse object

POST

Runs the saved query with the given id and returns a query handle.

Parameters

name description type default
id id of the saved query path
sessionid The sessionid in which user is working formdata
conf Lens configuration overrides for the query formdata

Response Body

element: lensAPIResult
media types: application/xml
application/json

LensAPIResult containing the query handle

/queryapi/savedqueries/health

Mount Point: /queryapi/savedqueries/health

GET

Response Body

element: (custom)
media types: text/plain

(no documentation provided)

/queryapi/savedqueries/parameters

Mount Point: /queryapi/savedqueries/parameters

POST

Parses the query and returns parameters that are found in the query.

Parameters

name description type default
sessionid The sessionid in which user is working query
query The HQL query formdata

Response Body

element: parameterParserResponse
media types: application/xml
application/json

org.apache.lens.api.query.save.ParameterParserResponse ParameterParserResponse object