REST Interface for BPEL-related Task Resources - Task Resource - PUT (Claim Next) Method

Sample method invocation

Parameters

Required Parameters

Name	Value Type	Description
action	string	Action to be performed for the specified tasks. Value Description claimNext Claim the next task, selected based on filter criteria.
query	string	The name of the query table. For predefined query tables, this is the name of the predefined query table. For composite and supplemental query tables, this is prefix.name. This parameter replaces the deprecated queryTableName parameter.
queryTableName	string	[Deprecated]

Optional Parameters

Name	Value Type	Description
queryFilter	string	A query table condition language expression that performs additional filtering on the result set. All attributes defined on the query table can be referenced. Constants are available for some attributes of predefined query tables, for example, STATE_RUNNING (for available constants, see [BPC DB Views]). If instance-based authorization is required, columns that are defined on the WORK_ITEM query table can be also referenced using the prefix 'WI.', for example, WI.REASON=REASON_POTENTIAL_OWNER.
sortAttributes	string	Comma-separated list of sort criteria applied to the list of returned task instance entities. Each list entry is in the form attribute [ASC|DESC] where ascending is the default.
everybody	boolean	Authorization option specifying that everybody work items (which is the staff verb "Everybody") are taken into account if instance-based authorization is enabled on the query table. This parameter has no default. If it is omitted then the settings of the query table definition apply.
individual	boolean	Authorization option specifying that individual work items, for example, the staff verb "Users", are considered if enabled on the query table. This parameter has no default. If it is omitted then the settings of the query table definition apply.
group	boolean	Authorization option specifying that group work items, for example, the staff verb "Group", are taken into account if instance-based authorization is enabled on the query table and if enabled on the Human Task Container. This parameter has no default. If it is omitted then the settings of the query table definition apply.
inherited	boolean	Authorization option specifying that inherited work items are considered, for instance, the administrator of a process instance might then see participating human task instances created for that process instance if it executes a query against that query table. This parameter has no default. If it is omitted then the settings of the query table definition apply.
admin	boolean	Administration authorization option specifying whether the request is performed by an administrator. Value Description true The request is performed by an administrator. The user must have administrative rights to perform this request. If the onBehalfUser parameter is specified as well then the request is performed as if the specified user had sent the request, otherwise, the request runs as administrator. false (default) The request is performed by a regular user who doesn't have administrative rights.
onBehalfUser	string	Administration authorization option specifying that the query is run under the authority of the specified user, and the objects in the query table are checked against the work items for this user if instance-based authorization is used. This parameter is only valid if the admin parameter has been specified with a value true. If admin is set true and this parameter is not used then the request runs as administrator.
maxRetryCount	integer	Maximum number of retries if a task claim does not succeed. The default value for this parameter is 3.

Request Content

None

Response Content

The default content-type is application/xml.

MIME Type: application/xml

<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema targetNamespace="http://www.ibm.com/xmlns/prod/websphere/bpm/rest/htm/v1/claimResult" 
   xmlns="http://www.ibm.com/xmlns/prod/websphere/bpm/rest/htm/v1/claimResult" 
   xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
   elementFormDefault="qualified" 
   attributeFormDefault="unqualified">
   <!--
      Claim Result
   -->
   <xsd:element name="claimResult" type="tClaimResult"/>
   <xsd:complexType name="tClaimResult">
      <xsd:sequence>
         <xsd:element name="tkiid" type="xsd:string"/>
         <xsd:any namespace="##other" processContents="lax" minOccurs="0"/>
      </xsd:sequence>
   </xsd:complexType>
</xsd:schema>

MIME Type: application/json

Error Response Content

The default content-type is application/json.

MIME Type: application/json

{  "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.
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.
500 Internal Server Error	A severe problem has occurred. Programmer's details are provided.

Available since

7.0

Parent topic: Task Resource