Defining a REST API Output Rule

This procedure describes how to define a REST API output rule.

Begin

1. In the Output Handling area, click .

   The Output Handling window appears.

2. In the When response is field, from the dropdown list select the response options, as described in Output Handling Response Options.

3. In the Extract from field from the dropdown list, select one of the following options from where you want to extract:

   • Header

   • Body

4. (Body only) In the Content-Type field select one of the following content formats:

   • JSON

   • XML

   • OTHER (such as Test, CSV).

5. If you select JSON or XML, do the following:

   1. In the first field, from the drop-down list, select JsonPath or Xpath

   2. In the second field from the drop-down list, select the value.

   3. To add elements to analyze, in the If field do the following:

      • Click and repeat steps a and b.

      • Define the relationship between the output element rules, by selecting And or OR.

6. If you select Other, in the If field do the following:

   • In the first field, from the dropdown list select where you want to extract.

   • In the second field from the dropdown list type the required value and add parameters by clicking .

   For an example of JSONpath and Xpath, see JSONpath and Xpath Example.

7. In the Do field, from the drop-down list complete the Output Handling Parameters for REST API.

   In the Do field, if you select either Keep value of related element or keep value in Runtime Parameter you can add it to Runtime Parameters in the Designer area, as described in Runtime Parameters View.

8. To add more Do actions, click and repeat the previous.

9. Click OK.