API ReferenceDocumentationCommunityAcademyPlatform
API Reference

Run a scheduled occurrence (deprecated compatibility action)

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

Deprecated. Use POST /v2/schedules/test-runs/{id}/run, which runs the
same occurrence and returns the new test run.

With action: INSTANCE_RUN, this request starts the occurrence of
schedulerId at startTime now and returns its executionId.
schedulerId must belong to runConfigurationId, and startTime must not
be in the past.

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

Runs a scheduled occurrence now (deprecated; use
POST /v2/schedules/test-runs/{id}/run).

int64
required

Schedule ID (run-configuration ID).

string
enum
required

Run this scheduled occurrence.

Allowed:
int64
required

Scheduler ID that belongs to runConfigurationId.

date-time
required

The occurrence time; must not be in the past.

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?