@Web Service List
Last updated
Avo Assure - User Guide
Last updated
Description: This keyword or action instructs the Avo Assure Client to set the end-point URL for the web services.
Keyword | Input Syntax | Output Syntax | Supported Input Formats |
setEndPointURL | <EndPoint URL> | {optional} |
|
Find the snippet of the keyword below:
In the above example, after the test case debug, Avo Assure sets the value provided in the input field as the EndPoint URL of the Web Services Request.
Description: This keyword or action instructs Avo Assure Client to set the method for the web service execution. This step is part of the web service request process.
Keyword | Input Syntax | Output Syntax | Supported Input Formats |
setMethods | <Method Name> | {optional} |
|
Note: “setMethods” sets one of the below methods to the immediately above End point URL. The methods supported are:
GET
POST
HEAD
PUT
DELETE
All method types should be in uppercase.
Find the snippet of the keyword below:
In the above example, after the test case debug, Avo Assure sets the value provided in input as the method of the Web Service Request.
Description: This keyword or action instructs Avo Assure Client to select the operation mentioned for the web service execution. This step is part of the web service request process.
Keyword | Input Syntax | Output Syntax | Supported Input Formats |
setOperations | <Operation Name> | {optional} |
|
Find the snippet of the keyword below:
In the above example, after the test case debug, Avo Assure sets the value provided in the input field as the operation of the Web Service Request.
Description: This keyword or action instructs Avo Assure Client to set the header for the web service. This step is part of the web service request process.
Keyword | Input Syntax | Output Syntax | Supported Input Formats |
setHeader | <<Request_header>> OR <<key value pair 1>> <<key value pair 2>> … <<key value pair n>> | {optional} |
|
Find the snippet of the keyword below:
In the above example, after the test case debug, Avo Assure sets the value provided in the input field as the Header of the Web Service Request.
Description: This keyword or action instructs Avo Assure Client to populate the input field with the value of the header present in the template.
Keyword | Input Syntax | Output Syntax | Supported Input Formats |
setHeaderTemplate | <Request Header> | {optional} |
|
Find the snippet of the keyword below:
In the above example, after the test case debug, Avo Assure sets the value of the header from the template stored.
Description: This keyword or action instructs Avo Assure Client to set the body for the web service. This step is part of the web service request process.
Keyword | Input Syntax | Output Syntax | Supported Input Formats |
setWholeBody | <Entire Body Content> | {optional} |
|
Note: The prerequisite for using the keyword is that the header needs to be mandatorily set in previous steps.
Find the snippet of the keyword below:
In the above example, after the test case debug, Avo Assure sets the value provided in the input field as the body of the Web Service Request.
Description: This keyword or action instructs Avo Assure Client to execute the request based on the input in the Request steps.
Keyword | Input Syntax | Output Syntax | Supported Input Formats |
executeRequest | NA | NA | NA |
Find the snippet of the keyword below:
Avo Assure executes the Web Service Request after the test case debug for the above keyword.
Description: This keyword or action instructs Avo Assure Client to fetch the response's header after executing the request and save the result in the output variable.
Keyword | Input Syntax | Output Syntax | Supported Input Formats |
getHeader | <key> (optional) | {Header} |
|
Note: If the input column is left without entering any value, then the entire header is saved in the variable present in the output. If a key is provided as an input, then the output only stores the value of the input key.
Find the snippet of the keyword below:
In the above example, Avo Assure fetches the header value from the response after the test case debug and stores the result in the {Header} variable. If the output variable is provided for execution status, “True”/ “False” will be stored in it.
Description: This keyword or action instructs Avo Assure Client to fetch the response's body after executing the request and save the result in the output variable.
Keyword | Input Syntax | Output Syntax | Supported Input Formats |
getBody | <Start_Tag; <End_Tag> | {Body} |
|
Note: If the input column is left without entering any value, then the entire body is saved in the variable present in the output. If the start and end tags are provided, then the output only stores the string between the tags provided as input.
Find the snippet of the keyword below:
In the above example, Avo Assure fetches the body value from the response after the test case debug and stores the result in {Body} variable. If the output variable is provided for execution status, “True”/ “False” will be stored in it.
Description: This keyword or action instructs Avo Assure Client to fetch the server certificate and save the file in the specified folder.
Keyword | Input Syntax | Output Syntax | Supported Input Formats |
getServerCertificate | <URL>; <file path> | {optional} |
|
Find the snippet of the keyword below:
In the above example, Avo Assure will fetch the server certificate from the specified site after the test case debug and save it in the path provided in the input field. If the output variable is provided for execution status, “True”/ “False” will be stored in it.
Description: This keyword or action instructs Avo Assure Client to add a valid certificate file present in the folder to the target URL. Currently, JKS, PEM, PFX, and PKCS12 file types are supported.
Keyword | Input Syntax | Output Syntax | Supported Input Formats |
addClientCertificate | <client_path>; <clientKey_path>{optional};<clientKey_Pwd> [AES Encrypted] {optional}; <server_path>{optional} | {optional} |
|
Find the snippet of the keyword below:
In the above example, after the test case debugging, Avo Assure will add the client certificate, which is provided in the path, along with the client key password, which is provided in the encrypted format. If the output variable is provided for execution status, “True”/ ”False” will be stored in it.
Description: This keyword or action instructs Avo Assure Client to set the basic level of authentication of client certificate using Username and Password [AES Encrypted].
Keyword | Input Syntax | Output Syntax | Supported Input Formats |
setBasicAuth | Username; Password [AES Encrypted] | {optional} |
|
Find the snippet of the keyword below:
In the above example, after the test case debug, Avo Assure sets the value provided in the input field as the Basic Authentication of the Web Service Request.
Description: This keyword or action instructs Avo Assure Client to set the parameters for the web service. This step is part of the web service request process.
Keyword | Input Syntax | Output Syntax | Supported Input Formats |
setParam | <Parameter Content> | {optional} |
|
Note: The prerequisite for using the keyword is that the header needs to be mandatorily set in previous steps.
Find the snippet of the keyword below:
In the above example, after the test case debug, Avo Assure sets the value provided in the input field as the parameter of the Web Service Request.
Description: This keyword or action instructs Avo Assure Client to set a proxy for a session for the web service.
Keyword | Input Syntax | Output Syntax | Supported Input Formats |
setProxies | <URL>; <Username>; <Password (AES Encrypted)> | {optional} |
|
Find the snippet of the keyword below:
In the above example, Avo Assure sets a proxy for “DemoUser” after the test case debugging with the password in the “127.0.0.1:8080” Web Service.
Description: To set the oauth2.0 authorization, use the access token URL, Client ID, Client Secret, Scope, and Grant_type as client credentials.
Keyword | Input Syntax | Output Syntax | Supported Input Formats |
setOAuth2.0 | <URL>;<Client Id>; <Client Secret>; <Scope>; <Grant_type> | Dynamic Variable |
|
How to use setOAuth2.0 Keyword:
The user has to provide the Access Token URL, Client ID, Client Secret, Scope, and grant type as Client_credentials.
The user has to provide all the inputs in the Input column.
If the user executes the keyword, the token will be generated and stored in the output variable.
Once the token is generated, the user can use the token in the request header and send the request to fetch the response body or response header.
Find the snippet of the keyword below:
