Package org.neotropic.kuwaiba.northbound.rest.aem

Interface QueriesRestOpenApi

All Known Implementing Classes:

QueriesRestController

@RequestMapping("/v2.1.1/scripted-queries/")
public interface QueriesRestOpenApi

Swagger documentation for queries.

Author:

Mauricio Ruiz Beltrán <mauricio.ruiz@kuwaiba.org>

Field Summary

Fields

Modifier and Type	Field	Description
static String	PATH	Path that includes the Kuwaiba version and the module id

Method Summary

Modifier and Type	Method	Description
long	createQuery(@NotNull @Valid String name, @javax.validation.constraints.NotNull,@javax.validation.Valid long ownerId, @NotNull @Valid String structure, @NotNull @Valid String description, @NotNull @Valid String sessionId)
String	createScriptedQueriesPool(@NotNull @Valid String name, @NotNull @Valid String property, @NotNull @Valid String sessionId)
String	createScriptedQuery(@NotNull @Valid String id, @NotNull @Valid String name, @NotNull @Valid String description, @NotNull @Valid String script, @javax.validation.constraints.NotNull,@javax.validation.Valid boolean enabled, @NotNull @Valid String sessionId)
String	createScriptedQueryParameter(@NotNull @Valid String id, @NotNull @Valid String name, @NotNull @Valid String description, @NotNull @Valid String type, @javax.validation.constraints.NotNull,@javax.validation.Valid boolean mandatory, @Valid Object defaultValue, @NotNull @Valid String sessionId)
void	deleteQuery(@javax.validation.constraints.NotNull,@javax.validation.Valid long id, @NotNull @Valid String sessionId)
void	deleteScriptedQueriesPool(@NotNull @Valid String id, @NotNull @Valid String sessionId)
void	deleteScriptedQuery(@NotNull @Valid String id, @NotNull @Valid String sessionId)
void	deleteScriptedQueryParameter(@NotNull @Valid String id, @NotNull @Valid String sessionId)
List<ResultRecord>	executeQuery(@Valid ExtendedQuery query, @NotNull @Valid String sessionId)
ScriptedQueryResult	executeScriptedQuery(@NotNull @Valid String id, @Valid List<TransientScriptedQueryParameter> parameters, @NotNull @Valid String sessionId)
List<CompactQuery>	getQueries(@javax.validation.constraints.NotNull,@javax.validation.Valid boolean showPublic, @NotNull @Valid String sessionId)
CompactQuery	getQuery(@javax.validation.constraints.NotNull,@javax.validation.Valid long id, @NotNull @Valid String sessionId)
List<ScriptedQuery>	getScriptedQueries(@NotNull @Valid String filterName, @javax.validation.constraints.NotNull,@javax.validation.Valid boolean ignoreDisabled, @javax.validation.constraints.NotNull,@javax.validation.Valid int skip, @javax.validation.constraints.NotNull,@javax.validation.Valid int limit, @NotNull @Valid String sessionId)
List<ScriptedQuery>	getScriptedQueriesByPoolId(@NotNull @Valid String id, @NotNull @Valid String filterName, @javax.validation.constraints.NotNull,@javax.validation.Valid boolean ignoreDisabled, @javax.validation.constraints.NotNull,@javax.validation.Valid int skip, @javax.validation.constraints.NotNull,@javax.validation.Valid int limit, @NotNull @Valid String sessionId)
List<ScriptedQuery>	getScriptedQueriesByPoolName(@NotNull @Valid String name, @NotNull @Valid String filterName, @javax.validation.constraints.NotNull,@javax.validation.Valid boolean ignoreDisabled, @javax.validation.constraints.NotNull,@javax.validation.Valid int skip, @javax.validation.constraints.NotNull,@javax.validation.Valid int limit, @NotNull @Valid String sessionId)
ScriptedQueriesPool	getScriptedQueriesPool(@NotNull @Valid String name, @NotNull @Valid String sessionId)
ScriptedQueriesPool	getScriptedQueriesPoolByName(@NotNull @Valid String name, @NotNull @Valid String sessionId)
int	getScriptedQueriesPoolCount(@NotNull @Valid String filterName, @NotNull @Valid String sessionId)
List<ScriptedQueriesPool>	getScriptedQueriesPools(@NotNull @Valid String filterName, @javax.validation.constraints.NotNull,@javax.validation.Valid int skip, @javax.validation.constraints.NotNull,@javax.validation.Valid int limit, @NotNull @Valid String sessionId)
ScriptedQuery	getScriptedQuery(@NotNull @Valid String id, @NotNull @Valid String sessionId)
int	getScriptedQueryCount(@NotNull @Valid String filterName, @NotNull @Valid String sessionId)
int	getScriptedQueryCountByPoolId(@NotNull @Valid String id, @NotNull @Valid String filterName, @javax.validation.constraints.NotNull,@javax.validation.Valid boolean ignoreDisabled, @NotNull @Valid String sessionId)
int	getScriptedQueryCountByPoolName(@NotNull @Valid String name, @NotNull @Valid String filterName, @NotNull @Valid String sessionId)
ScriptedQueryParameter	getScriptedQueryParameter(@NotNull @Valid String id, @NotNull @Valid String sessionId)
List<ScriptedQueryParameter>	getScriptedQueryParameters(@NotNull @Valid String id, @NotNull @Valid String sessionId)
ChangeDescriptor	saveQuery(@javax.validation.constraints.NotNull,@javax.validation.Valid long id, @NotNull @Valid String name, @javax.validation.constraints.NotNull,@javax.validation.Valid long ownerId, @NotNull @Valid String structure, @NotNull @Valid String description, @NotNull @Valid String sessionId)
void	updateScriptedQueriesPool(@NotNull @Valid String id, @NotNull @Valid String name, @NotNull @Valid String property, @NotNull @Valid String sessionId)
void	updateScriptedQuery(@NotNull @Valid String id, @NotNull @Valid String name, @NotNull @Valid String description, @NotNull @Valid String script, @javax.validation.constraints.NotNull,@javax.validation.Valid boolean enabled, @NotNull @Valid String sessionId)
void	updateScriptedQueryParameter(@NotNull @Valid String id, @NotNull @Valid String name, @NotNull @Valid String description, @NotNull @Valid String type, @javax.validation.constraints.NotNull,@javax.validation.Valid boolean mandatory, @Valid Object defaultValue, @NotNull @Valid String sessionId)

Field Detail

PATH

static final String PATH

Path that includes the Kuwaiba version and the module id

See Also:

Constant Field Values

Method Detail

createScriptedQueriesPool

@RequestMapping(method=POST,
                value="createScriptedQueriesPool/{name}/{description}/{sessionId}",
                produces="application/json")
String createScriptedQueriesPool(@NotNull @Valid @PathVariable(value="name",required=true)
                                 @NotNull @Valid String name,
                                 @NotNull @Valid @PathVariable(value="description",required=true)
                                 @NotNull @Valid String property,
                                 @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                 @NotNull @Valid String sessionId)

updateScriptedQueriesPool

@RequestMapping(method=PUT,
                value="updateScriptedQueriesPool/{id}/{name}/{description}/{sessionId}",
                produces="application/json")
void updateScriptedQueriesPool(@NotNull @Valid @PathVariable(value="id",required=true)
                               @NotNull @Valid String id,
                               @NotNull @Valid @PathVariable(value="name",required=true)
                               @NotNull @Valid String name,
                               @NotNull @Valid @PathVariable(value="description",required=true)
                               @NotNull @Valid String property,
                               @NotNull @Valid @PathVariable(value="sessionId",required=true)
                               @NotNull @Valid String sessionId)

deleteScriptedQueriesPool

@RequestMapping(method=DELETE,
                value="deleteScriptedQueriesPool/{id}/{sessionId}",
                produces="application/json")
void deleteScriptedQueriesPool(@NotNull @Valid @PathVariable(value="id",required=true)
                               @NotNull @Valid String id,
                               @NotNull @Valid @PathVariable(value="sessionId",required=true)
                               @NotNull @Valid String sessionId)

getScriptedQueriesPoolByName

@RequestMapping(method=GET,
                value="getScriptedQueriesPoolByName/{name}/{sessionId}",
                produces="application/json")
ScriptedQueriesPool getScriptedQueriesPoolByName(@NotNull @Valid @PathVariable(value="name",required=true)
                                                 @NotNull @Valid String name,
                                                 @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                                 @NotNull @Valid String sessionId)

getScriptedQueriesPool

@RequestMapping(method=GET,
                value="getScriptedQueriesPool/{id}/{sessionId}",
                produces="application/json")
ScriptedQueriesPool getScriptedQueriesPool(@NotNull @Valid @PathVariable(value="name",required=true)
                                           @NotNull @Valid String name,
                                           @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                           @NotNull @Valid String sessionId)

getScriptedQueriesPoolCount

@RequestMapping(method=GET,
                value="getScriptedQueriesPoolCount/{filterName}/{sessionId}",
                produces="application/json")
int getScriptedQueriesPoolCount(@NotNull @Valid @PathVariable(value="filterName",required=true)
                                @NotNull @Valid String filterName,
                                @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                @NotNull @Valid String sessionId)

getScriptedQueriesPools

@RequestMapping(method=GET,
                value="getScriptedQueriesPools/{filterName}/{skip}/{limit}/{sessionId}",
                produces="application/json")
List<ScriptedQueriesPool> getScriptedQueriesPools(@NotNull @Valid @PathVariable(value="filterName",required=true)
                                                  @NotNull @Valid String filterName,
                                                  @NotNull @Valid @PathVariable(value="skip",required=true)
                                                  @javax.validation.constraints.NotNull,@javax.validation.Valid int skip,
                                                  @NotNull @Valid @PathVariable(value="limit",required=true)
                                                  @javax.validation.constraints.NotNull,@javax.validation.Valid int limit,
                                                  @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                                  @NotNull @Valid String sessionId)

getScriptedQueryCountByPoolId

@RequestMapping(method=GET,
                value="getScriptedQueryCountByPoolId/{id}/{filterName}/{ignoreDisabled}/{sessionId}",
                produces="application/json")
int getScriptedQueryCountByPoolId(@NotNull @Valid @PathVariable(value="id",required=true)
                                  @NotNull @Valid String id,
                                  @NotNull @Valid @PathVariable(value="filterName",required=true)
                                  @NotNull @Valid String filterName,
                                  @NotNull @Valid @PathVariable(value="ignoreDisabled",required=true)
                                  @javax.validation.constraints.NotNull,@javax.validation.Valid boolean ignoreDisabled,
                                  @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                  @NotNull @Valid String sessionId)

getScriptedQueriesByPoolId

@RequestMapping(method=GET,
                value="getScriptedQueriesByPoolId/{id}/{filterName}/{ignoreDisabled}/{skip}/{limit}/{sessionId}",
                produces="application/json")
List<ScriptedQuery> getScriptedQueriesByPoolId(@NotNull @Valid @PathVariable(value="id",required=true)
                                               @NotNull @Valid String id,
                                               @NotNull @Valid @PathVariable(value="filterName",required=true)
                                               @NotNull @Valid String filterName,
                                               @NotNull @Valid @PathVariable(value="ignoreDisabled",required=true)
                                               @javax.validation.constraints.NotNull,@javax.validation.Valid boolean ignoreDisabled,
                                               @NotNull @Valid @PathVariable(value="skip",required=true)
                                               @javax.validation.constraints.NotNull,@javax.validation.Valid int skip,
                                               @NotNull @Valid @PathVariable(value="limit",required=true)
                                               @javax.validation.constraints.NotNull,@javax.validation.Valid int limit,
                                               @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                               @NotNull @Valid String sessionId)

getScriptedQueryCountByPoolName

@RequestMapping(method=GET,
                value="getScriptedQueryCountByPoolName/{name}/{filterName}/{sessionId}",
                produces="application/json")
int getScriptedQueryCountByPoolName(@NotNull @Valid @PathVariable(value="name",required=true)
                                    @NotNull @Valid String name,
                                    @NotNull @Valid @PathVariable(value="filterName",required=true)
                                    @NotNull @Valid String filterName,
                                    @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                    @NotNull @Valid String sessionId)

getScriptedQueriesByPoolName

@RequestMapping(method=GET,
                value="getScriptedQueriesByPoolName/{name}/{filterName}/{ignoreDisabled}/{skip}/{limit}/{sessionId}",
                produces="application/json")
List<ScriptedQuery> getScriptedQueriesByPoolName(@NotNull @Valid @PathVariable(value="name",required=true)
                                                 @NotNull @Valid String name,
                                                 @NotNull @Valid @PathVariable(value="filterName",required=true)
                                                 @NotNull @Valid String filterName,
                                                 @NotNull @Valid @PathVariable(value="ignoreDisabled",required=true)
                                                 @javax.validation.constraints.NotNull,@javax.validation.Valid boolean ignoreDisabled,
                                                 @NotNull @Valid @PathVariable(value="skip",required=true)
                                                 @javax.validation.constraints.NotNull,@javax.validation.Valid int skip,
                                                 @NotNull @Valid @PathVariable(value="limit",required=true)
                                                 @javax.validation.constraints.NotNull,@javax.validation.Valid int limit,
                                                 @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                                 @NotNull @Valid String sessionId)

createScriptedQuery

@RequestMapping(method=POST,
                value="createScriptedQuery/{id}/{name}/{description}/{script}/{enabled}/{sessionId}",
                produces="application/json")
String createScriptedQuery(@NotNull @Valid @PathVariable(value="id",required=true)
                           @NotNull @Valid String id,
                           @NotNull @Valid @PathVariable(value="name",required=true)
                           @NotNull @Valid String name,
                           @NotNull @Valid @PathVariable(value="description",required=true)
                           @NotNull @Valid String description,
                           @NotNull @Valid @PathVariable(value="script",required=true)
                           @NotNull @Valid String script,
                           @NotNull @Valid @PathVariable(value="enabled",required=true)
                           @javax.validation.constraints.NotNull,@javax.validation.Valid boolean enabled,
                           @NotNull @Valid @PathVariable(value="sessionId",required=true)
                           @NotNull @Valid String sessionId)

updateScriptedQuery

@RequestMapping(method=PUT,
                value="updateScriptedQuery/{id}/{name}/{description}/{script}/{enabled}/{sessionId}",
                produces="application/json")
void updateScriptedQuery(@NotNull @Valid @PathVariable(value="id",required=true)
                         @NotNull @Valid String id,
                         @NotNull @Valid @PathVariable(value="name",required=true)
                         @NotNull @Valid String name,
                         @NotNull @Valid @PathVariable(value="description",required=true)
                         @NotNull @Valid String description,
                         @NotNull @Valid @PathVariable(value="script",required=true)
                         @NotNull @Valid String script,
                         @NotNull @Valid @PathVariable(value="enabled",required=true)
                         @javax.validation.constraints.NotNull,@javax.validation.Valid boolean enabled,
                         @NotNull @Valid @PathVariable(value="sessionId",required=true)
                         @NotNull @Valid String sessionId)

deleteScriptedQuery

@RequestMapping(method=DELETE,
                value="deleteScriptedQuery/{id}/{sessionId}",
                produces="application/json")
void deleteScriptedQuery(@NotNull @Valid @PathVariable(value="id",required=true)
                         @NotNull @Valid String id,
                         @NotNull @Valid @PathVariable(value="sessionId",required=true)
                         @NotNull @Valid String sessionId)

getScriptedQuery

@RequestMapping(method=GET,
                value="getScriptedQuery/{id}/{sessionId}",
                produces="application/json")
ScriptedQuery getScriptedQuery(@NotNull @Valid @PathVariable(value="id",required=true)
                               @NotNull @Valid String id,
                               @NotNull @Valid @PathVariable(value="sessionId",required=true)
                               @NotNull @Valid String sessionId)

getScriptedQueryCount

@RequestMapping(method=GET,
                value="getScriptedQueryCount/{filterName}/{sessionId}",
                produces="application/json")
int getScriptedQueryCount(@NotNull @Valid @PathVariable(value="filterName",required=true)
                          @NotNull @Valid String filterName,
                          @NotNull @Valid @PathVariable(value="sessionId",required=true)
                          @NotNull @Valid String sessionId)

getScriptedQueries

@RequestMapping(method=GET,
                value="getScriptedQueries/{filterName}/{ignoreDisabled}/{skip}/{limit}/{sessionId}",
                produces="application/json")
List<ScriptedQuery> getScriptedQueries(@NotNull @Valid @PathVariable(value="filterName",required=true)
                                       @NotNull @Valid String filterName,
                                       @NotNull @Valid @PathVariable(value="ignoreDisabled",required=true)
                                       @javax.validation.constraints.NotNull,@javax.validation.Valid boolean ignoreDisabled,
                                       @NotNull @Valid @PathVariable(value="skip",required=true)
                                       @javax.validation.constraints.NotNull,@javax.validation.Valid int skip,
                                       @NotNull @Valid @PathVariable(value="limit",required=true)
                                       @javax.validation.constraints.NotNull,@javax.validation.Valid int limit,
                                       @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                       @NotNull @Valid String sessionId)

executeScriptedQuery

@RequestMapping(method=PUT,
                value="executeScriptedQuery/{id}/{sessionId}",
                produces="application/json")
ScriptedQueryResult executeScriptedQuery(@NotNull @Valid @PathVariable(value="id",required=true)
                                         @NotNull @Valid String id,
                                         @Valid @RequestBody
                                         @Valid List<TransientScriptedQueryParameter> parameters,
                                         @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                         @NotNull @Valid String sessionId)

createScriptedQueryParameter

@RequestMapping(method=POST,
                value="createScriptedQueryParameter/{id}/{name}/{description}/{type}/{mandatory}/{sessionId}",
                produces="application/json")
String createScriptedQueryParameter(@NotNull @Valid @PathVariable(value="id",required=true)
                                    @NotNull @Valid String id,
                                    @NotNull @Valid @PathVariable(value="name",required=true)
                                    @NotNull @Valid String name,
                                    @NotNull @Valid @PathVariable(value="description",required=true)
                                    @NotNull @Valid String description,
                                    @NotNull @Valid @PathVariable(value="type",required=true)
                                    @NotNull @Valid String type,
                                    @NotNull @Valid @PathVariable(value="mandatory",required=true)
                                    @javax.validation.constraints.NotNull,@javax.validation.Valid boolean mandatory,
                                    @Valid @RequestBody
                                    @Valid Object defaultValue,
                                    @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                    @NotNull @Valid String sessionId)

updateScriptedQueryParameter

@RequestMapping(method=PUT,
                value="updateScriptedQueryParameter/{id}/{name}/{description}/{type}/{mandatory}/{sessionId}",
                produces="application/json")
void updateScriptedQueryParameter(@NotNull @Valid @PathVariable(value="id",required=true)
                                  @NotNull @Valid String id,
                                  @NotNull @Valid @PathVariable(value="name",required=true)
                                  @NotNull @Valid String name,
                                  @NotNull @Valid @PathVariable(value="description",required=true)
                                  @NotNull @Valid String description,
                                  @NotNull @Valid @PathVariable(value="type",required=true)
                                  @NotNull @Valid String type,
                                  @NotNull @Valid @PathVariable(value="mandatory",required=true)
                                  @javax.validation.constraints.NotNull,@javax.validation.Valid boolean mandatory,
                                  @Valid @RequestBody
                                  @Valid Object defaultValue,
                                  @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                  @NotNull @Valid String sessionId)

deleteScriptedQueryParameter

@RequestMapping(method=DELETE,
                value="deleteScriptedQueryParameter/{id}/{sessionId}",
                produces="application/json")
void deleteScriptedQueryParameter(@NotNull @Valid @PathVariable(value="id",required=true)
                                  @NotNull @Valid String id,
                                  @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                  @NotNull @Valid String sessionId)

getScriptedQueryParameter

@RequestMapping(method=GET,
                value="getScriptedQueryParameter/{id}/{sessionId}",
                produces="application/json")
ScriptedQueryParameter getScriptedQueryParameter(@NotNull @Valid @PathVariable(value="id",required=true)
                                                 @NotNull @Valid String id,
                                                 @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                                 @NotNull @Valid String sessionId)

getScriptedQueryParameters

@RequestMapping(method=GET,
                value="getScriptedQueryParameters/{id}/{sessionId}",
                produces="application/json")
List<ScriptedQueryParameter> getScriptedQueryParameters(@NotNull @Valid @PathVariable(value="id",required=true)
                                                        @NotNull @Valid String id,
                                                        @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                                        @NotNull @Valid String sessionId)

createQuery

@RequestMapping(method=POST,
                value="createQuery/{name}/{ownerId}/{structure}/{description}/{sessionId}",
                produces="application/json")
long createQuery(@NotNull @Valid @PathVariable(value="name",required=true)
                 @NotNull @Valid String name,
                 @NotNull @Valid @PathVariable(value="ownerId",required=true)
                 @javax.validation.constraints.NotNull,@javax.validation.Valid long ownerId,
                 @NotNull @Valid @PathVariable(value="structure",required=true)
                 @NotNull @Valid String structure,
                 @NotNull @Valid @PathVariable(value="description",required=true)
                 @NotNull @Valid String description,
                 @NotNull @Valid @PathVariable(value="sessionId",required=true)
                 @NotNull @Valid String sessionId)

saveQuery

@RequestMapping(method=PUT,
                value="saveQuery/{id}/{name}/{ownerId}/{structure}/{description}/{sessionId}",
                produces="application/json")
ChangeDescriptor saveQuery(@NotNull @Valid @PathVariable(value="name",required=true)
                           @javax.validation.constraints.NotNull,@javax.validation.Valid long id,
                           @NotNull @Valid @PathVariable(value="name",required=true)
                           @NotNull @Valid String name,
                           @NotNull @Valid @PathVariable(value="ownerId",required=true)
                           @javax.validation.constraints.NotNull,@javax.validation.Valid long ownerId,
                           @NotNull @Valid @PathVariable(value="structure",required=true)
                           @NotNull @Valid String structure,
                           @NotNull @Valid @PathVariable(value="description",required=true)
                           @NotNull @Valid String description,
                           @NotNull @Valid @PathVariable(value="sessionId",required=true)
                           @NotNull @Valid String sessionId)

deleteQuery

@RequestMapping(method=DELETE,
                value="deleteQuery/{id}/{sessionId}",
                produces="application/json")
void deleteQuery(@NotNull @Valid @PathVariable(value="name",required=true)
                 @javax.validation.constraints.NotNull,@javax.validation.Valid long id,
                 @NotNull @Valid @PathVariable(value="sessionId",required=true)
                 @NotNull @Valid String sessionId)

getQueries

@RequestMapping(method=GET,
                value="getQueries/{showPublic}/{sessionId}",
                produces="application/json")
List<CompactQuery> getQueries(@NotNull @Valid @PathVariable(value="showPublic",required=true)
                              @javax.validation.constraints.NotNull,@javax.validation.Valid boolean showPublic,
                              @NotNull @Valid @PathVariable(value="sessionId",required=true)
                              @NotNull @Valid String sessionId)

getQuery

@RequestMapping(method=GET,
                value="getQuery/{id}/{sessionId}",
                produces="application/json")
CompactQuery getQuery(@NotNull @Valid @PathVariable(value="id",required=true)
                      @javax.validation.constraints.NotNull,@javax.validation.Valid long id,
                      @NotNull @Valid @PathVariable(value="sessionId",required=true)
                      @NotNull @Valid String sessionId)

executeQuery

@RequestMapping(method=PUT,
                value="executeQuery/{sessionId}",
                produces="application/json")
List<ResultRecord> executeQuery(@Valid @RequestBody
                                @Valid ExtendedQuery query,
                                @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                @NotNull @Valid String sessionId)