List workflow tasks assigned to the current user
get
/content/management/api/v1.1/workflowTasks
List tasks assigned to the current user.
Request
Query Parameters
-
fields(optional): string
This parameter is used to control the returned fields in each workflow task in the list. This parameter accepts item. and will return the item information for each workflow task in the list only when specified. All the field names are case-sensitive, users must provide the correct field names in the query. Each workflow task has both standard fields (id, name, assignedTo, dueDate, initiatedBy, source, workflow, actions)and additional fields (item).When fields is specified as all (in lower case), all the standard and additional fields are returned. The standard fields are always returned in the response and cannot be filtered out. The user can filter out only the additional fields. This parameter is optional in the query, and by default the result shows only standard fields in the response. Any incorrect or invalid field name given in the query will throw an error.
Example: ?fields=item
This returns all standard fields along with the item additional fields for each workflow task.
Example: ?fields=all
This will return all standard fields and all additional fields for each workflow.
-
limit(optional): integer(int32)
This parameter accepts a non negative integer and is used to control the size of the result.Default Value:
100
-
links(optional): string
This parameter accepts a comma-separated list of link names. By default, this parameter gives all the links applicable. Possible values are: self, canonical, describedby, first, last, prev, next
-
offset(optional): integer(int32)
This parameter accepts a non negative integer and is used to control the start index of the result.Default Value:
0
-
orderBy(optional): string
This parameter is used to control order of results. The value of this query parameter follow the format of fieldName:[asc/desc]. asc stands for ascending order desc stands for descending order, default order is asc.Multiple sort orders are separated by semicolon (;).
format : orderBy={fieldName1}:{asc/desc};{fieldName2}:{asc/desc}Default Value:name:asc
-
q(optional): string
This parameter accepts a query expression condition that matches the field values. Many such query conditions can be joined using AND operators and grouped with parentheses. The value of query condition follows the format of {fieldName} {operator} "{fieldValue}". source, assignedTo.type and assignedTo.id are the field names supported in this version. Field names are optional. When no condition is specified, this will list all the tasks across workflow engines.
Example:
?q=source eq "OIC"
?q=source eq "OIC" AND assignedTo.type eq "user" AND assignedTo.id eq "user123"
?q=source eq "OIC" AND assignedTo.type eq "role" AND assignedTo.id eq "SGGroup" -
totalResults(optional): boolean
This parameter accepts a boolean flag. If specified as true, then the returned result must include the total result count.Default Value:
false
Response
Supported Media Types
- application/json
200 Response
OK.
Root Schema : WorkflowTasks
Type:
object
WorkflowTasks
Show Source
-
aggregationResults(optional):
array aggregationResults
Aggregation results.
-
count(optional):
integer(int32)
Total number of records in the current response.
-
hasMore(optional):
boolean
Check whether there are more pages to fetch.
-
items(optional):
array items
Singular resources contained in the collection.
-
limit(optional):
integer(int32)
Actual page size used by the server. This might not be the same as what the client requests.
-
links(optional):
array links
Links of the resource.
-
offset(optional):
integer(int32)
The actual index from which the singular resources are returned.
-
pinned(optional):
array pinned
Pinned items. Shows items pinned at the top of search list
-
scrollId(optional):
string
scrollId if the search resolved to a scroll search.
-
totalResults(optional):
integer(int32)
Total number of rows that satisfy the client request (excluding the paging parameters.)
Nested Schema : items
Type:
array
Singular resources contained in the collection.
Show Source
-
Array of:
object WorkflowTask
WorkflowTask
Nested Schema : links
Type:
array
Links of the resource.
Show Source
-
Array of:
object Link
Link of the resource.
Nested Schema : pinned
Type:
array
Pinned items. Shows items pinned at the top of search list
Show Source
Nested Schema : WorkflowTask
Type:
object
WorkflowTask
Show Source
-
actions(optional):
array actions
Actions on the workflow task.
-
assignedTo(optional):
array assignedTo
Assigned to user/group
-
dueDate(optional):
object date
date
-
id(optional):
string
id of the workflow task.
-
initiatedBy(optional):
string
Initiated by user
-
item(optional):
object WorkflowTaskItem
WorkflowTaskItem
-
links(optional):
array links
Links
-
name(optional):
string
name of the workflow task.
-
source(optional):
string
source of the workflow.
-
workflow(optional):
object WorkflowId
WorkflowId
Nested Schema : actions
Type:
array
Actions on the workflow task.
Show Source
-
Array of:
object WorkflowTaskActions
WorkflowTaskActions
Nested Schema : WorkflowTaskItem
Type:
object
WorkflowTaskItem
Show Source
-
advancedVideoInfo(optional):
object advancedVideoInfo
Whether the item is video-plus.
-
fileGroup(optional):
string
Name of the fileGroup of item.
-
id(optional):
string
id of the item.
-
isMaster(optional):
boolean
Whether the item is master.
-
language(optional):
string
Language of the item.
-
links(optional):
array links
Links
-
name(optional):
string
Name of the item.
-
repositoryId(optional):
string
Repository of the item.
-
type(optional):
string
Name of the type.
-
typeCategory(optional):
string
Name of the typeCategory of item.
-
version(optional):
string
The current version of the item.
Nested Schema : WorkflowId
Type:
object
WorkflowId
Show Source
-
id(optional):
string
id of the Workflow.
-
isEnabled(optional):
boolean
If workflow is enabled or disabled in OCE.This is a read only field.
-
name(optional):
string
Name of the Workflow.This is a read only field.
Nested Schema : WorkflowTaskActions
Type:
object
WorkflowTaskActions
Show Source
-
name(optional):
string
name of the action.
-
type(optional):
string
type of action.
Nested Schema : WorkflowTaskAssignedToBean
Type:
Show Source
object
-
id(optional):
string
id of the assignee.
-
type(optional):
string
Type of the assignee - user/role.
Nested Schema : advancedVideoInfo
Type:
object
Whether the item is video-plus.
Nested Schema : Link
Type:
object
Link of the resource.
Show Source
-
href(optional):
string
The target resource's URI. It could be template URI. It is a required property in the get response.
-
mediaType(optional):
string
Media type.
-
method(optional):
string
What HTTP method can be used to access the target resource.
-
profile(optional):
string
Link to the metadata that describes the target resource.
-
rel(optional):
string
Relation type. It is a required property in the get response.
-
templated(optional):
boolean
Whether the URI is a template.
304 Response
Not modified.
400 Response
Bad request.
403 Response
Forbidden.
404 Response
Not found.
500 Response
Internal server error.