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

Name
Type
Description

X-TOKEN-HASH

string

X-TOKEN-NAME

string

X-ICE-NAME

string

X-POOL-NAME

string

Request Body

Name
Type
Description

executionData

object

Executes Avo Assure Test Suite

{
        "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"
                    }]
             }]
        }]
}

The object executionData contains the following:

Name

Data Type

Description

source

string

exectionMode

string

executionEnv

string

browserType

array

integration

object

batchInfo

array

The object integration contains the following:

Name

Data Type

Description

alm

array

qtest

array

zephyr

array

The array alm contains the following:

Name

Data Type

Description

url

string

username

string

password

string

The array qtest contains the following:

Name

Data Type

Description

url

string

username

string

password

string

qteststeps

string

The array zephyr contains the following:

Name

Data Type

Description

authtype

string

url

string

username

string

password

string

apitoken

string

The array batchInfo contains the following:

Name

Data Type

Description

testsuiteName

string

testsuiteId

string

appType

string

domainName

string

projectName

string

projectId

string

releaseId

string

cycleName

string

cycleId

string

suiteDetails

array

The array suiteDetails contains the following:

Name

Data Type

Description

condition

boolean (0 or 1)

dataparam

array

scenarioId

string

scenarioName

string

{
    "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": " "
                    }]
            }]
    }]
}

The response RespData has the following parameters:

Name

Data Type

Description

executionStatus

array

The array executionStatus contains the following:

Name

Data Type

Description

icename

string

tokenname

string

tokenValidation

string

status

string

batchInfo

array

The array batchInfo contains the following:

Name

Data Type

Description

testsuiteName

string

testsuiteId

string

executionId

string

suiteDetails

array

The array suiteDetails contains the following:

Name

Data Type

Description

scenarioname

string

scenarioid

string

overallstatus

string

EllapsedTime

string

EndTime

string

browserVersion

string

StartTime

string

browserType

string

date

string

time

string

terminatedBy

string

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.

Basic Authorization

Token Authorization

{

"authtype": "basic",

"url": “https://demoserver.com",

"username": "demo.user",

"password": "demo@123"

}

{

"authtype": "token",

"url": "https://demoserver.com",

"apitoken": “17816ebb597f9bab1fdc456b42ca63f9488f07be"

}

  • 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.

PreviousAvo Assure APIsNextReports API

Last updated

Logo