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

Get a Task

get

/process/api/v1/tasks/{id}

Get task detail by ID.

Request

Path Parameters
Query Parameters
Header Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : Task
Match All
Show Source
Nested Schema : CommonModel
Type: object
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

401 Response

Unauthorized

404 Response

Task not found for given ID

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

The following example shows how to get details of a task 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/asdfgh1234asdfgh?totalResultsGrouped=false' \
  -H 'accept: application/json' \
  -H 'Accept-Language: en' \
  -H 'oci-original-url: oracle'

Example Format of 200 Operation Successful Response

{
    "links": [
        {
            "href": "http://oracle.com:9020/process/api/v1/tasks/1f15bc3a-5948-11ef-873e-0242ac15001b",
            "rel": "self"
        },
        {
            "href": "http://oracle.com:9020/process/api/v1/tasks",
            "rel": "parent"
        },
        {
            "href": "http://oracle.com:9020/process/api/v1/tasks/1f15bc3a-5948-11ef-873e-0242ac15001b/comments",
            "rel": "comments"
        },
        {
            "href": "http://oracle.com:9020/process/api/v1/tasks/1f15bc3a-5948-11ef-873e-0242ac15001b/documents",
            "rel": "documents"
        },
        {
            "href": "http://oracle.com:9020/process/api/v1/tasks/1f15bc3a-5948-11ef-873e-0242ac15001b/payload",
            "rel": "payload"
        }
    ],
    "id": "1f15bc3a-5948-11ef-873e-0242ac15001b",
    "title": "User task V1",
    "isAdhoc": false,
    "priority": 2,
    "state": "COMPLETED",
    "substate": "EXPIRED",
    "isEscalated": false,
    "reason": {
        "user": {
            "id": "8100030d-f312-4204-8f37-bd4d1c779ddb",
            "name": "System"
        },
        "candidateUsers": [
            {
                "id": "077acfe8-fc17-4ceb-8216-e03286aab802",
                "name": "hael"
            },
            {
                "id": "50a6480d-ae57-41e8-9346-df7639b513b0",
                "name": "wake"
            },
            {
                "id": "20c0862f-fd35-40ca-a70d-03d0faac45a9",
                "name": "ssaInstanceAdmin"
            }
        ],
        "candidateGroups": [],
        "action": "EXPIRED",
        "date": "2024-08-13T07:51:16.117+00:00"
    },
    "reasonText": "Task got expired at task expiration date by System on Tue Aug 13 07:51:16 GMT 2024",
    "fromUser": {
        "id": "20c0862f-fd35-40ca-a70d-03d0faac45a9",
        "name": "ssaInstanceAdmin",
        "type": "USER"
    },
    "createdBy": {
        "id": "20c0862f-fd35-40ca-a70d-03d0faac45a9",
        "name": "ssaInstanceAdmin",
        "type": "USER"
    },
    "createdDate": "2024-08-13T07:46:16.582+00:00",
    "dueDate": "2024-08-13T07:51:16.000+00:00",
    "lastUpdatedDate": "2024-08-13T07:51:16.117+00:00",
    "finishedDate": "2024-08-13T07:51:16.193+00:00",
    "completedDate": "2024-08-13T07:51:16.193+00:00",
    "assignedDate": "2024-08-13T07:46:16.596+00:00",
    "processName": "HTProcess",
    "activityInstanceId": "1f0e4229-5948-11ef-873e-0242ac15001b",
    "processInstanceId": "1eede8d8-5948-11ef-873e-0242ac15001b",
    "processDefinitionId": "HTApp--1.0--HTProcess:1:157df837-4dae-11ef-a741-0242ac15001f",
    "processDefinitionKey": "HTApp--1.0--HTProcess",
    "processExecutionId": "1eede8d8-5948-11ef-873e-0242ac15001b",
    "rootInstanceId": "1eede8d8-5948-11ef-873e-0242ac15001b",
    "rootProcessId": "1eede8d8-5948-11ef-873e-0242ac15001b",
    "taskDefinitionKey": "flow_6cb9a1bc-9ecd-b1d6-4dd1-e5d0cade43dd",
    "applicationName": "HTApp",
    "applicationTitle": "HTApp",
    "businessKey": "testBKey",
    "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"
            }
        ],
        "custom": []
    },
    "expirationDate": "2024-08-13T07:51:16.000+00:00",
    "tags": []
}
Back to Top