Page Comparison

This section explains the process of creating web service provider service for RESTful Web Service. 

Follow the steps below to create a REST Provider:

1. Click Configure > WEB SERVICES > REST Provider.

2. Click Create REST Provider. 

3. In Create REST Provider window, type the name and description of the new Web Service Provider service in the Name and Description fields respectively.
   
   
   
   

4. By default, Character Set Encoding field will display the character set encoding that you have defined at the application level. In case the character set encoding for the REST Provider that you are creating is other than the default one (UTF-8), you can change this encoding in the Character Set Encoding field. 

5. Select weather you want to publish the REST Provider as a Process Flow or a Template. 

6. Select the Asynchronous check box if you want the transaction based on this template (with REST Webhook as a source) to be asynchronous.

   Note
   This field is available only when you have published the REST Provider as a Template.

   
   

   
   

7. Select Enable SSL check box if you want the REST Provider service to offer a SSL security.

8. Select the port from the Select Port field.

   Note
   This Web Service will be published over SSL and will use SSL configuration (KeyStore, TrustStore etc) defined for this selected port in the server.xml file. In case you want to change this SSL configuration or you want to define a new port then you need to edit/add port in server.xml file. Click here to get more details.

   
   

   
   

9. Type API Version, for example, your API version can be 1.1.

10. Type the resource end path URL in the Resource End Path field. The URL can be static or dynamic.
    Static URL example: /rest/WeatherForecast
    Dynamic URL example: /rest/{ServiceName} where service name is a variable, for example, WeatherForecast.  
    The variable name in the Dynamic URL must be in the curly braces {}.  

11. Select the process flow name to trigger with the web service from the Process Flow Name field.

    Note
    This field is available only when you have published the REST Provider as a Process Flow.

    1. The selected process flow must have Context Source and Context Target activity: GET and DELETE can only have Context Target whereas PUT and POST can have both Context Source and Context Target activity.
    2. The parameterName attribute of the context source should be restRequest.
    3. The parameterName attribute of the context target should be restResponse.

12. To define the resource parameters, type the name, default value, and style of the parameters in the Name, Default Value, and Style fields.

    For the parameters that you want to pass as a part of HTTP header, select Header corresponding to the parameters in the Style field.

13. To add methods to your activity, click Add Method and do the following.
    
    

    1. Select the type of method from the Method Type field. Depending upon the selection of the method type, the content of the Presentation table appears.

       • When the REST Providers is published as a Process Flow, all the method types PUT, GET, POST, and DELETE are available.

       • When the REST Provider is published as a Template, only PUT and POST method types are available. 

    2. In the Method Parameter table, define the method parameters. Type the name, default value, and style of the parameters in the Name, Default Value, and Style fields.

       For the parameters that you want to pass as a part of HTTP header, select the Header option in the Style field. 

    3. In the Presentation table, set the Media Type as application/text, application/xml, or application/json. If you set media type as XML or json, select Request layout for the selected media type.
    4. Set the Status Code corresponding to the types.
    5. In the Response Headers table, define your own headers. Type the name and values in the Name and Value fields.
    6. Click Save.

14. Select the security policy from the Security Policy field.

    For information on how to create a Security Policy, refer to Creating Security Policy for Web Service.

    The RESTful Web Service Provider supports both basic and API authentication.

15. Expand the Advanced Properties section and select the project from the Project field.

16. Click Save.

After you have finished creating the REST Provider:

• You can see its type (Template or Process Flow) under the TYPE column on the REST Provider manage page.
• You can also publish or unpublish the REST Provider from the same page, click here for more details.
• You can add the API Documentation.