Retrieve a Task List

get

/bpm/api/4.0/tasks

Retrieves a task list for the current user.

Request

Query Parameters
  • Task assignees - MY, GROUP, MY_AND_GROUP (default), MY_AND_GROUP_ALL, REPORTEES, CREATOR, OWNER, REVIEWER, PREVIOUS, ALL, ADMIN. MY - Displays tasks that are assigned exclusively to you. GROUP - Displays tasks that are assigned to a group of which you are a member. MY_AND_GROUP - 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 - 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. CREATOR - Displays tasks that are initiated by you. OWNER - Displays tasks in which you are task owner. REVIEWER - Displays tasks for which you are a reviewer. PREVIOUS - Displays tasks that were previously updated by you. ALL - No filtering; Displays all tasks regardless of assignment or creator. ADMIN - No filtering; Displays all tasks regardless of assignment or creator.
    Default Value: MY_AND_GROUP
  • if provided, only tasks created by the given user are returned
  • Start of due date range in ISO-8601 format YYYY-MM-DDTHH:MM:SS[.sss]Z
  • End of due date range in ISO-8601 format YYYY-MM-DDTHH:MM:SS[.sss]Z
  • Collection Format: multi
    Displays only the selected task attributes, which can include createdDate, creator, updatedDate, fromUser, tasknumber, priority,ownerUser, state, approvalDuration,taskDefinitionName, taskNameSpace, taskId, category,assignedDate, dueDate,outcome,ecid, identificationKey
  • Collection Format: multi
    Previous task assignee
  • if provided, only tasks with the given task identification key are returned
  • Keyword in task title
  • Maximum number of items per page, preferably between 1 and 100, default 25. Zero or negative value will render the parameter inapplicable and all results will be returned in single page
    Default Value: 25
  • metadataFlag - true or false. if metadataFlag is true, then task details URL is populated.
    Default Value: false
  • Index for the first item on a page of list items. Negative value will render the parameter inapplicable
    Default Value: 0
  • Field with which results are to be ordered. Given as orderBy=fieldname:asc/desc, default is asc for ascending.Field Names supported are createdDate, creator, updatedDate, fromUser, tasknumber, priority,ownerUser, state, approvalDuration,taskDefinitionName, taskNameSpace, taskId, category,assignedDate, dueDate,outcome,ecid, identificationKey
  • if provided, only tasks with the given task outcome value are returned
  • If pattern value is set to 'ToDo' then only ToDo tasks are returned.
  • Collection Format: multi
    Task priority from 1 (highest) to 5 (lowest) or Any (default)
  • Show Action - true or false
  • Show Permission - true or false
  • Returned items must be created later than the specified time, in ISO-8601 format YYYY-MM-DDTHH:MM:SS[.sss]Z
  • Collection Format: multi
    Task status (Task status COMPLETED is valid when used with following assignments - ADMIN, ALL, PREVIOUS)
    • Default Value: ASSIGNED
      Allowed Values: [ "ASSIGNED", "COMPLETED", "SUSPENDED", "WITHDRAWN", "EXPIRED", "ERRORED", "ALERTED" ]
  • Total Result - true or false
    Default Value: true
  • Returned items must be created before the specified time, in ISO-8601 format YYYY-MM-DDTHH:MM:SS[.sss]Z
Back to Top

Response

Supported Media Types

200 Response

Success
Body ()
Root Schema : Collection
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : task
Type: object
Show Source
Nested Schema : actionList
Type: array
Show Source
Nested Schema : Collection
Type: object
Show Source
Nested Schema : attachments
Type: array
Show Source
Nested Schema : comments
Type: object
Show Source
Nested Schema : taskHistories
Type: object
Show Source
Nested Schema : payload
Type: object
Show Source
Nested Schema : permissions
Type: array
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : identity
Type: object
Show Source
Nested Schema : attachment
Type: object
Show Source
Nested Schema : docAttributes
Type: array
Show Source
Nested Schema : genericMap
Type: object
Show Source
Nested Schema : comment
Type: array
Show Source
Nested Schema : comment
Type: object
Show Source
Nested Schema : taskHistory
Type: array
Show Source
Nested Schema : taskHistory
Type: object
Show Source
Nested Schema : summaryFields
Type: array
Show Source

206 Response

Partial Content

400 Response

Bad request

401 Response

Unauthorized

404 Response

Task list not found

500 Response

Internal Server Error
Back to Top