Returns task information based on a number of parameters.
Note that by default this function returns details of currently running tasks as well as completed tasks, the "finished" parameter can be used to control this behaviour. This function is used by the workflow reports inside iCM.
Parameters
| Name | Type | Description |
|---|---|---|
| executionId | String | Only return tasks for the specified execution ID |
| finished | Boolean | If true, only return tasks that are complete, if false, only return tasks that are incomplete |
| firstResult | Number | The first result to return (results are numbered from 0); can be used in conjunction with maxResults to implement paging |
| includeProcessDescription | Boolean | Include the expanded process description (documentation field) in the response |
| includeProcessVariables | Boolean | Whether or not process variables should be included in the response |
| includeTaskDescription | Boolean | Include the expanded task description (documentation field) in the response |
| includeTaskLocalVariables | Boolean | Whether or not task local variables should be included in the response |
| maxResults | Number | The maximum number of results to return; can be used in conjunction with firstResult to implement paging. Defaults to 5000 if not set |
| orderByDeleteReason | "asc" or "desc" | Sort results by delete reason using the specified ordering |
| orderByExecutionId | "asc" or "desc" | Sort results by execution ID using the specified ordering |
| orderByHistoricActivityInstanceId | "asc" or "desc" | Sort results by activity instance ID using the specified ordering |
| orderByHistoricTaskInstanceDuration | "asc" or "desc" | Sort results by task instance duration using the specified ordering |
| orderByHistoricTaskInstanceEndTime | "asc" or "desc" | Sort results by end time using the specified ordering |
| orderByHistoricTaskInstanceStartTime | "asc" or "desc" | Sort results by start time using the specified ordering |
| orderByProcessDefinitionId | "asc" or "desc" | Sort results by process definition ID using the specified ordering |
| orderByProcessInstanceId | "asc" or "desc" | Order results by process instance ID (note that the process instance ID is represented as a string so 77 will appear after 100) |
| orderByTaskAssignee | "asc" or "desc" | Sort results by assignee using the specified ordering |
| orderByTaskDefinitionKey | "asc" or "desc" | Sort results by task definition key using the specified ordering |
| orderByTaskDescription | "asc" or "desc" | Sort results by task description using the specified ordering |
| orderByTaskDueDate | "asc" or "desc" | Sort results by task due date using the specified ordering |
| orderByTaskId | "asc" or "desc" | Sort results by task ID using the specified ordering |
| orderByTaskName | "asc" or "desc" | Sort results by task name using the specified ordering |
| orderByTaskOwner | "asc" or "desc" | Sort results by task owner using the specified ordering |
| orderByTaskPriority | "asc" or "desc" | Sort results by task priority using the specified ordering |
| processDefinitionId | String | Only return task instances for the given process definition ID |
| processDefinitionKey | String | Only return task instances for processes which have the specified process definition key |
| processDefinitionKeyIn | List<String> | Only return task instances that have a process definition key included in the supplied list |
| processDefinitionKeyLike | String | Only return task instances for processes where the process definition key iS 'SQL LIKE' the specified value |
| processDefinitionName | String | Only return task instances for processes which have the specified process definition name |
| processDefinitionNameLike | String | Only return task instances for processes where the process definition name is 'SQL LIKE' the specified value |
| processFinished | Boolean | If true, only return tasks for processes that have completed, if false only return tasks for processes that are incomplete |
| processInstanceBusinessKey | String | Only return tasks for process instances that have the specified business key |
| processInstanceBusinessKeyLike | String | Only return tasks for process instances that have a business key that is 'SQL LIKE' the specified value |
| processInstanceId | String | Only return tasks for the process instance that has the specified process instance ID |
| processVariableCondition | String | These parameters are used together, processVariableName specifies a process variable name, processVariableValue specifies a value and processVariableCondition specifies a condition; valid values for variableCondition are "equals", "equalsIgnoreCase", "greaterThan", "greaterThanOrEqual", "lessThan", "lessThanOrEqual", "like" and "notEquals" |
| processVariableName | String | |
| processVariableValue | String | |
| sortOrder | Array<Object> | Enables multi-column ordering. For example specify [{"taskPriority":"desc"},{"historicTaskInstanceStartTime":"asc"}] to sort by taskPriority then historicTaskInstanceStartTime |
| taskAssignee | String | Only return tasks that have the specified assignee |
| taskAssigneeLike | String | Only return tasks that have an assignee that is 'SQL LIKE' the specified value |
| taskCandidateGroup | String | Only return tasks that have the specified candidate group |
| taskCandidateGroupIn | Array<String> | Only return tasks that have one of the specified candidate groups |
| taskCompletedAfter | Date | Only return tasks completed after the specified date |
| taskCompletedBefore | Date | Only return tasks completed before the specified date |
| taskCompletedOn | Date | Only return tasks completed on the specified date |
| taskCreatedAfter | Date | Only return tasks created after the specified date |
| taskCreatedBefore | Date | Only return tasks created before the specified date |
| taskCreatedOn | Date | Only return tasks created on the specified date |
| taskDefinitionKey | String | Only return tasks which have the specified ID in the process definition |
| taskDefinitionKeyLike | String | Only return tasks which have an ID in the process definition that is 'SQL LIKE' the specified value |
| taskDeleteReason | String | Only return tasks which have the specified deletion reason |
| taskDescription | String | Only return tasks which have the specified description |
| taskDescriptionLike | String | Only return tasks which have a description that is 'SQL LIKE' the specified value |
| taskDueAfter | Date | Only return historic task instances that have a due date after this date |
| taskDueBefore | Date | Only return historic task instances that have a due date before this date |
| taskDueDate | Date | Only return historic task instances that have a due date equal to this date |
| taskId | String | Return the historic task instance with the given ID |
| taskInvolvedUser | String | Only return historic task instances that involved this user |
| taskMaxPriority | Number | Only return tasks with this priority or lower |
| taskMinPriority | Number | Only return tasks with this priority or higher |
| taskName | String | Only return the historic tasks with this name |
| taskNameLike | String | Only return tasks which have a description that is 'SQL LIKE' the specified value |
| taskOwner | String | Return the historic task with this owner |
| taskOwnerLike | String | Only return tasks which have an owner that is 'SQL LIKE' the specified value |
| taskParentTaskId | String | Only return historic tasks that are children of the task with the given ID |
| taskPriority | Number | Return the historic task with this priority |
| taskVariableCondition | String | These parameters are used together, taskVariableName specifies a task variable name, taskVariableValue specifies a value and taskVariableCondition specifies a condition; valid values for variableCondition are "equals", "equalsIgnoreCase", "greaterThan", "greaterThanOrEqual", "lessThan", "lessThanOrEqual", "like" and "notEquals" |
| taskVariableName | String | |
| taskVariableValue | String | |
| unfinished | Boolean | If true, only return tasks that have not finished, otherwise only return finished tasks |
| withoutTaskDueDate | Boolean | If true, only return tasks that have no task due date, otherwise only return tasks that do specify a due date |
| All parameters are optional | ||
Last modified on October 05, 2023
Share this page
