Telephone number 530-820-3390 530-820-3390 Support Support

Documentation

You are viewing Version 7 documentation. Looking for Version 6? Click Here »

Get Response Header Data: RES_HEADER_DATA

The Get Response Header Data action retrieves specific header values from the response of a  API request. This allows automation to extract and use key response metadata, such as content type, authentication tokens, or cache control information, in subsequent steps.

Example: You want to verify that an API response is returned as JSON by extracting and validating the Content-Type header.

Steps to Configure:

  1. Choose RES_HEADER_DATA from the Action dropdown.
  2. Leave the Screen Name field blank (this command does not require a screen name).
  3. In the Element Key field, enter the variable name where the extracted header value will be stored (e.g., ResponseContentType).
  4. In the Parameters section, specify the name of the response header to retrieve (e.g., Content-Type).
  5. Click Save.
Note: While the steps for adding an action command are identical in both views, the display of the steps changes:
v7_api_automation_res_header_data_list_view
List View
v7_api_automation_res_header_data_grid_view
Grid View

Expected Outcome on execution:

  • The automation extracts the value of the Content-Type header from the API response and stores it in the ResponseContentType variable.
  • This variable can be referenced in later steps using the syntax ${VariableName} (e.g., ${ResponseContentType}) for validation or conditional logic.
Notes:

  • Ensure the API request has been executed before using this action to retrieve response headers.
  • The retrieved header value can be used in assertions or subsequent API calls for dynamic processing.

Last updated: Oct 8, 2025
Back To Top