API ReferenceDeveloper GuidesRecipesDocumentationCommunityAcademyPlatform
API Reference

Update a test run

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

Updates a future scheduled occurrence or a not-started manual test run. For a future
occurrence, pass its scheduler ID and startTime. For a manual test run, pass its test-
run ID without startTime; the run must have stage NOT_STARTED.

thisAndFollowing=true applies an occurrence update to that occurrence and later ones.
The body also has startTime and thisAndFollowing, but their values are replaced by
the query values. Use the query parameters to select the occurrence and its range.

Requires the TestRun:Update permission.

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 startTime selects an occurrence.

Query Params
date-time

Occurrence start time; use with a scheduler ID. Overrides the body field.

boolean

Apply the update to this occurrence and later ones. Overrides the body field.

Body Params
string
int64 | null
int64 | null
int64 | null
string | null
string
required
int64 | null
configurations
array of objects
configurations
visualTestingConfiguration
object | null
testSuiteRunConfigurations
array of objects
testSuiteRunConfigurations
adoConfiguration
object | null
schedule
object

Recurrence values for a saved schedule.

uuid | null
string | null
string | null
runConfigurationEntries
array of objects
runConfigurationEntries
boolean
privateLocalTestingConfiguration
object | null
boolean
int64 | null
customizableFields
array of objects
customizableFields
int64 | null
parallelConfiguration
object | null
string | null
int64 | null
string | null
string | null
emailReportConfiguration
object | null
almAutoPushConfiguration
object | null

For schedule updates, omission keeps the current value, null clears it, and an object
replaces it.

date-time | null

Replaced by the startTime query parameter on this operation.

boolean

Replaced by the thisAndFollowing query parameter on this operation.

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

Updated about 1 hour ago

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

Updated about 1 hour ago

Did this page help you?