Exposing the Web Service Operation as a REST Service

You can publish a process as a REST (Representational State Transfer) service. This is achieved by creating a catch-message (start or intermediate) event or receive-task and then configuring it to be published as a REST service. A client application can then use the BPM REST API to invoke the published REST service.

1. Open your business process in TIBCO Business Studio. You can set REST Service Details on one of the following incoming web service request activities:
   • Start None Event
   • Start Message Event
   • Intermediate Catch Message Event
   • Receive Task
2. When the implementation type for the activity is set to web service, you can select the checkbox "Publish as REST Service" from the General tab of the Properties view.
   This exposes the REST interface for the business process, and the service and module name fields are populated with the values required for invoking the REST service at runtime.
   
   

   You also see the following information on any input and output parameters that are defined for that activity:

   
   
   

   The following table describes the input parameters:

   Parameter Name	Name of parameter to use: For a user defined WSDL this is the original message partname prefixed with “In” (to avoid confusion between same named input/output parts that are of different types). For an auto-generated WSDL, the name matches the business process parameter name.
   Parameter Type:	The XSD type of the element and its namespace in the format: TypeName (namespace)

   The following table describes the output parameters. Note that the output parameters are only shown for request-reply services when there are output parameters associated with the activity or the activity has 'Reply Immediately With Process Id' option selected.

   Parameter Name	Name of parameter to use: For a user defined WSDL this is the original message partname prefixed with “Out” (to avoid confusion between same named input/output parts that are of different types). For an auto-generated WSDL, the name matches the business process parameter name..
   Parameter Type:	The XSD type of the element and its namespace in the format: TypeName (namespace)