REST Interface for Federated BPM Resources - Task Instance Resource

This IBM Business Process Manager federated resource represents a human task. It is used to view details of a task, check its status, roles, progress, priority etc., or to change task properties, such as its priority, its category or a custom property.

Resource URI

/rest/bpm/federated/htm/v1/task/{tkiid}

Path Elements

Name	Data Type	Description
tkiid	string	Task instance ID.

Available Since

7.5

Subtopics

The following subtopics describe the HTTP methods defined for this resource:

GET

Use this method to retrieve details of a specified human task.
PUT (Update)

Use this method to update the properties of a task, for example, the priority, category, or a custom property.
PUT (Start)

Use this method to start a new task using a synchronous (call) or asynchronous (start) operation.
PUT (Claim)

Use this method to claim the responsibility for a task.
PUT (Cancel)

Use this method to release a claimed task.
PUT (Complete)

Use this method to complete a task with output or fault data.
PUT (Suspend)

Use this method to suspend a task until a specified point in time, for a specified time period, or indefinitely.
PUT (Suspend and Cancel Claim)

Use this method to suspend a claimed task until a specified point in time or for a specified time period, and cancel the claim when the task is automatically resumed.
PUT (Resume)

Use this method to resume the processing of a suspended task.
PUT (Terminate)

Use this method to terminate a task instance.
DELETE

Use this method to delete a task instance.

Parent Topic: REST Interface for Federated BPM Resources Resource Set