REST API end-points to Summarize Test-Run Results

Use this step-by-step guide to use REST API calls to get a summary of test results on your accelQ project.

POST Get Test Run Results with accelQ

Returns set of Result objects based on the query limiting parameters (start and end date). 
You can limit the number of results returned, by indicating the page size and page number.
For example, if pageSize = 20 and pageNum = 1, it returns the first 20 results matching the criterion.

End Point URL

Request Headers

https://<ACCELQ Server>/awb/api/<Tenant code>/<Project code>/v1/ext-access/runs

Content-Type:application/json

Request Payload

{
 "filter": {
    "from": {
       "date": "12-11-2018",
       "time": "05:24"
    },
    "to": {
       "date": "22-11-2018",
       "time": "16:20"
    }
 },
 "pageNum": 1,
 "pageSize": 20
}

Note:

• If pageNum is empty or invalid, then the first page data is returned.
• If an invalid pageSize is supplied, 100 records are returned. Maximum value you can supply is also 100.
• Both the dates should be specified in dd-mm-yyyy format. Time format is HH:MM (24-hour format). Time stamps are based on accelQ server time zone.
• If all the filter properties are empty the API returns the latest 10 test run results.

JSON paths to parse values from the above response

All the test run results are returned in an array named data. Following sample JSON paths are built for first item in the array (index = 0, data[0]).

Job PID                           $.data[0].jobPid

Purpose of run                    $.data[0].purpose 

Project name                      $.data[0].projectCode 

Test Suite name                   $.data[0].testSuiteName 

Scenario name                     $.data[0].scnName 

Total number of test cases        $.data[0].testcaseCount 

Number of test cases passed       $.data[0].pass 

Number of test cases failed       $.data[0].fail 

Number of test cases not run      $.data[0].notRun 

OS                                $.data[0].hostConfig.os 

Browser                           $.data[0].hostConfig.browser 

Execution environment name        $.data[0].hostConfig.name 

Execution host                    $.data[0].hostConfig.onPremiseHost 

Run parameters Map                $.data[0].runConfig 

Specific run parameter (say r1)   $.data[0].runConfig.r1