Output Handling Parameters for REST API

Enables you to specify the JsonPath manually.

Relevant only when you select Content Type JSON.

Enables you to specify the XML path manually.

Relevant only when you select Content Type XML.

Defines the relationship between response elements to analyze.

Valid values:

• And
• Or

Relevant for JSON or XML only.

If you select Other, the valid values are:

• Output line starts with
• Output line contains
• Output line ends with
• Output line matches regular expression
• Output does not contain

Defines the action for the Response parameters.

Relevant for JSON and XML Content-Type.

Valid values:

• Fail the job
• Keep the value in the runtime parameter
• Keep value of related element
• Save content to file
• Complete and fail (Verification operation completion only)
• Complete and proceed (Verification operation completion only)

Defines what happens the when the job fails.

Enables you to save the extracted value for future use.

Relevant for JSON and XML Content-Type.

Enables you to keep the value of the element on the same level or child element in the XML response.

Relevant for JSON and XML Content-Type.

Enables you to save the output to a file.

You must type the file name and you can change the default extension. Click the Append date and time field to avoid overriding the file per execution.

Defines the name of the Runtime parameter where the full path of the file response content is saved to.

You can use this Runtime parameter to appear in the Designer area for the end user or in following operations, such as copying the file to a specific location.

NOTE: You can use the Runtime Parameter with the same name in in other steps, but it appears only once in Runtime Parameters in the Designer area.

Defines the response element name to analyze which includes sibling and child to extract.

Relevant for HEADER only.

Enables you to select one of the output options from the drop-down list. You can add parameters where required.

Relevant for HEADER only.

Defines the action for the Response parameters. Valid values:

• Fail the job
• Extract and Handle data
• Save content to file

Extracts data from one of the following:

• Whole line
• Match Regular Expression
• Part of the line
• Columnar data

For more information, see Examples: Extracting Data.

Extracts data from the whole line.

Enables you to match the expression by typing a pattern in the Pattern field.

You can view the text in the Preview line. You can change the preview text by clicking .

Enables you to extract data from the start or end of a line by selecting from the drop-down lists the start and end positions of the text. You need to complete the X box to define the text.

You can also do the following:

• Trim extracted data if it has preceding or trailing white spaces by clicking the checkbox.
• Preview the text in the Preview line. You can change the preview text by clicking .

Enables you to extract Column data, when the output is column based, such as CSV format or SQL output format, by completing the following:

• Column Separator/s: Selects a separator for the column
• Column number: Defines the column number where you want to extract

Select the checkbox to Remove blanks (trim)

Defines the name of the Runtime parameter where the extracted data belongs. Appears in Runtime Parameters in the Designer area.