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 Resource - PUT (Bulk Cancel) Method

Use this method to release multiple claimed task instances.

Resource URI

PUT /v1/task?{parameters}

Parameters

Required Parameters
NameValue TypeDescription
action string
Action to be performed for the specified tasks.
ValueDescription
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


+ View Schema
{  "description": "HTM 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 updates, a report is returned.

The default content-type is application/json.

MIME Type: application/json


+ View Schema
{  "description": "HTM 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 the operation is performed 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 OK
Successful completion - detailed report returned.
400 Bad RequestThe parameters are not valid or they are missing.
500 Internal Server ErrorA severe problem has occurred, programmer's details are provided.

Available Since

6.2

Parent Topic: Task Resource