Oracle Cloud Infrastructure Documentation

Configuring the HTTP method, URL, and URL Parameters

Specify the HTTP method and URL of the REST request to execute, and configure any URL parameters for the REST task.

The following procedures can also be used when entering (or editing) the optional polling URL and termination URL.

The method is a standard HTTP method such as GET or POST. The URL is the REST API endpoint to the resource to access in the REST request.

For example, the following REST endpoint lists the data assets in the workspace ID finance123:

http://myserver.com:8081/workspaces/finance123/dataAssets

The URL can include parameters by using the syntax ${}. For example, the following REST endpoint lists the data assets in a workspace by using parameter syntax for the variable sections of the URL that specify the server host and the workspace ID.

http://${myserver}:8081/workspaces/${workspaceId}/dataAssets

When you specify parts of the URL using parameter syntax, those parts are converted into String URL parameters for the REST task. A default value must be assigned to each URL parameter.

When the task is run, you can change the values of those URL parameters. For example, at runtime you can supply different values for the server and the workspace ID.

The following procedure can also be used to enter (or edit) the optional polling URL and termination URL.

To configure the HTTP method and URL:

On the Define execution details step of the Configure REST API Details page, under HTTP method, select the HTTP method to use for the URL of this REST task.

To configure the optional polling URL and termination URL, go to the Specify completion criteria step, click the Polling or Termination tab and select the HTTP method. Note that the Polling and Termination tabs appear only when the Configure a polling and termination condition for a no-wait REST call checkbox is selected.
In the URL field, enter the complete URL and then press Enter.
If ${} parameter syntax is used for parts of the URL, those parts are converted into URL parameters for the REST task.
The table in the URL parameters tab below the URL field is updated with the parameterized parts. The default data type for each URL parameter is String.
To assign a default value to each URL parameter, see Configuring URL Parameters. You can change the data type, and add a description to each parameter.
If you edit the URL at any time by adding or removing parameter syntax, the URL parameters table is updated accordingly.

Configuring URL Parameters