Property

Description

URL

URL of the REST API.

Authentication Type

·         Basic

Then enter the User Id and the Password that will be used to the connect to the REST API.

·         OAuth

Then enter the following settings:

o    Token URL – The URL to retrieve the access token from.

o    Token Request Body – The request body used for access token requests.

o    Add Access Token To - The Access token retrieved from the Token URL can be added to headers, URL or request body, depending on how the REST endpoint needs the token.

§  Request Header - A header is automatically added to the REST API request.

§  Request URL - The URL needs to be manually parameterised with a {access_token} parameter, before calling the REST API, the parameter is replaced with the actual token.

§  Request Body - The Request Body needs to be manually parameterised with a {access_token} parameter, before calling the REST API, the parameter is replaced with the actual token.

HTTP Method

Select the HTTP Method to map any of the following operations to HTTP requests

·         GET – retrieve information

·         POST – create or update an entity

·         PUT – replace an existing entity

·         DELETE – remove a request

Content Type

The required Content Type. Default is application/x-www-form-urlencoded

Timeout

The length of time to wait for the server response (10 to 300). Default is 10.

Request Body

The Request Body for the HTTP POST.