Retrieve a Task List
get
/tasks
Retrieves a task list for the current user.
The following tables summarize the client request.
Query Parameters
Name | Description | Format |
---|---|---|
assignment | Task assignees - MY, GROUP, MY_AND_GROUP (default), MY_AND_GROUP_ALL, REPORTEES, OWNER, REVIEWER, PREVIOUS, ALL, ADMIN | |
columns | Displays only the selected task attributes | |
dueDateFrom | Start of due date range in the format yyyy-mm-dd hh:mm:ss | |
dueDateTo | End of due date range in the format yyyy-mm-dd hh:mm:ss | |
fromuser | Previous task assignee in process | |
groupBy | Groups tasks by the selected task attribute | |
keyword | Keyword in task title | |
limit | Maximum number of items per page, between 1 and 100, default 25 | integer |
metadata | Displays task details URL | |
offset | Index for the first item on a page of list items, default 1 | integer |
pattern | Filters tasks | |
priority | Task priority from 1 (highest) to 5 (lowest) or Any (default) | |
process | Includes only tasks in a given process | |
showAcion | Displays permissible task actions | boolean |
showPermission | Displays task permissions | boolean |
status | Task status - ASSIGNED (default), SUSPENDED, WITHDRAWN, EXPIRED, ERROR, ALERTED, NEED_INFORMATION |
The following tables summarize the server response.
Supported Media Types
- application/json
- application/xml
200 Response
Lists existing tasks for the current user.
Body
Example application/json
{
"totalResult":true,
"user":{
"rel":"user",
"href":"http://example.com/bpm/api/3.0/identities/user/jlondon"
},
"count":1,
"hasMore":false,
"items":[
{
"updatedDate":"2015-05-27 00:03:37",
"priority":1,
"creatorName":"jstein",
"assignedDate":"2015-05-27 00:03:37",
"createdDate":"2015-05-27 00:03:37",
"ownerUser":"cdickens",
"href":"http://example.com/bpm/api/3.0/tasks/200012",
"assignees":{
"totalResult":false,
"hasMore":false,
"items":[
{
"levels":0,
"type":"user",
"id":"jlondon"
}
]
},
"number":200012,
"hasSubTasks":false,
"title":"myTodoTaskTestingV3",
"rel":"self",
"type":"task",
"state":"ASSIGNED",
"dueDate":"2015-07-26 11:58:59"
}
],
"links":[
{
"rel":"back",
"href":"http://example.com/bpm/api/3.0/"
},
{
"rel":"self",
"href":"http://example.com/bpm/api/3.0/tasks?status=ASSIGNED&priority=&assignment=MY_AND_GROUP&keyword=&limit=25&offset=0"
}
]
}
500 Response
Failed to get task list.
Body