REST Interface for BPEL-related Task Resources - Work Basket Instance Resource - PUT (Transfer to Work Basket) Method

Use this method to transfer one or more task instances to a specified work basket.

Sample method invocation

PUT /rest/bpm/htm/v1/workBasket/{wbid}?action={string}[&taskID={string}][&cancelClaimIfNeeded={boolean}]

Parameters

Required Parameters

Name

Value Type

Description

action

string

Action to be performed for the specified task.

Value	Description
transferToWorkBasket	Transfer a task instance to a work basket.

Optional Parameters

Name

Value Type

Description

taskID

string

Task ID. If this parameter is specified then a request message body must not be present.

cancelClaimIfNeeded

boolean

Specifies whether claiming of tasks should be cancelled.

Value	Description
true	Specifies that the claim of a task should be cancelled.
false (default)	Specifies that the claim of a task should not be cancelled, that is, a transfer is prohibited.

Request Content

Optional list of human tasks to be transferred. This request message body is mutually exclusive with the taskID parameter.

The default content-type is application/json.

MIME Type: application/json

Schema

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

Response Content

Only present if multiple task transfers have been requested. Empty if all transfers succeed. For failed individual transfers, a report is returned.

The default content-type is application/json.

MIME Type: application/json

Schema

{  "description": "Work Basket Bulk Task 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

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	Success completion.
400 Bad Request	The parameters are not valid or they are missing.
401 Unauthorized	The caller is not authorized for this request.
404 Not Found	The task or the work basket does not exist.
406 Not Acceptable	The requested content type or content encoding is not supported.
409 Conflict	A conflict exists with the current state of the resource.
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

7.0 Feature Pack

Parent topic: Work Basket Instance Resource