Creating REST Tasks

For example, the following REST endpoint lists the data assets in the workspace that has the 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.

To configure the URL for a 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.

To configure URL parameters for the REST task:

To edit a header in a REST task:

To delete a header in a REST task:

To parameterize the header value of a header in a REST task:

To edit the default value for a parameterized header value:

Removing the header value parameter does not delete the header key-value pair.

To remove a header value parameter:

To create a request body:

To parameterize the entire request body in a REST task:

To edit the parameterized request body:

To unassign the parameter from the entire request body:

The expression for a success or polling condition can include only the functions as shown in the following section. To extract values from JSON structures, use the json_path function.

{
   "processName": "createCustomer",
   "region" : "usa-1",
   "status" : {
      "current-status": "accepted",
      "id" : "usa1h3l4ewrt0989"
}

By default, Data Integration provides a success condition for a REST task. The default success condition is an HTTP status code of 200 or greater but less than 300, written as the following expression:

SYS.RESPONSE_STATUS >= 200 AND SYS.RESPONSE_STATUS < 300

The success condition expression references output in the JSON response that is received from the REST request defined in the execution step.

You can use the default success condition, or you can write your own condition expression using system outputs or extracted JSON property values from the response.

To edit the success condition:

To parameterize the success condition in a REST task:

To edit the parameterized success condition:

To unassign the parameter from the success condition:

Create expressions that use the API response from the REST execution step. You provide a name for the expression when you create it. To include the named expression in the polling or termination URL, or the polling or success condition, use the syntax #{expression_name}.

For example, if the REST task invokes the API operation to create a project using a specific project name, the polling request can check the project key to determine whether polling continues or stops. To use the project key as a variable in the polling URL, create an expression that extracts the key from the API payload response, converting it to a value of datatype String.

To add an expression:

To edit or delete an expression:

Similar to the REST URL in the execution step, you can include parameters in the polling URL by using the syntax ${parameter_name}.

In addition, you can include named expressions using the syntax #{expression_name}. Create the expressions you need before you configure the polling URL.

To configure the polling method and URL:

The polling condition is an expression that determines whether polling stops or continues. When the expression returns false, polling stops.

Data Integration issues a polling call repeatedly at the specified polling interval until the value for the specified polling timeout is reached, or until the polling condition returns false, whichever occurs first.

To configure the polling condition:

To parameterize the polling condition in a REST task:

To edit the parameterized polling condition:

To unassign the parameter from the polling condition:

On the Termination tab, define the HTTP method and the URL to terminate the REST call.

Similar to the polling URL, you can include parameters and expressions in the termination URL by using the syntax ${parameter_name} and #{expression_name}. Create the expressions you need before you configure the termination URL.

To configure the termination method and URL:

By default, Data Integration provides a success condition for a REST task. The default success condition is an HTTP status code of 200 or greater but less than 300, written as the following expression:

SYS.RESPONSE_STATUS >= 200 AND SYS.RESPONSE_STATUS < 300

The success condition expression references output in the JSON response that is received from the REST request defined in the execution step.

You can use the default success condition, or you can write your own condition expression using system outputs or extracted JSON property values from the response.

To edit the success condition: