Retrieving HTTP response details with a Web Service Consumer (REST)

You can configure a Web Service Consumer (REST) to retrieve response code and response message information. This is done using two new properties that can then be called from the Get Property Business Process task.  The properties are:

CICWebServiceResponseStatusCode: This is the Response Code.

CICWebServiceResponseReasonPhrase: This is the Response Message.

How it works

1. In your Business Process, define a variable for the WS Consumer's response header.
2. In the WS Consumer, configure the Response Header parameter with the same variable.
3. In the Business Process, use the GetProperty BP task to retrieve the Status Code and Status Message from the WS Consumer response header.  Use the variable name for the Properties, and the response code (status code) or response message (reason phrase) for the Property Name.

Get Property uses three parameters:

1. Response Header variable name.
2. Property name you want to retrieve (in this case "CICWebServiceResponseStatusCode" or "CICWebServiceResponseReasonPhrase").
3. The variable name where you want to save the value of the Status Code or Reason Phrase.

(Below: Parameters for the Web Service Consumer)

(Below: Parameters for GetProperty - response status)

(Below: Parameters for GetProperty - response message)