WebSphere Process Server, Version 6.2.0.1 Operating Systems: AIX, HP-UX, Linux, Solaris, Windows, i5/OS, z/OS


Business Flow Manager REST Interface - Activity Instance Resource - PUT (Complete And Claim Successor) Method

Use this method to complete the human task associated with the specified activity instance and claim a subsequent human task.

Resource URI

PUT /v1/activity/{aiid}?{parameters}

Parameters

Required Parameters
NameValue TypeDescription
action string
Action to be performed for the specified activity.
ValueDescription
completeAndClaimSuccessor
Complete a human task associated with this activity and claim a subsequent human task.

Request Content

The output for the completed human task (optional). The XML Schema for the human task output, that is, the XML Schema type/element used for the WSDL message part definition, is referenced by the corresponding human task definition. Data defined by an XML Schema simple type is wrapped in an XML element provided by this REST interface (see Simple-Typed XML Data).

The default content-type is application/xml.

Response Content

The activity instance and template IDs, the activity name, and the input for the claimed human task. The XML Schema for the human task input, that is, the XML Schema type/element used for the WSDL message part definition, is referenced by the corresponding human task definition. Data defined by an XML Schema simple type is wrapped in an XML element provided by this REST interface (see Simple-Typed XML Data).

The default content-type is application/xml.

MIME Type: application/xml


+ View Schema
<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema targetNamespace="http://www.ibm.com/xmlns/prod/websphere/bpm/rest/bfm/v1/completeAndClaimSuccessorResult" 
   xmlns="http://www.ibm.com/xmlns/prod/websphere/bpm/rest/bfm/v1/completeAndClaimSuccessorResult" 
   xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
   elementFormDefault="qualified" 
   attributeFormDefault="unqualified">
   <!--
      BFM Complete And Claim Successor Result
   -->
   <xsd:element name="completeAndClaimSuccessorResult" type="tCompleteAndClaimSuccessorResult"/>
   <xsd:complexType name="tCompleteAndClaimSuccessorResult">
      <xsd:sequence>
         <xsd:element name="activityName" type="xsd:string"/>
         <xsd:element name="aiid" type="xsd:string"/>
         <xsd:element name="atid" type="xsd:string"/>
         <xsd:any namespace="##other" processContents="lax"/>
      </xsd:sequence>
   </xsd:complexType>
</xsd:schema>

Error Response Content

Detailed error information.

The default content-type is application/json.

MIME Type: application/json


+ View Schema
{  "description": "BFM 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 OKSuccess completion.
400 Bad RequestThe parameters are not valid or they are missing.
401 UnauthorizedThe caller is not authorized for this request.
403 Forbidden
The method is not meaningful for this kind of activity.
404 Not Found
The activity instance does not exist.
409 Conflict
The activity instance is in a wrong state for this method.
500 Internal Server ErrorA severe problem has occurred, programmer's details are provided.

Available Since

6.2

Parent Topic: Activity Instance Resource