REST Methods

REST methods determine the HTTP method for manipulating the resources defined in the service operation. The valid values are listed and described in the following table and can all be used for provider and consumer service operations:

Term Definition

DELETE

Delete an existing resource.

GET

Retrieve a representation of a resource.

HEAD

Identical to a GET except that no message body is returned in the response.

PATCH

Update a partial resource.

POST

Create a new resource to an existing URL.

PUT

Create a new resource to a new URL, or modify an existing resource to an existing URL.

OPTIONS Method

The HTTP Options method is used to request information about the communication options available for the target resource.

In order to enable accepting the HTTP Options method the parameter called ig.OptionsEnabled needs to be set to TRUE in the IntegrationGateway.Properties file on the web server. Note that HTTP Options is only applicable for the REST Listening Connector.

Options method is only applicable for Provider REST Services.