Viewing and Managing Parameters in a REST Task
Parameters can be included in different parts of a REST task.
The parts of a REST task that can be parameterized are as follows:
- One or more sections of the REST execution URL, polling URL, or termination URL. In Data Integration, the parameterized variable sections of the URL are known as URL parameters. See Configuring the HTTP method, URL, and URL Parameters.
- The value of a header in the request. See Parameterizing a Header Value.
- The entire request body in a POST or PUT request. See Parameterizing the Request Body.
- The success condition that determines the criteria for a successful completion of the REST call. See Parameterizing the Success Condition.
- The polling condition (written on the response that's returned from the polling request) that determines whether polling stops or continues. See Parameterizing the Polling Condition.
When a part of a REST task is parameterized, the parameter is defined and used in the scope of that one task only.
View and manage all the parameters that are added in the scope of one REST task, including those that are added but not being used in the task.
Open the REST task to see a list of the parameters created and assigned in the task. Unassigned parameters are also available in the list.
-
In the tasks list, select View details from the Actions menu (
) of a task.
You can add scalar, JSON, and expression parameters in the scope of a REST task, for referencing in parameterized elements within the same REST task.
- Open the project or folder that has the task you want to edit.
- On the project or folder details page, click Tasks.
-
In the tasks list, select View details from the Actions menu () of a task.
- In the Parameters section of the REST task page, click Configure.
- On the REST task parameters page, click Add parameter and select the type of parameter to add.
-
In the Add parameter
panel, you can define the following parameter
types.
- Scalar: Add a conventional name-value pair parameter. Specify a unique identifier, the data type, and the default value.
- JSON: Add a JSON data type parameter. Specify a unique identifier, and a valid JSON as the value.
- Expression: Add an expression type parameter. Specify a unique identifier, then use the condition builder to write the expression.
- Click Add.
- Click Done on the REST task parameters page.
You can edit the description, data type, and value of a parameter.
-
In the tasks list, select View details from the Actions menu () of a task.
-
On the REST task parameters page, select Edit from the Actions menu () of the parameter you want to edit.
You can delete a parameter only if the parameter is not in use in the REST task.
The Used in column on the REST Task Parameters page indicates where a parameter is being used in the task.
-
In the tasks list, select View details from the Actions menu () of a task.
-
On the REST task parameters page, select Delete from the Actions menu () of the parameter you want to delete.
If the parameter is in use in the REST task, the delete action is not available.