Jump to

• Request
• Response

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

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.)

{
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"boolean",
            "description":"Check whether there are more pages to fetch."
        },
        "offset":{
            "type":"integer",
            "format":"int32",
            "description":"The actual index from which the singular resources are returned."
        },
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of records in the current response."
        },
        "limit":{
            "type":"integer",
            "format":"int32",
            "description":"Actual page size used by the server. This might not be the same as what the client requests."
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of rows that satisfy the client request (excluding the paging parameters.)"
        },
        "scrollId":{
            "type":"string",
            "description":"scrollId if the search resolved to a scroll search."
        },
        "items":{
            "type":"array",
            "description":"Singular resources contained in the collection.",
            "items":{
                "$ref":"#/definitions/WorkflowTask"
            }
        },
        "aggregationResults":{
            "type":"array",
            "description":"Aggregation results.",
            "items":{
                "$ref":"#/definitions/AggregationResult"
            }
        },
        "links":{
            "type":"array",
            "description":"Links of the resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "pinned":{
            "type":"array",
            "description":"Pinned items. Shows items pinned at the top of search list",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"WorkflowTasks"
}

Nested Schema : aggregationResults

Type: array

Aggregation results.

Show Source

• Array of: object AggregationResult

{
    "type":"array",
    "description":"Aggregation results.",
    "items":{
        "$ref":"#/definitions/AggregationResult"
    }
}

Nested Schema : items

Type: array

Singular resources contained in the collection.

Show Source

• Array of: object WorkflowTask
  WorkflowTask

{
    "type":"array",
    "description":"Singular resources contained in the collection.",
    "items":{
        "$ref":"#/definitions/WorkflowTask"
    }
}

Nested Schema : links

Type: array

Links of the resource.

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Links of the resource.",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : pinned

Type: array

Pinned items. Shows items pinned at the top of search list

Show Source

• Array of: string

{
    "type":"array",
    "description":"Pinned items. Shows items pinned at the top of search list",
    "items":{
        "type":"string"
    }
}

Nested Schema : AggregationResult

Type: object

Show Source

• name(optional): string
  Read Only: true

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "readOnly":true
        }
    }
}

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

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the workflow task."
        },
        "name":{
            "type":"string",
            "description":"name of the workflow task."
        },
        "source":{
            "type":"string",
            "description":"source of the workflow."
        },
        "assignedTo":{
            "type":"array",
            "description":"Assigned to user/group",
            "items":{
                "$ref":"#/definitions/WorkflowTaskAssignedToBean"
            }
        },
        "dueDate":{
            "description":"Due date and time",
            "$ref":"#/definitions/date"
        },
        "initiatedBy":{
            "type":"string",
            "description":"Initiated by user"
        },
        "item":{
            "description":"Item information.",
            "$ref":"#/definitions/WorkflowTaskItem"
        },
        "workflow":{
            "description":"Workflow information.",
            "$ref":"#/definitions/WorkflowId"
        },
        "actions":{
            "type":"array",
            "description":"Actions on the workflow task.",
            "items":{
                "$ref":"#/definitions/WorkflowTaskActions"
            }
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"WorkflowTask"
}

Nested Schema : actions

Type: array

Actions on the workflow task.

Show Source

• Array of: object WorkflowTaskActions
  WorkflowTaskActions

{
    "type":"array",
    "description":"Actions on the workflow task.",
    "items":{
        "$ref":"#/definitions/WorkflowTaskActions"
    }
}

Nested Schema : assignedTo

Type: array

Assigned to user/group

Show Source

• Array of: object WorkflowTaskAssignedToBean

{
    "type":"array",
    "description":"Assigned to user/group",
    "items":{
        "$ref":"#/definitions/WorkflowTaskAssignedToBean"
    }
}

Nested Schema : date

Type: object

date

Show Source

• timezone(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "timezone":{
            "type":"string"
        }
    },
    "description":"date"
}

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.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the item."
        },
        "name":{
            "type":"string",
            "description":"Name of the item."
        },
        "type":{
            "type":"string",
            "description":"Name of the type."
        },
        "typeCategory":{
            "type":"string",
            "description":"Name of the typeCategory of item."
        },
        "fileGroup":{
            "type":"string",
            "description":"Name of the fileGroup of item."
        },
        "repositoryId":{
            "type":"string",
            "description":"Repository of the item."
        },
        "version":{
            "type":"string",
            "description":"The current version of the item."
        },
        "language":{
            "type":"string",
            "description":"Language of the item."
        },
        "isMaster":{
            "type":"boolean",
            "description":"Whether the item is master."
        },
        "advancedVideoInfo":{
            "type":"object",
            "description":"Whether the item is video-plus."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"WorkflowTaskItem"
}

Nested Schema : links

Type: array

Links

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Links",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

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.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the Workflow."
        },
        "name":{
            "type":"string",
            "description":"Name of the Workflow.This is a read only field."
        },
        "isEnabled":{
            "type":"boolean",
            "description":"If workflow is enabled or disabled in OCE.This is a read only field."
        }
    },
    "description":"WorkflowId"
}

Nested Schema : WorkflowTaskActions

Type: object

WorkflowTaskActions

Show Source

• name(optional): string
  name of the action.
• type(optional): string
  type of action.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"name of the action."
        },
        "type":{
            "type":"string",
            "description":"type of action."
        }
    },
    "description":"WorkflowTaskActions"
}

Nested Schema : WorkflowTaskAssignedToBean

Type: object

Show Source

• id(optional): string
  id of the assignee.
• type(optional): string
  Type of the assignee - user/role.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the assignee."
        },
        "type":{
            "type":"string",
            "description":"Type of the assignee - user/role."
        }
    }
}

Nested Schema : advancedVideoInfo

Type: object

Whether the item is video-plus.

Nested Schema : links

Type: array

Links

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Links",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

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.

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"The target resource's URI. It could be template URI. It is a required property in the get response."
        },
        "rel":{
            "type":"string",
            "description":"Relation type. It is a required property in the get response."
        },
        "templated":{
            "type":"boolean",
            "description":"Whether the URI is a template."
        },
        "method":{
            "type":"string",
            "description":"What HTTP method can be used to access the target resource."
        },
        "profile":{
            "type":"string",
            "description":"Link to the metadata that describes the target resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type."
        }
    },
    "description":"Link of the resource."
}

304 Response

Not modified.

400 Response

Bad request.

403 Response

Forbidden.

404 Response

Not found.

500 Response

Internal server error.

Back to Top