REST Web Services

REST web services leverage the HTTP GET, POST, PUT and DELETE methods. Content included in REST web services can be transferred using either URL encoding or content encoding.

URL

REST web services are based on the HTTP protocol. The web service call is made by issuing an HTTP request to the associated endpoint URL. Based on the request method, the endpoint URL may need to include additional parameters (such as an ID for a DELETE call). Parameters can be added to the URL using Node Tags (see Node Paths and Node Tags for more information).

HTTP Headers button

Selecting the HTTP Headers button displays the HTTP Headers dialog. Enter each header and associated value in this list. Each header name must be entered with the prefix of "http.header.". For example, if the header is "user", then the name must be "http.header.user".

Method

REST based web services are called using one of the following methods:

Method	Description
GET	This method sends an HTTP GET request to the REST web service endpoint. The GET request is used to retrieve information from the REST web service.
POST	This method sends an HTTP POST request to the REST web service endpoint. The POST request is used to submit data to the REST web service.
PUT	This method sends an HTTP PUT request to the REST web service endpoint. The PUT request is similar to the POST request and is used to submit data to the REST web service.
DELETE	This method sends an HTTP DELETE request to the REST web service endpoint. The DELETE request is used to request that data be deleted or removed. The DELETE request typically includes a URL encoded ID associated with the record or data to be deleted or removed.