REST API for Oracle Integration

Retrieve a Task

get

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

Retrieves a task by Task number. If document store is enabled for a particular instance apis to fetch and upload attachments will return a error message stating 'Document store is enabled attachments can not be used'. If document store is not enabled for a particular instance apis to fetch folders will return an error message stating 'Document store is not configured'. If conversations are not enabled for a particular instance apis to fetch conversation details will return error message stating 'Conversation are not enabled'.

Request

Path Parameters

id(required): string

Task number

Query Parameters

expand(required): string

Value of all fields that are to be expanded (detailed) - All, comments, attachments, history, payload. If not specified Links to each of the fields is returned.

Default Value:
metadataFlag(required): boolean

Metadata - true or false

Default Value: false

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : task

Type: object

400 Response

Bad request

401 Response

Unauthorized

404 Response

Task not found for given ID.

500 Response

Internal Server Error

Examples

The following example shows how to retrieve a task by using get request on the REST resource.

For task containing web form, a formMetadata attribute is set in response, which contains link to metadata for webform (/webforms/{id}). If the task has a web form, ensure to use /webforms/{id} endpoint.

Send Request

https://example.com/ic/api/process/<version>/tasks/{id}

Where,

example.com is the host where Oracle Integration is running.
<version> is the REST API version.
{id} is the task ID that you get using Retrieve a Task List.

Example of Response Body

{
  "length": 0,
  "title": "NewPCSFormsSubmit",
  "actionList”:””
  "assignedDate": "2017-01-25T09:37:07.000Z",
  "number": 200091,
  "priority": 3,
  "createdDate": "2017-01-25T09:37:07.000Z",
  "state": "ASSIGNED",
  "ownerRole": "NewFormsRestApp.Process Owner",
  "processName": "NewPCSForms",
   ...
   ...
  "hasSubTasksFlag": false,
  "updatedDate": "2017-01-25T09:37:23.000Z",
  "formMetadata": "http://example.com/ic/api/process/<version>/
webforms/default~NewFormsRestApp!1.0~NewPCSForms~d5fb3e55-682b-4dd7-8836-3f670d1c9b3a~c162fd27-99d7-4f81-944d-33ae26c0f089",
"isDocsEnabledFlag": false,"isDocsEnabledFlag": false,
  "isConversationEnabledFlag": false,
  "routingType": "SINGLE",
  "originalAssignees": {
    "totalResult": true,
    "count": 1,
    "hasMore": false,
    "items": [
      {
        "levels": 0,
        "id": "bpm:getPerformer()",
        "type": "application_role"
      }
    ]
  },
  "processDefId": "default~NewFormsRestApp!1.0*~NewPCSForms",
  "processId": "93",
  "processInstanceDetail": { 
 "href": "http://example.com/ic/api/process/<version>/processes/93",  
  "length": 0, 
 "rel": "processInstanceDetail"
}
}