Execute Filter Single Result

Executes the saved query of the filter by id and returns the single result.

Method

GET /filter/{id}/singleResult

Parameters

Path Parameters

Name	Description
id	The id of the filter to execute.

Result

A JSON object 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.
204		Request successful, but the result was empty.
400	application/json	The executed filter returned more than one single result. 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

GET /filter/aTaskFilterId/singleResult

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