Table of Contents

Search

  1. Preface
  2. Welcome to Informatica Process Developer
  3. Using Guide Developer for the First Time
  4. Getting Started with Informatica Process Developer
  5. About Interfaces Service References and Local WSDL
  6. Planning Your BPEL Process
  7. Participants
  8. Implementing a BPMN Task or Event in BPEL
  9. Implementing a BPMN Gateway or Control Flow
  10. Using Variables
  11. Attachments
  12. Using Links
  13. Data Manipulation
  14. Compensation
  15. Correlation
  16. What is Correlation
  17. What is a Correlation Set
  18. Creating Message Properties and Property Aliases
  19. Adding a Correlation Set
  20. Deleting a Correlation Set
  21. Adding Correlations to an Activity
  22. Rules for Declaring and Using Correlation Sets
  23. Correlation Sets and Engine-Managed Correlation
  24. Event Handling
  25. Fault Handling
  26. Simulating and Debugging
  27. Deploying Your Processes
  28. BPEL Unit Testing
  29. Creating POJO and XQuery Custom Functions
  30. Custom Service Interactions
  31. Process Exception Management
  32. Creating Reports for Process Server and Central
  33. Business Event Processing
  34. Process Central Forms and Configuration
  35. Building a Process with a System Service
  36. Human Tasks
  37. BPEL Faults and Reports

2. Designer

2. Designer

Creating a REST-based Receive or Invoke

Creating a REST-based Receive or Invoke

In a REST-based service, you can create a start activity (receive, pick, event handler) that executes the URL request that is submitted through the address field of a Web browser or an HTTP client. You can also create an invoke activity that sends a request to a web-based service via HTTP.
The receive and invoke activities must be based on a WSDL file named
aeREST.wsdl
. The port types and partner link types for this WSDL are in the System Services tree in the
Interfaces
dialog in Participants view.
In essence, the WSDL defines the
RequestResponse
operation and messages for receiving and sending REST requests. Process Developer converts an incoming REST request to a WSDL message and does the reverse for an outgoing request.
A request that targets a REST-based process looks like the following example:
http://localhost:8080/active-bpel/services/REST/lookUpWeather/mass/waltham
REST Request Message
Process Server converts the request to an input message that would have the following parts, shown in the example:
RestRequest example
(Not all elements are shown. See the table below):
<?xml version="1.0" encoding="UTF-8"?> <ns2:RESTRequest xmlns:ns2="http://schemas.activebpel.org /REST/2007/12/01/aeREST.xsd"> <ns2:subdomain>Search</ns2:subdomain> <ns2:method>GET</ns2:method> <ns2:pathInfo>V1</ns2:pathInfo> <ns2:params> <ns2:param name="temp" value="50"/> <ns2:param name="windchill" value="40"/> </ns2:params> <ns2:payload contentType="text/xml">lookUpWeather/mass/waltham?temp=50&windchill=40</ns2:payload> </ns2:RESTRequest>
The message parts are defined as follows:
subdomain
Optional for partner service (invoke). The part that identifies one of the REST-based services that a domain can offer. For example Yahoo offers search, news, and other services. You can use the subdomain part to specify the service you want to use. In the endpoint reference for the partner link, you can add a logical subdomain value that can be replaced by the subdomain specified:
<WS-Address>nnnn.yahooapis.com</WS-Address>
.
method
The HTTP method to execute. See the
HTTP Methods
table below.
pathInfo
Optional for partner service (invoke). Parts that extends the resource details defined in WS-Address. For example, in
search.yahooapis.com
, you can specify the path info for the search service, version number, and specific type of search:
NewsSearchService/V1/newsSearch
params
(Optional) Query parameters specified by the REST service you want to address.
headers
(Optional). HTTP headers containing connection, host, content type and other request details.
payload
(Optional) The representation of the resource. This data can be character data or XML data. If it is character data, you should include the
contentType
attribute.
queryString
(Optional) The string shown as it is formatted in the request. Contains parameters in the order they are specified.
authType
(Optional) Value populated for inbound requests (receives). This value is equivalent to the value returned by
getAuthType()
method in
javax.servlet.ServletRequest
.
The value can be one of the following: BASIC, FORM, CLIENT_CERT or DIGEST
ssl
(Optional) Boolean. True if the request is sent as https.
contextPath
(Optional) The application called in the request.
requestURI
(Optional) The location of the service where the request is made.
locales
(Optional). The ISO 639 Codes for country and languages. For example,
<locale country="US" lang="en">en_US </locale>
HTTP Methods:
HTTP defines eight methods indicating the action to be performed on the resource.
HEAD
Asks for the response identical to the one that would correspond to a GET request, but without the response body. This is useful for retrieving meta-information written in response headers, without having to transport the entire content.
GET
Requests a representation of the specified resource
POST
Submits data to be processed (for example, from an HTML form) to the identified resource. The data is included in the body of the request. This can result in the creation of a new resource or the updates of existing resources or both.
PUT
Uploads a representation of the specified resource
DELETE
Deletes the specific resource.
TRACE
(Not supported for receives) Echoes back the received request so that a client can see what intermediate servers are adding or changing in the request.
OPTIONS
Returns the HTTP methods the server supports. This can be used to check the functionality of a web server.
CONNECT
(CURRENTLY NOT SUPPORTED) Converts the request connection to a transparent TCP/IP tunnel, usually to facilitate SSL-encrypted communication (HTTPS) through an unencrypted HTTP proxy.
REST Response Message
The REST response message contains the parts shown below.
If you generate sample data for the response, be sure to change the
statusCode
attribute to a valid HTTP Status Code. The standard response for a successful HTTP requests is
200
. The generated integer,
"1",
results in a fault being thrown.
<rest:RESTResponse xmlns:rest="http://schemas.activebpel.org/REST/2007/12/01/aeREST.xsd" statusCode="1"> <!--Optional:--> <rest:headers> <!--Optional:--> <rest:header name="string" value="string"/> </rest:headers> <!--Optional:--> <rest:payload contentType="string"> <!-- Payload information --> </rest:payload> </rest:RESTResponse>
If
rest:payload
is not qualified, it does not inherit the
aeRest.xsd
namespace as it did in Process Developer versions prior to 9.2. If you had relied on this inheritance, your XPath expressions may no longer work until you update your process.
REST Fault Message
A sample REST fault looks like the following:
<rest:RESTFault xmlns:rest="http://schemas.activebpel.org/REST/2007/12/01/aeREST.xsd" errorType="transport"> <rest:errorCode>400</rest:errorCode> <rest:message>Bad Request</rest:message> <rest:messageDetails>The request cannot be fulfilled due to bad syntax</rest:messageDetails> </rest:RESTFault>
  • The
    errorType
    , defined in the above sample as
    transport
    , can be either
    transport
    or
    system
    .
  • The
    errorCode
    must be a HTTP Status Code, defined in the above sample as a
    400
    error.


Updated March 30, 2020