REST Interface for BPEL-related Task Resources - Task Instance Resource - PUT (Suspend and Cancel Claim) Method

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.

Sample method invocation

PUT /rest/bpm/htm/v1/task/{tkiid}?action={string}&keepTaskData={boolean}[&deadline={string}][&duration={string}]

Parameters

Required Parameters

Name

Value Type

Description

action

string

Action to be performed for the specified task.

Value	Description
suspendAndCancelClaim	Suspend a task and cancel the claim when the task is automatically resumed.

keepTaskData

boolean

Specifies whether saved task data is to be kept.

Value	Description
true	Saved task data is kept.
false	Saved task data is discarded.

Optional Parameters

Name	Value Type	Description
deadline	string	Deadline (for example 2008-10-10T12:00:00) in ISO 8601 format - either a deadline or a duration must be specified.
duration	string	Duration (for example P14D) in ISO 8601 format - either a deadline or a duration must be specified.

Request Content

None

Response Content

None

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 does not exist.
409 Conflict	A conflict exists with the current state of the resource.
500 Internal Server Error	A severe problem has occurred. Programmer's details are provided.

Available since

7.5

Parent topic: Task Instance Resource