About the Request tab

The Request tab in the Element Repository enables you to configure and execute API requests. It allows you to specify the HTTP method, endpoint URL, request parameters, and authentication details. This tab serves as the main workspace for building and validating API requests before sending them to the server.

On the Element Repository page (Home > Select Project > Design Studio > Element Repository > Request tab), you can do the following:

1. HTTP Method

   • You can select the specific HTTP operation that will be executed on the API endpoint.

   • Supported methods include: GET, POST, HEAD, PUT, and DELETE.

   • When the HTTP method is selected, Avo Assure automatically formats the request structure. For example, when you select the POST or PUT HTTP method, the Body field becomes mandatory as these methods require a request payload. However, the Body field is ignored for GET requests as they do not include a request body.

2. URL

   • This is used to enter the endpoint URL, including host, base path, and resource path.

   • Avo Assure validates whether the URL is reachable when the request is sent.

3. Operation

   • This is used to specify or select the particular operation that should be executed for the configured API request. The behavior of this field varies based on the type of service. Avo Assure supports the following service types:

     • SOAP (WSDL) Services:

       • Web Services Description Language (WSDL) is an XML based definition that describes the operations, input/output parameters, and endpoints of a SOAP web service. It defines how the service can be called and what data structures are expected and returned.

       • When a Simple Object Access Protocol (SOAP) service is imported through Import API Definition, the WSDL may contain multiple operations (e.g., Add, Subtract, etc.)

       • In such cases, the required operation type must be specified in the Operation text box. This is to ensure that Avo Assure executes the corresponding SOAP function defined in the imported WSDL, such as Add, Subtract, Multiply, or Divide. For example, if a WSDL contains a calculator service with multiple functions, the Operation determines whether the system should perform Add, Subtract, Multiply, or Divide.

     • REST (Swagger/HTTP) Services:

       • Swagger is a JSON based format used to describe RESTful APIs. It defines available endpoints, supported HTTP methods, request/response structures, and authentication details for API testing and automation.

       • REST endpoints generally represent a single resource per URL rather than multiple operations, so specifying the Operation is not required.

4. Send

   • Executes the API request immediately from the Element Repository page.

   • The request is sent with every detail defined in the Request tab (Headers, Body, Params, Authorization, and Certificate).

5. Save

   • Saves the configured API request as a reusable Webservice Element inside the selected folder in the Element Repository.

   • Saved elements can be used in Test Case steps via Webservice Actions (e.g., Send Request, Verify Status Code, Extract Value)

6. Append

   • When selected, Avo Assure overwrites existing request details (such as Headers or Params) during resend or updates.

   • This is useful when building requests incrementally or when headers must be preserved while testing multiple request variations.

7. Header

   • Defines the HTTP request headers sent by Avo Assure with the API request.

   • Each header is defined as a key–value pair, which Avo Assure automatically attaches to the API request during execution.

   • Common headers added during API testing include:

     • Content-Type: application/json Specifies that the request body is formatted in JSON.

     • Accept: application/json Specifies that the response from the server must be in JSON format.

   • Avo Assure sends these headers in the correct HTTP format without additional scripting.

8. Body

   • Defines the request payload when the HTTP method supports a body (e.g., POST, PUT).

   • Avo Assure supports:

     • Raw JSON payloads

     • XML request bodies

   • The defined payload is passed directly to the server, enabling validation of complex request models, authentication payloads, and nested structures.

   • The Body tab is automatically ignored for HTTP methods such as GET or DELETE, as per standard HTTP behavior.

9. Params

   • Used for adding Query Parameters or Path Parameters required by the endpoint.

   • Query Parameters: These are key-value pairs appended to the endpoint after a question mark (?). They are primarily used to filter or refine the response data. Let us consider an example of https://api.example.com/users?id=10&status=active URL. In this case, id=10 and status=active are query parameters that filter the user list based on the specified criteria.

   • Path Parameters: This is part of the endpoint URL and are used to identify specific resources. These parameters are placed directly in the path, replacing placeholders defined in the API structure. Let us consider an example of https://api.example.com/users/10 URL. Here, 10 is a path parameter representing the user ID that uniquely identifies the requested resource.

   • Avo Assure automatically appends these to the URL in the correct format (e.g., ?id=10&status=available).

   • Useful when testing filtered endpoints, search endpoints, or path variable-based REST APIs.

10. Authorization

    • Used to configure authentication for secured APIs directly within Avo Assure.

    • The platform supports the following authentication types:

      • No Auth: Used for public or unsecured endpoints.

      • Basic Auth: Username and password are encoded and sent in Authorization header.

      • OAuth 2.0: Allows configuring token based secured endpoints. Tokens generated externally can be pasted here for execution.

      • Bearer Token: The token is passed in the Authorization header using the format bearer <token> and does not require manual header creation.

      • API Key: Avo Assure allows passing the API key through the header or as a query parameter, based on the requirements of the target API.

    • Avo Assure automatically manages the authentication headers for each method, eliminating manual setup.

11. Certificate

    • Used for Secure Sockets Layer (SSL)/Mutual Transport Layer Security (MTLS) based secure APIs.

    • Avo Assure allows:

      • Uploading the certificate/keystore file path.

      • Providing Keystore Password.

      • Providing Auth Username and Auth Password if required.

    • When configured, Avo Assure attaches the certificate automatically during request execution, enabling testing of enterprise-secured or banking APIs.