Retrieve a Task List
get
/ic/api/process/v1/tasks
Retrieves a task list for the current user.
Request
Query Parameters
-
assignment: string
Task assignees - MY, GROUP, MY_AND_GROUP (default), MY_AND_GROUP_ALL, REPORTEES, OWNER, REVIEWER, PREVIOUS, ALL, ADMIN MY - Tasks assigned exclusively to the context user. This is same as 'My Tasks/Me' in workspace. GROUP - Tasks assigned non-exclusively to the context user. Displays tasks that are assigned to a group of which you are a member. MY_AND_GROUP - All tasks assigned to the context user, exclusively or non exclusively. This is same as 'My Tasks/Me and My Group' in workspace. Displays tasks that are assigned to anyone, including you, in the groups you belongs to.This will not fetch tasks that are acquired by some other user in the groups you belong to. MY_AND_GROUP_ALL - All tasks assigned to the context user, exclusively or to all his group based tasks. This is same as 'My Tasks/Me and My Group All' in workspace. Displays tasks that are assigned to anyone, including you, in the groups you belongs to. This will even fetch tasks that are acquired by some other user in the groups you belong to. REPORTEES - Displays tasks that are assigned to reportees of you OWNER - Displays tasks in which you are task owner. This is same as 'Administered by Me' filter in workspace. REVIEWER -Displays tasks for which you are a reviewer. This is same as 'Reviewed by Me' filter in workspace. PREVIOUS - Displays tasks that were previously updated by you. This is same as 'Worked on by Me' filter in workspace. CREATOR - Tasks for which the context user is the creator. This is same as 'Started by Me' filter in workspace. ALL - All tasks (admins only) ADMIN - No filtering (admins only); Displays all tasks regardless of assignment or creator. DEFAULT - based on who the current user is filter is derived and can be either of ADMIN, OWNER or MY_AND_GROUP_ALLDefault Value:
MY_AND_GROUP
-
dueDateFrom: string
Start of due date range in ISO-8601 format YYYY-MM-DDTHH:MM:SS[.sss]Z
-
dueDateTo: string
End of due date range in ISO-8601 format YYYY-MM-DDTHH:MM:SS[.sss]Z
-
fields: array[string]
Collection Format:
multi
Displays only the selected task attributes -
fromuser: array[string]
Collection Format:
multi
Previous task assignee in process -
identificationKey: string
identificationKey in Task
-
includeOnTrackFlag: boolean
include ON Track tasks.This flag is used in conjunction with dueDateFrom query parameter.If includeOnTrackFlag is true then set dueDateFrom to 2 days after today.Default Value:
false
-
instanceId: array[string]
Collection Format:
multi
Displays tasks for the given process-instance-id values -
keyword: string
Keyword in task title
-
limit: integer(int32)
Maximum number of items per page, default 25Default Value:
25
-
metadataFlag: boolean
metadataFlag - true or false. if metadataFlag is true, then task details URL is populated.Default Value:
false
-
offset: integer(int32)
Index for the first item on a page of list itemsDefault Value:
0
-
orderBy: string
Field with which results are to be ordered. Given as orderBy=fieldname:asc/desc, default is asc for ascending.
-
pattern: string
If pattern value is set to 'ToDo' then only ToDo tasks are returned.
-
priority: array[string]
Collection Format:
multi
Task priority from 1 (highest) to 5 (lowest) or Any (default) -
process: array[string]
Collection Format:
multi
Includes only tasks in a given process names -
processDefId: array[string]
Collection Format:
multi
Displays tasks for a given process definition id -
showActionFlag: boolean
Show Action - true or false
-
showPermissionFlag: boolean
Show Permission - true or false
-
since: string
Returned items must be created later than the specified time, in ISO-8601 format YYYY-MM-DDTHH:MM:SS[.sss]Z
-
status: array[string]
Collection Format:
multi
Task status. Default is ASSIGNED. Valid states: ASSIGNED, COMPLETED, SUSPENDED, WITHDRAWN, EXPIRED, ERRORED, ALERTED, INFO_REQUESTED. Task status COMPLETED is valid when used with the following assignments - ADMIN, ALL, PREVIOUS-
Default Value:
ASSIGNED
Allowed Values:[ "ASSIGNED", "COMPLETED", "SUSPENDED", "WITHDRAWN", "EXPIRED", "ERRORED", "ALERTED", "INFO_REQUESTED" ]
-
-
taskNumber: array[string]
Collection Format:
multi
Displays tasks for the given Task number -
totalResults: boolean
Total Result - true or falseDefault Value:
true
-
until: string
Returned items must be created before the specified time, in ISO-8601 format YYYY-MM-DDTHH:MM:SS[.sss]Z
Response
Supported Media Types
- application/json
200 Response
Success
Nested Schema : task
Type:
object
206 Response
Partial Content
400 Response
Bad request
401 Response
Unauthorized
404 Response
Task list not found
500 Response
Internal Server Error