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 - Process Resource - POST (Call) Method

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

Resource URI

POST /v1/process?{parameters}

Parameters

Required Parameters
NameValue TypeDescription
action string
Action to be performed for the process instance.
ValueDescription
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 XML Schema for the operation's input, that is, the XML Schema type/element used for the WSDL message part definition, is defined as part of the custom process template definition.

The default content-type is application/xml.

Response Content

The returned response depends on the outcome of the called operation.

MIME Type: application/xml

(1) The operation's output. The XML Schema for the operation's output, that is, the XML Schema type/element used for the WSDL message part definition, is defined as part of the custom process template 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).

MIME Type: application/xml

(2) The operation's fault. An XML wrapper element is returned containing the WSDL fault name and the fault data. The XML Schema for the operation's fault, that is, the XML Schema type/element used for the WSDL message part definition, is defined as part of the custom process template 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).


+ View 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">
   <!--
      BFM 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>

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 OK
The operation has been called on the process, and output or fault data has been returned.
400 Bad RequestThe parameters are not valid or they are missing.
401 UnauthorizedThe caller is not authorized for this request.
409 Conflict
The specified process template may be in a stopped state.
500 Internal Server ErrorA severe problem has occurred, programmer's details are provided.

Available Since

6.2

Parent Topic: Process Resource