WebSphere Process Server, Version 6.2.0.1 Operating Systems: AIX, HP-UX, Linux, Solaris, Windows, i5/OS, z/OS


Human Task Manager REST Interface - Task Instance History Resource - GET Method

Use this method to retrieve the history of a human task instance.

Resource URI

GET /v1/task/{tkiid}/history

Parameters

None.

Request Content

None.

Response Content

Task instance history log.

The default content-type is application/json.

MIME Type: application/json


+ View Schema
{  "description": "HTM Task History Log", 
   "type": "object",
   "properties":
   {  "tkiid": {"type": "string"},
      "items":
      [
         {  "escalationID": {"type": "string", "optional": true,
               "description": "ID of an escalation instance."
            },
            "event": {"type": "string", 
               "description": "Event type.",
               "enum":
               [
                  "EscalationCustomPropertySet",     
                  "EscalationFired",                 
                  "EscalationStarted",               
                  "EscalationWorkItemCreated",       
                  "EscalationWorkItemDeleted",       
                  "EscalationWorkItemRefreshed",     
                  "EscalationWorkItemTransferred",   
                  "SubTasksCompleted",               
                  "TaskClaimCancelled",              
                  "TaskClaimed",                     
                  "TaskCompleted",                   
                  "TaskCompletedWithFollowOn",       
                  "TaskCreated",                     
                  "TaskCustomPropertySet",           
                  "TaskDeleted",                     
                  "TaskExpired",                     
                  "TaskFailed",                      
                  "TaskFaultMessageUpdated",         
                  "TaskInputMessageUpdated",         
                  "TaskOutputMessageUpdated",        
                  "TaskRestarted",                   
                  "TaskResumed",                     
                  "TaskStarted",                     
                  "TaskSuspended",                   
                  "TaskTemplateInstalled",           
                  "TaskTemplateUninstalled",         
                  "TaskTerminated",                  
                  "TaskUpdated",                     
                  "TaskWaitingForSubTask",           
                  "TaskWorkItemCreated",             
                  "TaskWorkItemDeleted",             
                  "TaskWorkItemRefresehd",           
                  "TaskWorkItemTransferred"         
               ]
            },    
            "fromID": {"type": "string", "optional": true,
               "description": "ID of the user or group whose work item has been transferred to the to-user, or whose workitem has been deleted."
            },
            "idKind": {"type": "string", "optional": true, 
               "description": "Work item authorization type.",
               "enum":
               [
                  "WORK_ITEM_KIND_EVERYBODY",
                  "WORK_ITEM_KIND_GROUP",
                  "WORK_ITEM_KIND_USER"
               ]
            },    
            "parentID": {"type": "string", "optional": true,
               "description": "ID of a parent task."
            },
            "principal": {"type": "string",
               "description": "Name of principal who triggered this event."
            },
            "reason": {"type": "string", "optional": true, 
               "description": "Work item reason.",
               "enum":
               [
                  "REASON_ADMINISTRATOR",
                  "REASON_EDITOR",
                  "REASON_ESCALATION_RECEIVER",
                  "REASON_MAX",
                  "REASON_NONE",
                  "REASON_ORIGINATOR",
                  "REASON_OWNER",
                  "REASON_POTENTIAL_INSTANCE_CREATOR",
                  "REASON_POTENTIAL_OWNER",
                  "REASON_POTENTIAL_SENDER",
                  "REASON_POTENTIAL_STARTER",
                  "REASON_READER",
                  "REASON_STARTER",
                  "REASON_STATE_MACHINE_END",
                  "REASON_STATE_MACHINE_EVENT_AVAILABLE",
                  "REASON_STATE_MACHINE_START"
               ]
            },    
            "relatedTime": {"type": "string", "optional": true, "format": "date-time",
               "description": "Time when a related event will occur, e.g., an expiration."
            },
            "timeStamp": {"type": "string", "format": "date-time",
               "description": "Time when the event occurred."
            },
            "toID": {"type": "string", "optional": true,
               "description": "ID of the user or group a work item has been created for."
            }
         }
      ]
   }
}

Error Response Content

Detailed error information.

The default content-type is application/json.

MIME Type: application/json


+ View Schema
{  "description": "HTM Error Response", 
   "type": "object",
   "properties":
   {  "errorNumber": {"type": "string",
         "description": "Message ID of the exception."
      },
      "errorMessage": {"type": "string",
         "description": "Message text of the exception."
      },
      "programmersDetails": {"type": "object", "optional": true,
         "description":"Additional, exception details, for example, a stack trace."
      }
   }
} 

Status Codes

The method returns one of the following status codes:
CodeDescription
200 OKSuccess completion.
400 Bad RequestThe parameters are not valid or they are missing.
401 UnauthorizedThe caller is not authorized for this request.
404 Not Found
The task does not exist or the task history is not enabled.
500 Internal Server ErrorA severe problem has occurred, programmer's details are provided.

Available Since

6.2

Parent Topic: Task Instance History Resource