GetTaskDetails |
This API is used to retrieve the task details for a particular task.
Resource URI
/v1/tasks/{instanceid}
Request Type
HTTP GET
HTTP Header Parameters
Parameter |
Description |
Accepted Input Values |
|---|---|---|
SAMLart |
The SAML artifact received after authentication. | Refer to Login for more information on how to authenticate. |
Note: The supported output formats are:
- JSON
- XML
Request Parameters
| Parameter | Descrption |
|---|---|
instanceid |
The instance ID of the task instance. |
Response Parameters
Parameter |
Description |
|---|---|
task_id |
Contains the unique identifier of the task |
parent_task_id |
This ID is used to group all the tasks which are assigned to the same role with All linked users must execute the task option enabled in the Activity Properties interface. Refer to the Activity Properties Interface topic in the Product Documentation for more information. |
component |
Component from which the task has been triggered |
activity_id |
The ID of the activity from which the task has been raised |
call_backinfo |
Information about the caller, BPM or Case |
targets |
Type of target where the task is sent |
| process_instance_id | Contains the unique identifier of the source which created the task |
state |
Contains the current state of the task |
process_name |
Contains the name of the source which created the task |
activity |
Contains the subject of the task |
sender |
Contains the DN of the sender of the task. It has the following attributes:
|
assignee |
Contains the DN of the assignee, who claims the task or to whom the task is assigned by the manager. It has the following attributes:
|
completed_by_user |
Contains the DN of the user who completes the task |
delegated_to_user |
Contains the DN of the user to whom the task is delegated |
priority |
Contains the priority set on the task. It is set between 0 and
5. 0 denotes lowest priority while 5 denotes highest priority
|
task_data |
Contains Application Data and Custom Data |
application_data |
Contains the data the task has to perform, in the XML format |
custom_data |
Contains additional information about the task, in the XML format |
start_date |
Contains date on which the task is supposed to be started |
started_on |
Contains date on which the task has actually been started |
due_date |
Contains date on which the task is due |
logger_context |
Logger context refers to the detailed information about the context of an application and is propagated across all the activities or transactions involved in that application. Refer to the Logger Context topic in the Product Documentation for more information. |
delivery_date |
Contains date on which the task is created |
completion_date |
Contains date on which the task is actually completed |
is_priority_fixed |
Contains the state of priority. If 1, the priority cannot be changed. |
parent_queue |
Contains the Work List ID of the parent work list. While transferring the tasks to a different wotk list, the work list from which the task is transferred is referred as the parent queue |
ui_task_id |
Contains the unique identifier of the application |
url |
Contains the URL of the application or the user interface that must be opened |
Sample Response
{
"tuple": {
"old": {
"task": {
"task_id": "037c7774-eb33-11e3-e85b-0c49e5fed4f9",
"parent_task_id": "037c7774-eb33-11e3-e85b-0c49e5fed4f9",
"process_instance_id": "cb1c1cea-a162-11e3-e85b-0c49dba254f5",
"state": "ASSIGNED",
"process_name": "ClaimRequest",
"activity": "Call Caliee",
"sender": {
"@phone1": "",
"@phone2": "",
"@email": "",
"$": "cn=cordys,cn=organizational users,o=system,cn=cordys,cn=defaultInst,o=vanenburg.com"
},
"business_attributes": null,
"assignee": {
"@phone1": "",
"@phone2": "",
"@email": "",
"$": "cn=cordys,cn=organizational users,o=system,cn=cordys,cn=defaultInst,o=vanenburg.com"
},
"completed_by_user": "",
"delegated_to_user": "",
"delivery_date": "2013-11-01T09:31:28.0",
"start_date": "2013-11-01T09:31:28.0",
"due_date": "",
"started_on": "",
"completion_date": "",
"is_priority_fixed": "false",
"priority": "3",
"parent_queue": "",
"ui_task_id": "005056C0-0008-11E1-ED82-23E3E7A535F8",
"url": "com/cordys/notification/workflow/defaultactivity.caf",
"activity_id": "00215A60-3EB8-11E2-EF7D-3DBF31203586",
"component": "CASE",
"callback_info": {
"InstanceId": [
"cb1c1cea-a162-11e3-e85b-0c49dba254f5",
"cb1c1cea-a162-11e3-e85b-0c49dba254f5"
],
"ModelName": {
"@key": "abab4b02-178c-11e3-e77b-6eeae08593ba",
"$": "ClaimRequest"
},
"activity_id": "00215A60-3EB8-11E2-EF7D-3DBF31203586",
"ActivityName": "Call Caliee",
"ActivityInstanceId": "037c7774-eb33-11e3-e85b-0c49e5fed4f9",
"CaseOverviewID": null,
"ParentSourceInstanceId": [
{
"@type": "Web Service",
"$": "cf7f32be-64a5-11e3-e85b-0c49bbd3dd73"
},
{
"@type": "Web Service",
"$": "cf7f32be-64a5-11e3-e85b-0c49bbd3dd73"
}
],
"RootInstanceId": {
"@type": "CASE",
"$": "cb1c1cea-a162-11e3-e85b-0c49dba254f5"
}
},
"targets": {
"target": {
"@type": "user",
"$": "cn=cordys,cn=organizational users,o=system,cn=cordys,cn=defaultInst,o=vanenburg.com"
}
},
"task_data": {
"application_data": null,
"custom_data": null,
"links": null,
"annotation": null
},
"possible_actions": {
"complete": null,
"delegate": null,
"forward": null,
"start": null,
"suspend": null,
"skip": null,
"execute": null,
"view": null,
"transfer": null
}
}
}
}
}