API ReferenceDocumentationCommunityAcademyPlatform
API Reference

Get test-run details

get
https://{tenant}.katalon.io/v2/schedules/test-runs/

Returns a test run. Use the id you got when you started the run, without
startTime.

  • stage is where the run is in its lifecycle, for example NOT_STARTED,
    RUNNING, COMPLETED or CANCELLED.
  • status is the outcome, for example PASSED, FAILED or INCOMPLETE.

A 200 response does not mean the tests passed. Treat a run as passed only
when stage is COMPLETED, status is PASSED and numberOfTestCases is
greater than 0.

With startTime, {id} is read as a scheduler ID and the response
describes that future occurrence.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

Test-run ID, or scheduler ID when resolving an occurrence with startTime.

Query Params
date-time

Scheduled occurrence timestamp; pair with the scheduler ID for an occurrence.

includeFields
array of strings

Optional comma-separated field selectors.

includeFields
Headers
uuid

Account UUID. Optional; send it to select the account explicitly.

int64

Organization ID. Optional; send it to select the organization explicitly.

int64
required

Project ID. Required on every request; without it the request returns 400.

Responses

400

The request is invalid. No response-body schema is asserted.

401

Authentication is missing or invalid. No response-body schema is asserted.

403

The API key does not have permission for this project or resource, or the ID is of the wrong type.

404

The resource does not exist in this project.

default

Any other error.

Updated about 13 hours ago

Did this page help you?
Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated about 13 hours ago

Did this page help you?