SendMessage |
The SendMessage method is used to send a message to any process instance waiting on the Receive Message event. This method is part of the Process Execution 4.2 interface with the namespace 'http://schemas.cordys.com/bpm/execution/1.0'.
SOAP Request
<SOAP:Envelope xmlns:SOAP=http://schemas.xmlsoap.org/soap/envelope/
"http://schemas.xmlsoap.org/soap/envelope/">
<SOAP:Header/>
<SOAP:Body>
<ns:SendMessage>
<ns:receiver>e50664cc-7f80-4157-bcd5-0ff9d797141b</ns:receiver>
<ns:message overwrite="false">
<employee xmlns="http://schemas.cordys.com/default"><id>109</id><title>Sales Representative</title></employee>
</ns:message>
</ns:SendMessage>
</SOAP:Body>
</SOAP:Envelope>
Request Parameters
Parameter |
Description |
Mandatory |
Accepted Input values |
|---|---|---|---|
receiver |
ID of the process instance, which is waiting on the Receive Message event |
Yes |
|
message |
Message to be supplied to the business process instance. The message must contain valid XML. |
Yes |
|
| message @overwrite | Option to overwrite the most recently added message in the receive message queue. Refer to the Message Mode section of Receive Message event for more information. | No |
|
SOAP Response
<data>
<SendMessageResponse xmlns="http://schemas.cordys.com/bpm/execution/1.0">
<data>
<instance_id>e50664cc-7f80-4157-bcd5-0ff9d797141b</instance_id>
<PAGEFLOWDATA/>
</data>
</SendMessageResponse>
</data>
Response Parameters
Parameter |
Description |
|---|---|
instance_id |
Process instance ID |
PAGEFLOWDATA |
Message returned from the business process of type Page Flow. |