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:
After entering (or editing) the URL and pressing Enter, any section in the URL that uses the parameter syntax ${}
are converted into URL parameters for the REST task.
The default data type of all newly added URL parameters is String. On the URL parameters tab, you can add default values for the REST task parameters, and also change the parameter data type, if needed.
The following procedure can also be used to edit URL parameters for the optional polling URL and termination URL.
To configure URL parameters: