Retrieve a Custom Task List
get
/bpm/api/4.0/tasks/views/{viewname}
Retrieves a custom task list by name.
Request
Path Parameters
-
viewname(required): string
View Name
Query Parameters
-
action: boolean
Action
-
assignment: string
Task assignees - MY, GROUP, MY_AND_GROUP (default), MY_AND_GROUP_ALL, REPORTEES, OWNER, REVIEWER, PREVIOUS, ALL, ADMINDefault 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
-
fromuser: array[string]
Previous task assignee
-
groupBy: string
Groups tasks by the selected task attribute
-
keyword: string
Keyword in task title
-
limit: integer(int32)
Maximum number of items per page, between 1 and 100, default 25Default Value:
25
-
metadataFlag: boolean
Metadata - true or false(default)Default Value:
false
-
offset: integer(int32)
Index for the first item on a page of list items, default 1Default Value:
0
-
pattern: string
Includes only to-do tasks if set to ToDo
-
priority: array[string]
Task priority from 1 (highest) to 5 (lowest) or Any (default)
-
showPermission: boolean
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]
Task status - ASSIGNED (default), SUSPENDED, WITHDRAWN, EXPIRED, ERROR, ALERTED
-
totalResults: boolean
Total Result - true (default) 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
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Success
Root Schema : Collection
Type:
Show Source
object
-
count: integer
(int32)
-
hasMore: boolean
Default Value:
false
-
items: array
items
-
limit: integer
(int32)
-
links: array
links
-
offset: integer
(int32)
-
totalResult: boolean
Default Value:
false
-
userLink: object
Link
Nested Schema : Link
Type:
Show Source
object
-
href(required): string
-
rel(required): string
Allowed Values:
[ "self", "cancel", "forceCancel", "hold", "release", "subscribe", "permissions", "executionStatus" ]
400 Response
Bad request
401 Response
Unauthorized
404 Response
Task List not found for view
500 Response
Internal Server Error