Creating REST Consumer

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

Steps to create REST Consumer activity

1. Click Configure > WEB SERVICES > REST Consumer.

2. Click Create REST Consumer. 

3. On the Create New REST Consumer window, provide a name for REST Consumer. 
   
   

   
   
   
   

4. Enter the Endpoint URL of the REST web service in the Specify destination URL box. For example: http://example.com/post/ or http://example.com/script.php?method=post_data&cust=123.

5.  Select the HTTP method from the drop-down list of Select HTTP method. You can select any of the following methods depending on what the application API supports:
   
   

   • Get

   • Put

   • Post

   • Patch

   • Delete
     
     
     

6. Click Add and enter the header parameters if needed by the target application.

   REST APIs use the HTTP standard. Therefore, any REST call headers are in fact HTTP headers. They define the operating parameters of the transaction, the so-called metadata. It is considered the bad practice to transmit actual data as a header field. Ideally, since each endpoint represents a state transfer, custom headers should only be used for things that do not involve the name of the resource (should be passed in the URL), the state of the resource (should be passed in the body), or parameters directly affecting the resource (should be passed as URL parameters). That leaves only true metadata about the request in custom headers.

7. Select Post Data as Attachment if you want the data to be transferred as an attachment. Else, the data is included in-line in the URL request.

8. Select a security policy from the Security Policy drop-down list.

9. Select the project from the Select Project drop-down list.

10. Click Save.