Run Report Method

You can view run reports for models by hitting the run report endpoint and passing a modelName parameter. There are other filter parameters that can be used to restrict the results and just return what you need. You can filter by date range with the from and to parameters. The date format is YYYY-MM-DD, with optional HH:MM:SS. The numResults parameter restricts the number of results returned. Results are ordered by most recent first. You can also use the runType parameter to only show directed test runs or automatic runs by using the directed or auto value.

Method

POST -> http://localhost/api/run/report

Headers

Name Value
Authorization bearer <access_token>
Content-Type application/x-www-form-urlencoded

Body Parameters

Name Type Required
modelName Text Yes
numResults Integer No
from Date No
to Date No
runType Text No

Possible Responses

Status Status Text Description
200 OK  
401 Unauthorized The access token was not valid
403 Forbidden The current user doesn't have access to that model

Response Body JSON

Typical successful response from the run report endpoint:

{

"rows": [

{

"id": 674,

"hierarchyid": 4159,

"testname": "BBCSport",

"status": "PASSED",

"starttime": "2018-05-24 10:40:06",

"endtime": "2018-05-24 10:40:09",

"seed": 301211,

"coverage": "1",

"logfile": "logs\\BBCSport_301211_20180524094005.log",

"events": [

{

"state": "Initial",

"action": "Open Chrome"

},

{

"state": "Browser open",

"action": "Navigate to BBC Sport Website"

},

{

"state": "BBC Sport Home Pages",

"action": "Football"

},

{

"state": "football page",

"action": "Rotate"

},

{

"state": "football page",

"action": "View league tables"

},

{

"state": "Tables page",

"action": "Check for united"

},

{

"state": "Finish",

"action": "Action7"

}

],

"failevents": [],

"runtype": "auto"

}

]

}

Name Type Description
rows Array  

id

Integer Run id from test table

hierarchyid

Integer Id from hierarchy table

testname

Text Name of the model

status

Text Status of the run

starttime

Text “yyyy-MM-dd HH:mm:ss” Time the run started

endtime

Text “yyyy-MM-dd HH:mm:ss” Time the run finished

seed

Integer The seed that was generated or passed in

coverage

Text The coverage for this run

logfile

Text The file path of the log file

events

Array A list of events

state

Text State name

action

Text Action name

failevents

Array A list of failure events

state

Text State name

action

Text Action name

 

This topic was last updated on July 13, 2019, at 11:22:03 AM.

Eggplant icon Eggplantsoftware.com | Documentation Home | User Forums | Support | Copyright © 2019 Eggplant