REST API parameters

The following table describes the REST API parameters. To add REST API parameters, see Defining a parameter for REST API.

Name

Parameter

URL Location

Defines the base/parameterized URL location of the REST services, excluding the specific resource context path.

EXAMPLE: https://www.googleapis.com

NOTE: In the URL Location field, the I_AI_lock appears in case authentication is used.

To change the REST API URL settings, see: Editing a REST API URL.

Method

Defines the method to be invoked. The list is retrieved according to the Options Response from the Server.

URL Request path

Defines the required path (recourse).

EXAMPLE: /language/translate/v2

NOTE: Certain paths require values for input parameters. If so click I_AI_add and add or create a parameter.

URL Parameters

Defines the URL parameters that are added to the URL address.

NOTE: Relevant for GET method. Add parameters by clicking I_AI_add or I_AI_param.

EXAMPLE: For the following REST command:

https://www.googleapis.com/language/translate/v2?key=12345&source=en&target=de&q=Hello%world

URL: https://www.googleapis.com/language/translate/v2

Parameter: key=12345&source=en&target=de&q=Hello%world

Headers

Defines any additional HTTP headers.

You can add parameters by clicking I_AI_paramand then filling in the Key and Value fields.

Body

Defines any text required in the request body.

You can add parameters by clicking I_AI_add or I_AI_param.

Parent Topic

REST API operation steps