Execution API
URI scheme Host: avoassure.com:8443
BasePath Schemes: HTTPS
Consumes application/json
Produces application/json
Paths POST/ExecuteTestSuite_ICE_SVN Description: Execute Avo Assure Test Suite.
ExecuteTestSuite_ICE_SVN
POST
https://avoassure.com:8443/ExecutionTestSuite_ICE_SVN
Headers
Request Body
{
"executionStatus": [{
"icename": "demouser",
"tokenname": "demotoken",
"tokenValidation": "passed",
"status": "success",
"batchInfo": [{
"testsuiteName": "Module_Web_Excel",
"testsuiteId": "5df71837d9be728cf8e7fed7",
"executionId": "60ae438ead4928bfb4c8fe2a",
"suiteDetails": [{
"scenarioname": "Scenario_Web_ExcelKeywords",
"scenarioid": "5de4e572d9cdd57f40624d85",
"overallstatus": "Pass",
"EllapsedTime": "0:02:19.102909",
"EndTime": "2021-05-26 18:20:37.108400",
"browserVersion": "NA",
"StartTime": "2021-05-26 18:18:18.005491",
"browserType": "NA",
"date": "05/26/2021",
"time": "18:20:37",
"terminatedBy": "N/A"
}]
}]
}]
}
{
"executionStatus": [{
"icename": "demouser",
"tokenname": "demotoken",
"tokenValidation": "passed",
"status": "success",
"batchInfo": [{
"testsuiteName": "Module_Web_Excel",
"testsuiteId": "5df71837d9be728cf8e7febb",
"executionId": "60ae2643ad4928bfb4c8fdda",
"suiteDetails": [{
"scenarioname": "Scenario_Excel",
"scenarioid": "5de4e572d9cdd57f40624cc7",
"overallstatus": "Fail",
"EllapsedTime": "0:00:34.340000",
"EndTime": "2021-05-26 16:14:18.674056",
"browserVersion": "NA",
"StartTime": "2021-05-26 16:13:44.334056",
"browserType": "NA",
"date": "05/26/2021",
"time": "16:14:18",
"terminatedBy": "N/A"
}]
}, {
"testsuiteName": "Module_Demo_Test",
"testsuiteId": "5df71837d9be728cf8e7feb6",
"executionId": "60ae2643ad4928bfb4c8fddb",
"suiteDetails": [{
"scenarioname": "Scenario_Demo_Test",
"scenarioid": "5de4e572d9cdd57f40624cba",
"overallstatus": "Terminate",
"EllapsedTime": "0:01:04.978000",
"EndTime": "2021-05-26 16:15:25.559056",
"browserVersion": "NA",
"StartTime": "2021-05-26 16:14:20.581056",
"browserType": "NA",
"date": "05/26/2021",
"time": "16:15:25",
"terminatedBy": "program"
}]
}, {
"testsuiteName": "M_10209",
"testsuiteId": "60a73d63ad4928bfb4c8f9fc",
"executionId": "60ae2643ad4928bfb4c8fddc",
"suiteDetails": [{
"scenarioname": "M_10209",
"scenarioid": "5ff8320a0a21341204babbc1",
"overallstatus": "Pass",
"EllapsedTime": "0:00:25.345000",
"EndTime": "2021-05-26 16:15:52.370056",
"browserVersion": "90.0.4430.212",
"StartTime": "2021-05-26 16:15:27.025056",
"browserType": "Chrome",
"date": "05/26/2021",
"time": "16:15:52",
"terminatedBy": "N/A"
}]
}]
}]
}
{
// Response
}
{
// Response
}
{
// Response
}
{
// Response
}
{
// Response
}
The object executionData
contains the following:
The object integration
contains the following:
The array alm
contains the following:
The array qtest
contains the following:
The array zephyr
contains the following:
The array batchInfo
contains the following:
The array suiteDetails
contains the following:
{
"executionData": [{
"source": " ",
"executionMode": " ",
"executionEnv": " ",
"browserType": [" "],
"integration": {
"alm": {
"url": " ",
"username": " ",
"password": " "
}
"qtest": {
"url": " ",
"username": " ",
"password": " ",
"qteststeps": " "
}
"zephyr": {
"url": " ",
"username": " ",
"password": " "
}
},
"batchInfo": [{
"testsuiteName": " ",
"testsuiteId": " ",
"appType": " ",
"domainName": " ",
"projectName": " ",
"projectId": " ",
"releaseId": " ",
"cycleName": " ",
"cycleId": " ",
"suiteDetails": [{
"condition": <integer>,
"dataparam": [" "],
"scenarioId": " ",
"scenarioName": " "
}]
}]
}]
}
{
"executionData": [{
"source": "api",
"executionMode": "serial",
"executionEnv": "default",
"browserType": ["1"],
"integration": {
"alm": {
"url": " ",
"username": " ",
"password": " "
}
"qtest": {
"url": " ",
"username": " ",
"password": " ",
"qteststeps": " "
}
"zephyr": {
"url": " ",
"username": " ",
"password": " "
}
},
"batchInfo": [{
"testsuiteName": "Module_Web_Excel",
"testsuiteId": "5df71837d9be728cf8e7fed7",
"appType": "Web",
"domainName": "Manufacturing",
"projectName": "Web",
"projectId": "5de4e4aed9cdd57f4061bca5",
"releaseId": "R1",
"cycleName": "C1",
"cycleId": "5de4e4aed9cdd57f4061c354",
"suiteDetails": [{
"condition": 0,
"dataparam": [" "],
"scenarioId": "5de4e572d9cdd57f40624d85",
"scenarioName": "Scenario_Web_ExcelKeywords"
}]
}]
}]
}
{
"executionData": [{
"source": " ",
"executionMode": " ",
"executionEnv": " ",
"browserType": [" "],
"integration": {
"alm": {
"url": " ",
"username": " ",
"password": " "
}
"qtest": {
"url": " ",
"username": " ",
"password": " ",
"qteststeps": " "
}
"zephyr": {
"url": " ",
"username": " ",
"password": " "
}
},
"batchInfo": [{
"testsuiteName": " ",
"testsuiteId": " ",
"appType": " ",
"domainName": " ",
"projectName": " ",
"projectId": " ",
"releaseId": " ",
"cycleName": " ",
"cycleId": " ",
"suiteDetails": [{
"condition": <integer>,
"dataparam": [" "],
"scenarioId": " ",
"scenarioName": " "
}]
},{
"testsuiteName": " ",
"testsuiteId": " ",
"appType": " ",
"domainName": " ",
"projectName": " ",
"projectId": " ",
"releaseId": " ",
"cycleName": " ",
"cycleId": " ",
"suiteDetails": [{
"condition": <integer>,
"dataparam": [" "],
"scenarioId": " ",
"scenarioName": " "
}]
},{
"testsuiteName": " ",
"testsuiteId": " ",
"appType": " ",
"domainName": " ",
"projectName": " ",
"projectId": " ",
"releaseId": " ",
"cycleName": " ",
"cycleId": " ",
"suiteDetails": [{
"condition": <integer>,
"dataparam": [" "],
"scenarioId": " ",
"scenarioName": " "
}]
}]
}]
}
{
"executionData": [{
"source": "api",
"executionMode": "serial",
"executionEnv": "default",
"browserType": ["1"],
"integration": {
"alm": {
"url": " ",
"username": " ",
"password": " "
}
"qtest": {
"url": " ",
"username": " ",
"password": " ",
"qteststeps": " "
}
"zephyr": {
"url": " ",
"username": " ",
"password": " "
}
},
"batchInfo": [{
"testsuiteName": "Module_Excel",
"testsuiteId": "5df71837d9be728cf8e7febb",
"appType": "Web",
"domainName": "Manufacturing",
"projectName": "Web",
"projectId": "5de4e4aed9cdd57f4061bca5",
"releaseId": "R1",
"cycleName": "C1",
"cycleId": "5de4e4aed9cdd57f4061c354",
"suiteDetails": [{
"condition": 0,
"dataparam": [" "],
"scenarioId": "5de4e572d9cdd57f40624cc7",
"scenarioName": "Scenario_Excel"
}]
},{
"testsuiteName": "Module_Demo_Test",
"testsuiteId": "5df71837d9be728cf8e7feb6",
"appType": "Web",
"domainName": "Manufacturing",
"projectName": "Web",
"projectId": "5de4e4aed9cdd57f4061bca5",
"releaseId": "R1",
"cycleName": "C1",
"cycleId": "5de4e4aed9cdd57f4061c354",
"suiteDetails": [{
"condition": 0,
"dataparam": [" "],
"scenarioId": "5de4e572d9cdd57f40624cba",
"scenarioName": "Scenario_Demo_Test"
}]
},{
"testsuiteName": "M_10209",
"testsuiteId": "60a73d63ad4928bfb4c8f9fc",
"appType": "Web",
"domainName": "Manufacturing",
"projectName": "Web",
"projectId": "5de4e4aed9cdd57f4061bca5",
"releaseId": "R1",
"cycleName": "C1",
"cycleId": "5de4e4aed9cdd57f4061c354",
"suiteDetails": [{
"condition": 0,
"dataparam": [" "],
"scenarioId": "5ff8320a0a21341204babbc1",
"scenarioName": "M_10209"
}]
}]
}]
}
The response RespData
has the following parameters:
The array executionStatus
contains the following:
The array batchInfo
contains the following:
The array suiteDetails
contains the following:
Note:
For executing and updating the status of the execution in the third party tools via the execution API, the following values must be specified (with respect to the intended integration tool):
URL
Username
Password
For Zephyr, the authorization can be performed in two ways: one as mentioned above (Basic Authorization) and the other method is by SSO Login, in which the user has to provide the URL and token (API key generated from Zephyr). To differentiate the method of login, the following formats can be followed while updating the integration section of Zephyr during execution API.
For qTest integration via API, ‘qteststeps’ value can also be passed. This value can accept Boolean values or integer forms of Boolean values.
For Git Integration, the Git details must be specified. For more information on Git Integration – Execution via API, refer here.
Last updated