API Actions
The following are the errors that can occur while using API actions:
Request Payload Error (API)
Request body contains invalid or incomplete data.
Correct the payload structure and mandatory fields. For example: Even a small structural change needs validation.
Invalid Endpoint URL (API)
API endpoint URL is malformed or inaccessible.
Verify the endpoint URL and network connectivity
Failed to Open Local File for Key file (API)
This error occurs while working with Form Data requests in API when attempting to upload a file. The error is typically encountered when the specified file path is invalid, the file does not exist, or the file content cannot be accessed.
Verify that the file path is correct, ensure the file exists at the specified location, and confirm that the file is accessible. Update the request with the correct file path and retry the operation.
Header Name Invalid or Missing (API)
This error occurs when the request contains an invalid, missing, or unsupported header for the selected request body format (e.g., Raw, Form URL Encoded, or Form Data). As a result, the API rejects the request due to incorrect header configuration.
Verify that the request body format matches the API specification and ensure the appropriate headers (such as Content-Type) are configured correctly. Update the header values based on the selected request format and retry the request.
Authentication Failed (API)
Authentication fails when the access token used for the API request has expired or is no longer valid. As a result, the API rejects the request and returns an authentication or authorization error.
Regenerate a valid access token by re-authenticating with the API or by using the refresh token (if supported by the API). Update the token in the request and retry the operation.
Error occurred due to unexpected alert #
This error occurs when an unexpected alert or pop-up appears during execution, preventing Avo Assure from interacting with the application.
Handle or dismiss the unexpected alert before continuing execution or add appropriate alert-handling steps in the test case.
GET Request Contains Invalid Request Body (API)
This error occurs when a request body is sent with a GET request to an API that does not support request payloads for GET operations.
Remove the request body from the GET request or use the appropriate HTTP method if the API requires a payload.
No Item Matches the Given Query (API)
This error occurs when attempting to retrieve data from an API using a Path or Query expression that does not match any item in the response. As a result, Avo Assure is unable to locate the requested value.
Verify that the specified Path or Query expression is correct and matches the structure of the API response. Ensure the response contains the expected data and update the expression if the response structure has changed.
Response Body is Empty (API)
This error occurs when an API request completes successfully, but the response body contains no data. As a result, actions that expect response content cannot proceed.
Verify that the API returns data and that the request parameters, such as Query and Path parameters, are correct.
Element not found
This error occurs when the captured element cannot be found on the application screen during execution, or when the element's properties have changed, causing Avo Assure to be unable to locate or interact with it.
Verify that the target element is present on the application screen during execution. If the element has changed or cannot be identified, update its object properties in the Element Repository and recapture the element if necessary before retrying the execution.
Values does not match
This error occurs when Avo Assure compares the expected value with the actual value obtained during execution and finds that they do not match. As a result, the verification fails and returns a False status.
Verify both the expected and actual values,and ensure that the application contains the correct data before executing the verification.
Error occurred in setEndPointURL
This error occurs when an unexpected exception is raised while setting the endpoint URL.
Verify the URL value is a valid string and check the execution log for the underlying exception, then retry.
Invalid endpoint URL (ERR_INVALID_END_POINT_URL)
This error occurs when the Set Endpoint URL action is executed with an empty or null URL value.
Provide a valid, non-empty endpoint URL (including the protocol, e.g. https://) in the Input Value column before executing Set Endpoint URL.
Invalid operation (ERR_INVALID_OPERATION)
This error occurs when the Set Operations action receives an empty or null value for the operation name.
Provide a valid, non-empty operation name in the Input Value column.
Error occurred in setOperations
This error occurs when an unexpected exception is raised while setting the operation.
Verify the operation name and check the execution log for the underlying exception.
Invalid method (ERR_INVALID_METHOD)
This error occurs for multiple actions: when Set Methods receives an empty value or a method name that is not one of the supported HTTP methods (GET, POST, PUT, DELETE, HEAD, PATCH), or when Execute Request is called without a valid method set.
Provide one of the supported HTTP methods — GET, POST, PUT, DELETE, HEAD, or PATCH — using the Set Methods action before calling Execute Request.
Error occurred in setMethods
This error occurs when an unexpected exception is raised while setting the HTTP method.
Verify the method value and check the execution log for the underlying exception.
Invalid header (ERR_INVALID_HEADER)
This error occurs for multiple actions: when Set Header receives invalid or malformed header content that cannot be parsed.
Provide a valid header in the expected format (e.g. key:value pairs separated by ## or newlines) and verify the content is not empty.
Error occurred in setHeader / setHeaderTemplate
This error occurs when an unexpected exception is raised while setting the request header or header template.
Verify the header value format and check the execution log for the underlying exception.
Invalid input: Whole Body is invalid or missing.
This error occurs when the Set Whole Body action receives an empty or null body value.
Provide a valid, non-empty request body in the Input Value column (JSON, XML, or key=value pairs as supported by the keyword).
Error occurred in setWholeBody
This error occurs when an unexpected exception is raised while setting the request body.
Verify the body content is a valid string and check the execution log for the underlying exception.
Invalid input: Invalid Request Parameters (ERR_SET_PARAMS)
This error occurs for multiple actions: when Set Param Value or Set Param receives empty or null values for the parameter key or value.
Provide valid, non-empty key and value inputs for the parameter. For Set Param, ensure the input follows the expected format (key=value pairs separated by ## or newlines).
Error occurred in setParamValue / setParams
This error occurs when an unexpected exception is raised while setting request parameters.
Verify the parameter inputs and check the execution log for the underlying exception.
Invalid Input (Execute Request / SOAP response)
This error occurs for multiple actions: when Execute Request finds the response is null or False after execution (the request could not be sent or a response could not be obtained), or when the SOAP response cannot be saved — for example, the endpoint or operation is not set correctly.
Verify that Set Endpoint URL, Set Methods, and Set Header have all been executed successfully before calling Execute Request. Check network connectivity and the endpoint URL.
Exception during request execution (raw exception text)
This error occurs when an unexpected exception is raised while executing the HTTP request — for example, a network error, SSL failure, connection timeout, or authentication error. The raw exception message is printed to the Client console.
Verify network connectivity, SSL certificate validity, proxy settings, and that all mandatory setup steps (endpoint, method, header, body) are correctly configured. Check the execution log for the full exception.
Error occurred in getHeader
This error occurs when an unexpected exception is raised while retrieving the response header in the Get Header action.
Verify Execute Request ran successfully and a valid response was received before calling Get Header. Check the execution log for the underlying exception.
Invalid input (Get Body)
This error occurs when the Get Body action receives input that does not match the expected format for extracting content between start and end tags.
Provide valid start and end tag/delimiter values. For full body retrieval, leave the input empty or use the keyword with no tag arguments.
Error occurred in getBody
This error occurs when an unexpected exception is raised while retrieving or parsing the response body.
Verify Execute Request ran successfully, a valid response was received, and the tag values are correct. Check the execution log for the underlying exception.
Request body is empty (ERR_SET_TAG_VALUE)
This error occurs for multiple actions: when Set Tag Value or Set Tag Attribute is executed but no request body has been set — Set Whole Body or a template has not been called successfully beforehand, or the body is empty.
Execute Set Whole Body or load a request template before using Set Tag Value or Set Tag Attribute.
Invalid Input (Set Tag Value / Set Tag Attribute — invalid path)
This error occurs when Set Tag Value or Set Tag Attribute receives an empty element path or attribute name, so the XML tag cannot be located.
Provide a valid element path and, for Set Tag Attribute, a valid attribute name in the input.
Error occurred in setTagValue / setTagAttribute
This error occurs when an unexpected exception is raised while modifying the XML tag value or attribute in the request body.
Verify the request body is valid XML and the element path is correct. Check the execution log for the underlying exception.
Invalid Input (Add Client Certificate — unsupported extension)
This error occurs when the Add Client Certificate action receives a certificate file with an extension that is not supported (.jks, .pem, .pkcs12, .pfx are supported).
Provide a certificate file with a supported extension and verify the file exists at the given path.
Invalid Input: Authentication component missing (ERR_AUTH_COMPONENT_MISSING)
This error occurs when the Add Client Certificate action is given a certificate file but the keystore password is empty or null.
Provide the correct keystore/certificate password in the input.
Invalid Input (Get Server Certificate — missing URL or path)
This error occurs when the Get Server Certificate action is called with an empty URL or an empty destination file path.
Provide a valid server URL and a writable destination file path for the downloaded certificate.
Invalid Input (Get Server Certificate — connection error)
This error occurs when the Get Server Certificate action cannot connect to the server, or an SSL protocol violation occurs while downloading the certificate (EOF in violation of protocol / network errno).
Verify the server URL is correct and reachable, the port is open, and the server supports TLS. Check firewall and proxy settings on the execution machine.
Exception downloading server certificate (raw exception)
This error occurs when an unexpected exception (other than a connection failure) is raised while downloading the server certificate.
Check the execution log for the raw exception, verify the URL and file path, and retry.
Invalid Input (Set Basic Auth / Set Bearer Token / Set API Key / Set Proxies)
This error occurs for multiple actions: when Set Basic Auth, Set Bearer Token, Set API Key, or Set Proxies receives empty or null values for one or more required inputs (username, password, token, key name, key value, or proxy URL).
Provide all required, non-empty inputs for the authentication or proxy action. For Set API Key, ensure the 'add_to' parameter is either 'header' or 'params'.
Grant type not supported (Set OAuth 2.0)
This error occurs when the Set OAuth 2.0 action receives a grant type other than 'client_credentials', which is the only supported grant type.
Use 'client_credentials' as the grant type, or contact your Avo Assure team if additional grant types are required.
Last updated