REST interface for BPEL-related process resources - Process Resource - POST (Call) Method

Use this method to call an operation exposed by a process instance.

Sample method invocation

POST /rest/bpm/bfm/v1/process?action={string}&processTemplateName={string}&portType={string}&operation={string}

Parameters

Required Parameters

Name

Value Type

Description

action

string

Action to be performed for the process instance.

Value	Description
call	Call an operation exposed by a process instance.

processTemplateName

string

Process template name for the process instance exposing the called operation.

portType

string

WSDL port type containing the called operation. The parameter is a QName specified as "{namespace}localname"

operation

string

WSDL operation. The parameter is an NCName.

Request Content

Operation input.

The default content-type is application/xml.

MIME Type: application/xml

The XML Schema type/element is defined as part of the custom process definition.

MIME Type: application/json

The JSON Schema can be derived from the XML Schema type/element definition (see [JSON Format]).

Response Content

The operation's (1) output or (2) fault, depending on the outcome of the called operation.

The default content-type is application/xml.

MIME Type: application/xml

The XML Schema type/element is defined as part of the custom process definition. For fault data (2), the WSDL fault name and data is wrapped in an element defined by the API.

Schema

<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema targetNamespace="http://www.ibm.com/xmlns/prod/websphere/bpm/rest/bfm/v1/processFault" 
   xmlns="http://www.ibm.com/xmlns/prod/websphere/bpm/rest/bfm/v1/processFault" 
   xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
   elementFormDefault="qualified" 
   attributeFormDefault="unqualified">
   <!--
      Process Fault
   -->
   <xsd:element name="processFault" type="tProcessFault"/>
   <xsd:complexType name="tProcessFault">
      <xsd:sequence>
         <xsd:element name="faultName" type="xsd:QName"/>
         <xsd:element name="faultData" type="xsd:anyType" nillable="true"/>
      </xsd:sequence>
   </xsd:complexType>
</xsd:schema>

MIME Type: application/json

The JSON Schema can be derived from the XML Schema type/element definition (see [JSON Format]). For fault data (2), the WSDL fault name and data is wrapped in an element defined by the API.

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	The operation has been called on the process, and output or fault data has been returned.
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 process template does not exist.
406 Not Acceptable	The requested content type or content encoding is not supported.
409 Conflict	The specified process template might be in a stopped state.
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

6.2

Parent topic: Process Resource