1. REST API for Oracle Cloud Infrastructure Process Automation
  2. Tasks
  3. User Tasks

List Tasks

get

/process/api/v1/tasks

List tasks for the current user.

Request

Query Parameters
  • Fetch tasks for assigneesIn. Applicable to only PERSONA and MEMBER assignment filter.
  • Assignment Filter - | MY - My directly assigned tasks, | GROUP - My group assigned tasks, | MY_AND_GROUP - My and group tasks. Does not fetch tasks that are acquired by other users in the groups you belong to, | MY_AND_GROUP_ALL - Includes tasks that are acquired by other users in the groups you belong to, | CREATOR - Fetch tasks where logged-in user is creator of this task, | PERSONA - Fetch tasks where the logged-in user has access to this task due to application MANAGE permissions, | MEMBER - Fetch tasks where logged-in user is member of instances or adhoc tasks, | Default is MY.
    Default Value: MY
    Allowed Values: [ "MY", "GROUP", "MY_AND_GROUP", "MY_AND_GROUP_ALL", "CREATOR", "PERSONA", "MEMBER" ]
  • BusinessKey of the Process or DP instance
  • BusinessKeyLike of the Process or DP instance
  • Fetch tasks having candidateRolesIn. Applicable to only PERSONA and MEMBER assignment filter.
  • Fetch tasks having candidateUsersIn. Applicable to only PERSONA and MEMBER assignment filter.
  • Task category - a logical classification of tasks or task flows
  • Fetch tasks initiated by creatorsIn. Applicable to only PERSONA and MEMBER assignment filter.
  • Restrict to tasks that belong to a given dp definitionId.
  • Restrict to tasks that belong to case instances with the given ID.
  • Restrict to tasks that belong to a case definition with the given name.
  • Restrict to tasks that are due on the given date. format: YYYY-MM-DD Or YYYY-MM-DDTHH:MM:SS[.sss]Z We use YYYY-MM-DD date part to match against task due date.
  • Restrict to tasks that are due after the given date. format: YYYY-MM-DDTHH:MM:SS[.sss]Z
  • Restrict to tasks that are due before the given date. format: YYYY-MM-DDTHH:MM:SS[.sss]Z
  • Restrict to tasks that were started after the given expiry date. format: YYYY-MM-DDTHH:MM:SS[.sss]Z
  • Restrict to tasks that were started before the given expiry date. format: YYYY-MM-DDTHH:MM:SS[.sss]Z
  • If true, then parent task details like title and summary is fetched.
    Default Value: false
  • Keyword search against task title, task description, taskId, processInstanceId, dpInstanceId.
  • Maximum Value: 50
    The number of items to return. If parameter is omitted default value 25 is set. If limit <=0 or limit> 50 then up to 50 records are returned
    Default Value: 25
  • The label of member. Use with MEMBER assignment filter.
    Example:
    Get tasks where I am Owner (assignment=MEMBER&memberLabel=Owner) OR get tasks for which label is Owner and also jstein is a member(assignment=MEMBER&memberLabel=Owner&withMemberIdentityId=<jstein-id>)
  • Permission level of the member (INSPECT, READ, USE or MANAGE). Use with MEMBER assignment filter.
  • 0 based index. The number of items to skip before starting to collect the result set.
    Default Value: 0
  • This query parameter specifies the orderBy clause. Supported sortBy fieldName should be any of: title,priority,dueDate,createdDate,completedDate The value must follow the format fieldName[:(asc/desc)]. e.g. priority:asc. Multiple ordering is not supported. Default sortOrder is asc if not specified. Default orderBy is createdDate:desc
  • Fetch tasks that match the parent taskIdIn.
  • priority
  • Restrict to tasks that belong to a given process definitionId.
  • Restrict to tasks that belong to process instances with the given ID.
  • Restrict to tasks that belong to a process definition with the given name.
  • Restrict query to all process instances whose root process instance id is the given process/dp instance.
  • Restrict to tasks that were started after the given date. format: YYYY-MM-DDTHH:MM:SS[.sss]Z
  • Task State - ASSIGNED, UNASSIGNED, DELEGATED, WITHDRAWN, COMPLETED. Default state is as follows: 1) ASSIGNED for MY assignment filter 2) UNASSIGNED for GROUP assignment filter 3) All states for CREATOR, PERSONA and MEMBER assignment filter
    Allowed Values: [ "ASSIGNED", "UNASSIGNED", "DELEGATED", "WITHDRAWN", "COMPLETED" ]
  • Sub-state of state. Currently, Expired subState is supported.
    Allowed Values: [ "EXPIRED" ]
  • The task summary.
  • The task summary like.
  • The task title.
  • The task title like.
  • If true return total count of records for given query with filters
    Default Value: false
  • Restrict to tasks that were started before the given date. format: YYYY-MM-DDTHH:MM:SS[.sss]Z
  • Member's identityId. Use with MEMBER assignment filter.
    Example:
    Get tasks where I am a member along with jstein-id (assignment=MEMBER&withMemberIdentityId=<jstein-id>)
Header Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : TaskCollection
Match All
Show Source
Nested Schema : CommonModel
Type: object
Show Source
Nested Schema : TaskCollection-allOf[1]
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : Task
Match All
Show Source
Nested Schema : Task-allOf[1]
Type: object
Show Source
Nested Schema : User
Match All
Show Source
Nested Schema : taskActions
Type: object
Show Source
Nested Schema : candidateGroups
Type: array
Show Source
Nested Schema : candidateUsers
Type: array
Show Source
Nested Schema : UserOrAppClient
Match All
Show Source
Nested Schema : ParentTaskDetail
Type: object
Show Source
Nested Schema : Reason
Type: object
Show Source
Nested Schema : tags
Type: array
Show Source
Nested Schema : TaskTotalResultsGrouped
Type: object
Show Source
Nested Schema : IdentityCommon
Type: object
Show Source
Nested Schema : custom
Type: array
Show Source
Nested Schema : system
Type: array
Show Source
Nested Schema : taskAction
Type: object
Show Source
Nested Schema : GroupAndRole
Match All
Show Source
Nested Schema : Discriminator: type
Type: object
Show Source
Nested Schema : Discriminator: type
Type: object
Show Source
Nested Schema : candidateGroups
Type: array
Show Source
Nested Schema : candidateUsers
Type: array
Show Source

400 Response

Returned if some of the query parameters are invalid

401 Response

Unauthorized

404 Response

Tasks not found

429 Response

Too many requests

500 Response

Internal server error

503 Response

Too many exceptions or too slow requests
Back to Top

Examples

Example: Get list of all tasks assigned to me

The following example shows how to get list of all tasks by submitting a GET request on the REST resource using cURL. For more information about cURL, see cURL Access. For more information about endpoint URL structure, see Send Requests. 

curl -X 'GET' \
  'https://oracle.com/process/api/v1/tasks?state=ASSIGNED&assignment=MY&creatorsIn=string&keyword=loan&offset=0&limit=25&totalResults=false&withMemberIdentityId=Get%20tasks%20where%20I%20am%20a%20member%20along%20with%20jstein-id%20%28assignment%3DMEMBER%26withMemberIdentityId%3D%3Cjstein-id%3E%29&memberLabel=Get%20tasks%20where%20I%20am%20Owner%20%28assignment%3DMEMBER%26memberLabel%3DOwner%29%20OR%20get%20tasks%20for%20which%20label%20is%20Owner%20and%20also%20jstein%20is%20a%20member%28assignment%3DMEMBER%26memberLabel%3DOwner%26withMemberIdentityId%3D%3Cjstein-id%3E%29&includeParentTaskDetail=false' \
  -H 'accept: application/json' \
  -H 'Accept-Language: en' \
  -H 'oci-original-url: oracle.com'

Example Format of 200 Operation Successful Response

{
    "links": [
        {
            "href": "http://oracle.com:9020/process/api/v1/tasks",
            "rel": "self"
        },
        {
            "href": "http://oracle.com:9020/process/api/v1",
            "rel": "parent"
        }
    ],
    "limit": 25,
    "offset": 0,
    "count": 1,
    "items": [
        {
            "links": [
                {
                    "href": "http://oracle.com:9020/process/api/v1/tasks/2574ab6b-0242ac15001a",
                    "rel": "self"
                },
                {
                    "href": "http://oracle.com:9020/process/api/v1/tasks",
                    "rel": "parent"
                },
                {
                    "href": "http://oracle.com:9020/process/api/v1/tasks/257415001a/comments",
                    "rel": "comments"
                },
                {
                    "href": "http://oracle.com:9020/process/api/v1/tasks/2574ab6b-6d001a/documents",
                    "rel": "documents"
                },
                {
                    "href": "http://oracle.com:9020/process/api/v1/tasks/2574ab6b-6d0d-1a/payload",
                    "rel": "payload"
                }
            ],
            "id": "2574ab6b5001a",
            "title": "Activity  1",
            "summary": "Sum: GT HT1",
            "isAdhoc": false,
            "priority": 2,
            "isSuspended": false,
            "state": "ASSIGNED",
            "substate": "INITIATED",
            "isEscalated": false,
            "reason": {
                "user": {
                    "id": "50a6480d-df7639b513b0",
                    "name": "wshake"
                },
                "assignee": {
                    "id": "077acfe8-faab802",
                    "name": "handel"
                },
                "candidateUsers": [],
                "candidateGroups": [],
                "action": "INITIATE",
                "date": "2024-09-07T11:34:30.220+00:00"
            },
            "reasonText": "Started by wshake to handel on Sat Sep 07 11:34:30 GMT 2024",
            "assignee": {
                "id": "077acfe886aab802",
                "name": "handel"
            },
            "fromUser": {
                "id": "50a6480df7639b513b0",
                "name": "wshake",
                "type": "USER"
            },
            "createdBy": {
                "id": "50a64813b0",
                "name": "wshake",
                "type": "USER"
            },
            "createdDate": "2024-09-07T11:34:30.218+00:00",
            "lastUpdatedDate": "2024-09-07T11:34:30.220+00:00",
            "rootInstanceId": "1d-11ef-8a0e-0242ac15001a",
            "rootProcessId": "1cf9572ac15001a",
            "dpName": "DPFirstPro",
            "dpInstanceId": "1cf957cf-6d0d-11ef-8a0e-0242ac15001a",
            "dpDefinitionId": "f-8a0e-0242ac15001a",
            "dpDefinitionKey": "DPstPro",
            "dpExecutionId": "1cff72ac15001a",
            "taskDefinitionKey": "pi_33f-384fd8d802b3",
            "applicationName": "DPFirst",
            "applicationTitle": "DPFirst",
            "candidateUsers": [],
            "candidateGroups": [],
            "availableActions": {
                "system": [
                    {
                        "title": "VIEW_TASK_PAYLOAD",
                        "actionId": "VIEW_TASK_PAYLOAD"
                    },
                    {
                        "title": "VIEW_TASK",
                        "actionId": "VIEW_TASK"
                    },
                    {
                        "title": "ADD_DOCUMENT",
                        "actionId": "ADD_DOCUMENT"
                    },
                    {
                        "title": "ADD_COMMENT",
                        "actionId": "ADD_COMMENT"
                    },
                    {
                        "title": "UPDATE_TASK_PAYLOAD",
                        "actionId": "UPDATE_TASK_PAYLOAD"
                    },
                    {
                        "title": "UPDATE_TASK",
                        "actionId": "UPDATE_TASK"
                    },
                    {
                        "title": "ESCALATE",
                        "actionId": "ESCALATE"
                    },
                    {
                        "title": "REQUEST_FOR_INFO",
                        "actionId": "REQUEST_FOR_INFO"
                    },
                    {
                        "title": "REASSIGN",
                        "actionId": "REASSIGN"
                    }
                ],
                "custom": [
                    {
                        "title": "APPROVE",
                        "actionId": "APPROVE"
                    },
                    {
                        "title": "REJECT",
                        "actionId": "REJECT"
                    }
                ]
            },
            "tags": []
        }
    ]
}

Example Format of Bad Request Response

{
Back to Top