Create and trigger a schedule

post

https://testops.katalon.io/api/v1/smart-scheduler/run

A successful request to this endpoint creates a run configuration object and triggers an execution immediately. This method returns the created run configuration object.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

verifyRunConfiguration

boolean

Defaults to false

Body Params

int64

ID of the run configuration.

name

string

Name of the run configuration.

command

string

Execution command.

projectId

int64

required

ID of the associated project.

teamId

int64

required

ID of the associated team.

testProjectId

int64

required

ID of the script repository.

releaseId

int64

ID of the linked release.

testSuiteCollectionId

int64

ID of the test suite collection to execute.

testSuiteId

int64

ID of the test suite to execute.

executionProfileId

int64

ID of the execution profile.

baselineCollectionGroupOrder

int64

ID of the Visual Testing baseline collection, applied when Visual Testing is enabled.

timeOut

int64

Time limit for this execution.

kobitonDeviceId

string

ID of the Kobiton device, applied when Kobiton integration is enabled.

configType

string

enum

required

Configuration type.

Allowed:

agents

array of objects

Local agents to execute.

agents

testCloudAgents

array of objects

TestCloud agents to execute.

testCloudAgents

k8sAgents

array of objects

Kubernetes agents to execute.

k8sAgents

circleCIAgents

array of objects

CircleCI agent to execute.

circleCIAgents

cloudType

string

enum

required

Type of agent that executes the tests.

Allowed:

genericCommand

string

Execution command configuration in other platforms.

ksVersion

string

Version of Katalon Runtime Engine.

ksLocation

string

Location of the Katalon Rutime Engine instance when executing with local agent.

executionMode

string

enum

Sequential or parallel execution.

Allowed:

enabledKobitonIntegration

boolean

true if you want to enable Kobiton integration.

enabledTestCloudTunnel

boolean

true if you want to enable TestCloud Tunnel.

triggerMode

string

enum

How the execution should be triggered.

Allowed:

browserType

string

enum

Browser/mobile environment to execute the tests.

Response

200OK