REST Interface for BPEL-related Task Resources - Task Resource - PUT (Bulk Cancel) Method

Use this method to release multiple claimed task instances.

Sample method invocation

PUT /rest/bpm/htm/v1/task?action={string}

Parameters

Required Parameters

Name

Value Type

Description

action

string

Action to be performed for the specified tasks.

Value	Description
cancel	Release multiple claimed task instances.

Request Content

List of claimed human tasks to be cancelled.

The default content-type is application/json.

MIME Type: application/json

Schema

{  "description": "Task Bulk Operation", 
   "type": "object",
   "properties":
   {  "taskIDs": {"type": ["string"],
         "description": "List of task IDs the operation is performed for."
      }
   }
}

Response Content

Empty if all cancellations succeed. For failed individual cancellations, a report is returned.

The default content-type is application/json.

MIME Type: application/json

Schema

{  "description": "Task Bulk Operation Response", 
   "type": "object",
   "properties":
   {  "failedOperations": 
      [
         {  "tkiid": {"type": "string",
               "description": "ID of a task where the operation has failed."
            },
            "errorNumber": {"type": "string",
               "description": "Message ID of the exception."
            },
            "errorMessage": {"type": "string",
               "description": "Message text of the exception."
            }
         }
      ],
      "description": "List of task IDs for which the operation has failed."
   }
}

Error Response Content

Detailed error information.

The default content-type is application/json.

MIME Type: application/json

Schema

{  "description": "Error Response", 
   "type": "object",
   "properties":
   {  "errorNumber": {"type": "string",
         "description": "Message ID of the exception."
      },
      "errorMessage": {"type": "string",
         "description": "Message text of the exception."
      },
      "errorMessageParameters": {"type": ["string"], "optional": true,
         "description":"Message text parameters 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:

Code	Description
200 OK	Successful completion. A detailed report is returned.
400 Bad Request	The parameters are not valid or they are missing.
406 Not Acceptable	The requested content type or content encoding is not supported.
415 Unsupported Media Type	The content type or content encoding of the request is not supported.
500 Internal Server Error	A severe problem has occurred. Programmer's details are provided.

Available since

6.2

Parent topic: Task Resource