Type a name for the REST Application.

Type an optional description for the REST Application. The description you enter here will appear in the Applications page.

Specify the Endpoint for the Application. It is the login endpoint URL to initiate communication with the SaaS provider. To get the end point, see the back end documentation available on the internet for the SaaS provider.

Every back end provides its own authentication mechanism. Get the authentication details from the back end documentation and select the supported Authentication Type from the drop-down list.

Click Browse and select another icon for the REST Application, if necessary.

Type the Resource name.

Type the path to the Resource. The Resource path is relative to the endpoint specified. Each REST Resource derives its path from the namespace of the REST Resource. For example, if the REST Resource is named myREST.myRESTResource, the path is “/myREST.myRESTResource”.

You can define dynamic parameters in the resource path by enclosing each parameter within { } brackets. For example, to get the employee data corresponding to a dynamic parameter called employeeID, specify the resource path as /employee/{employeeID}. To get item information from a particular department in a store, specify the resource path as /store/{departmentID}/{itemID}.

Select an HTTP Method.

Type an optional description for the Action.

You can set parameters that become part of the outgoing request. Parameters specify the variable parts of your resources. Click Add Parameter to add a parameter to the request. Complete the following fields:

Name - Type the parameter name.

Value - Type a value for the parameter.

Parameter Type - Select the parameter's type, which determines how the parameter should be used.

f you select an AWS authentication type, then you must add a mandatory request parameter in all the Actions you create. The parameter name must be aws.service and the parameter type must be CFG_PARAM. Type the service name in the endpoint URL as the parameter value. For example, if the endpoint URL is https://<instance>.s3.com/, type the parameter value as s3.

REST services rely on HTTP methods (GET, POST, PUT, and DELETE) to make requests to a SaaS provider. Thus the parameters are closely tied to these HTTP methods, as they are sent as part of these HTTP method requests. The parameters are part of the HTTP URI. CFG_PARAM is an internal configuration parameter.

URI_CONTEXT parameters are passed as the path component of a REST Resource URI, and the parameter names correspond to the URI path variable names specified in the {} annotation. For example, if the URI is https://api.twitter.com/1.1/users/{id}, the Resource path will be /users/{id}, the parameter type will be uriContext, the parameter name will be id, and the value could be the user id, for example, either 1, or 2, or 3.

QUERYSTRING_PARAM parameters are passed as the query component of a REST resource invocation request. For example, if the URI is https://api.twitter.com/1.1/users/show.json?screen_name=twitterdev, the resource path will be /users/show.json, screen_name is the name of the parameter, twitterdev is the value of the parameter, and the parameter type is query.

FORM_ENCODED_PARAM - Define a parameter of type FORM_ENCODED_PARAM if you want to send the parameter as part of the Request body. FORM_ENCODED_PARAM allows you to send simple key value parameters embedded in the Request body for POST or PUT requests. This uses the default web form encoding, which is application/x-www-form-urlencoded.

Required - Select this option if you want this parameter to be made mandatory while creating an Integration.

HTTP headers allow the client and the server to pass additional information with the request or the response.

Click Add Header to add a request HTTP header. In the Add Header dialog box, complete the following fields:

Name - Type the Header name.

Value - Type a value for the Header.

Required - Select this option if you want this Header to be made mandatory while creating an Integration.

In the Request Body pane, complete the following fields:

Content Type If the documentation of the SaaS provider specifies that the content type of the request body is JSON, select application/json as the content type. If the documentation of the SaaS provider specifies that the content type of the request body is XML, select application/xml as the content type. If the documentation of the SaaS provider specifies that the content type of the request body is binary, select Binary as the content type. These options allow you to control the content in an HTTP request body.

Document Type - Select a Document Type for the request body or click Create Document Type to create a new Document Type. See Creating Document Types from Scratch.

If the request payload is an array of object, then first create a document type resembling the content of the object, and then select the Array option.

In the Response Header pane, click Add Header to add a Response HTTP header.

Complete the following fields:

Name - Type the Header name.

Value - Type a value for the Header.

Required - Select this option if you want this Header to be made mandatory while creating an Integration.

In the Response Body pane, complete the following fields:

HTTP Code - Type a single HTTP status code or a code range to indicate the status of the response. Valid values are 100, 101, 102...599 or a range from 100-599.

Content Type If the documentation of the SaaS provider specifies that the content type of the response body is JSON, select application/json as the content type. If the documentation of the SaaS provider specifies that the content type of the response body is XML, select application/xml as the content type. If the documentation of the SaaS provider specifies that the content type of the response body is binary, select binary as the content type. These options allow you to control the content in an HTTP response body.

Document Type - Select a Document Type for the Response Body or click Create Document Type to create a new Document Type. See Creating Document Types from Scratch.