Finish Test Run

Note: See the API documentation for this endpoint for more information. For general webmate API usage, see REST API .

Finalize the given test run and mark it as successful or failed with an optional failure message.


Endpoint	`/testmgmt/testruns/{testRunId}/finish`
Method	POST
testRunId	ID of test run to finish
Body	`{"status": "unknown/failed/passed/pending_passed/pending_failed/skipped","message": "string","details": "string"}`
return schema	JSON with result (success or failure) and optional message
return example	`{"result": "success"}`

You can call the endpoint like this:

curl -X POST "https://api.webmate.io/v1/testmgmt/testruns/{testRunId}/finish" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "webmate.api-token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx=" \
-d '{"status": "enumvalue","message": "string","details": "string"}'

You need an authenticated webmateSession to call this function, read this article on how to set up and authenticate with the SDK.

Parameter
status	webmate TestRunEvaluationStatus (unknown/failed/passed/pending_passed/pending_failed/skipped)
msg (optional)	String
detail (optional)	String

1
2
3

seleniumSession.finishTestRun(status);
seleniumSession.finishTestRun(status, msg);
seleniumSession.finishTestRun(status, msg, detail);

You need an authenticated webmateSession to call this function, read this article on how to set up and authenticate with the SDK.

Parameter
status	webmate TestRunEvaluationStatus (unknown/failed/passed/pending_passed/pending_failed/skipped)
msg (optional)	String
detail (optional)	String

1
2
3

await seleniumSession.finishTestRun(status).toPromise();
await seleniumSession.finishTestRun(status, msg).toPromise();
await seleniumSession.finishTestRun(status, msg, detail).toPromise();