The following table describes the Text Box with Load parameters for REST API. To import a REST API URL, see Adding a REST API URL.
Parameter |
Description |
---|---|
REST API URL name |
Defines the name of the REST API URL. |
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, To edit the REST API Endpoint settings, see REST API authentication parameters. |
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: Some paths require values for input parameters. If so, click |
URL Parameters |
Defines the URL parameters that are added to the URL address. NOTE: Relevant for GET method. You can add parameters by clicking 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 that are required in the following format: <name>=<value> NOTE: Separate any pair of names of values by a semi colon. You can add parameters by clicking
|
Body |
Defines any text required in the request body. You can add parameters by clicking |
Advanced Options |
|
Set Cookie |
Enables you to set a cookie. You can add specific values to a job, a CCM, or a Runtime parameter value by clicking |
Override connection timeout (default: 10 seconds) |
Limits the connection time when waiting for the REST web service to respond before disconnecting. You can add a job, a CCM, or Runtime parameter value to any field by clicking |
Override Content-Type (default: text/javascript) |
Defines a preferred HTTP header content type to be used to execute the job. You can add a job, a CCM, or a Runtime parameter value to any field by clicking |
Parent Topic |