Edit on Github

Execute Filter List (POST)

Executes the saved query of the filter by id and returns the result list. This method is slightly more powerful then the Get Execute Filter List method because it allows to extend the saved query of the filter.

Security Consideration

The request body of this method takes a JSON-serialized query. Some query types (e.g., task queries) allow to specify EL expressions in their parameters and may therefore be abused for remote code execution. See the section on security considerations for custom code in the user guide for details.

Method

POST /filter/{id}/list

Parameters

Path Parameters

Name	Description
id	The id of the filter to execute.

Query Parameters

Name	Description
firstResult	Pagination of results. Specifies the index of the first result to return.
maxResults	Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

Request Body

A JSON object which corresponds to the type of the saved query of the filter, i.e., if the resource type of the filter is Task the body should form a valid task query corresponding to the Task resource.

Result

A JSON array containing JSON objects corresponding to the matching entity interface in the engine. This depends on the saved query in the filter. Therefore it is not possible to specify a generic result format, i.e., if the resource type of the filter is Task the result will correspond to the Task interface in the engine.

Response codes

Code	Media type	Description
200	application/json	Request successful.
200	application/hal+json	Request successful. In case of an expected HAL response.
400	application/json	The extending query was invalid. See the Introduction for the error response format.
403	application/json	The authenticated user is unauthorized to read this filter. See the Introduction for the error response format.
404	application/json	Filter with given id does not exist. See the Introduction for the error response format.

Example

Request

POST /filter/aTaskFilterId/list/?firstResult=0&maxResults=2

Request Body:

Note: The examples show a task filter. So the request body corresponds to a task query. For other resource types the request body will differ.

{
  "assignee": "jonny1",
  "taskDefinitionKey": "aTaskKey"
}

Response

Status 200.

Note: The examples show the result of a task filter. So the response corresponds to a task, but for other filters the response format will differ.

[
  {
    "assignee": "jonny1",
    "caseDefinitionId": null,
    "caseExecutionId": null,
    "caseInstanceId": null,
    "created": "2014-09-15T15:45:48",
    "delegationState": null,
    "description": null,
    "due": null,
    "executionId": "aExecutionId",
    "followUp": null,
    "formKey": null,
    "id": "aTaskId",
    "name": "Task 2",
    "owner": null,
    "parentTaskId": null,
    "priority": 50,
    "processDefinitionId": "aProcessId",
    "processInstanceId": "aProcessInstanceId",
    "suspended": false,
    "taskDefinitionKey": "aTaskKey"
  }
]

Options