The Schedule endpoint

The schedule API resource has three API objects you can interact with through the API:

Smart scheduler object - The smart scheduler object describes a scheduled execution. TestOps generates a smart scheduler object when you schedule an execution with the smart scheduler interface.
Run configuration object - The run configuration object describes the execution configuration. A run configuration contains configuration information about the execution, such as associated test suites, the agent, and the execution commands.
Scheduler object - The scheduler object describes the execution trigger and schedule.

Methods

To learn more about scheduling test runs, see Schedule test runs in TestOps.

Smart scheduler - response body sample

{
  "runConfiguration": {...},
  "scheduler": {...}
}

Refer to the following table about the response body parameters:

Property	Type	Description
`runConfiguration`	run configuration object	The object representing the execution configuration.
`scheduler`	scheduler object	The object describing how the execution should be triggered.

Run configuration - response body sample

{
    "id": 431605,
    "name": "Sample tests",
    "command": "",
    "projectId": xxx,
    "teamId": xxx,
    "testProjectId": 413209,
    "testSuiteId": 1021178,
    "executionProfileId": 103622,
    "timeOut": 60,
    "kobitonDeviceId": "",
    "configType": "TEST_SUITE",
    "testProject": {
      "id": 413209,
      "name": "testcloud-sample-projects",
      "description": "",
      "projectId": xxx,
      "teamId": xxx,
      "createdAt": "2022-11-04T04:02:14.799+0000",
      "type": "GIT",
      "dirty": false
    },
    "agents": [],
    "testCloudAgents": [{...}],
    "k8sAgents": [],
    "circleCIAgents": [],
    "testCloudTestSuiteCollectionAgents": [],
    "cloudType": "TEST_CLOUD_AGENT",
    "genericCommand": "",
    "ksVersion": "8.5.2",
    "ksLocation": "",
    "nextRunScheduler": {},
    "executionMode": "SEQUENTIAL",
    "enabledKobitonIntegration": false,
    "enabledTestCloudTunnel": false,
    "triggerMode": "TESTOPS_SCHEDULER",
    "browserType": "CHROME"
  }

Refer to the following table about the response body parameters:

Property	Type	Description
`id`	`integer`	The unique identifier of the run configuration.
`name`	`string`	The name of the test execution.
`command`	`string`	The execution command to specify the behavior of the execution. See Command-line syntax.
`projectId`	`integer`	The ID of the project associated with this execution.
`teamId`	`integer`	The ID of the team associated with this execution.
`testProjectId`	`integer`	The ID of the script repository or zip repository that contains test cases.
`releaseId`	`integer`	The ID of the release associated with the execution
`testSuiteCollectionId`	`integer`	The ID of the test suite collections used in the execution.
`testSuiteId`	`integer`	The ID of the test suite used in the execution.
`executionProfileId`	`integer`	The execution profile configured in Katalon Studio. See Execution Profile.
`baselineCollectionGroupOrder`	`integer`	The order of the Visual Testing baseline collection associated with the execution. See Baseline collection.
`timeOut`	`integer`	The time limit for the execution.
`kobitonDeviceId`	`string`	The Kobiton device ID to execute mobile tests, applied when Kobiton integration is enabled.
`configType`	`string`	Configuration type: `TSC`, `COMMAND`, `GENERIC_COMMAND`, `TEST_SUITE`.
`testProject`	`testProject` object	The repository that contains the test cases.
`agents`	Array of `Agent` objects	The local agents used in the execution.
`testCloudAgents`	Array of `TestCloudAgent` objects	The TestCloud agents used in the execution.
`k8sAgents`	Array of `K8SAgent` objects	The Kubernetes (K8s) agents used in the execution.
`circleCIAgents`	Array of `CircleCIAgent` objects	The CircleCI agents used in the execution.
`testCloudTestSuiteCollectionAgents`	Array of `testCloudTestSuiteCollectionAgent` objects	These agents are used for overriding individual test environments of test suites in a test suite collection.
`cloudType`	`string`	The cloud execution type, associated with the agents in use: `LOCAL_AGENT`, `TEST_CLOUD_AGENT`, `CIRCLE_CI_AGENT`, `K8S_AGENT`, `K8S`.
`latestJob`	`Job` object	This object describes the latest execution.
`genericCommand`	`string`	The generic execution command configured for the execution.
`ksVersion`	`string`	The version of Katalon Runtime Engine used for the execution.
`ksLocation`	`string`	The location of Katalon Runtime Engine instance, applied when using local agent.
`nextRunScheduler`	`scheduler` object	The scheduler object for the next execution.
`release`	`release` object	The release object associated with the execution.
`build`	`build` object	The build object associated with the execution.
`executionMode`	`string`	There are two execution modes: `SEQUENTIAL` and `PARALLEL`.
`enabledKobitonIntegration`	`boolean`	`true` if Kobiton integration is enabled.
`enabledTestCloudTunnel`	`boolean`	`true` if TestCould Tunnel is enabled.
`triggerMode`	`string`	How the execution should be triggered: `TESTOPS_SCHEDULER` (triggered at the specified date and time) or `MANUAL_TRIGGER` (triggered manually by the user).
`browserType`	`string`	The test environment used in the execution: `CHROME` `FIREFOX` `SAFARI` `EDGE` `EDGE_CHROMIUM` `WEB_SERVICE` `CHROME_HEADLESS` `FIREFOX_HEADLESS` `MOBILE_BROWSERS` `MOBILE_NATIVE` `ALL`

Scheduler properties - response body sample

{
    "id": 178895,
    "name": "Untitled",
    "startTime": "2022-12-11T08:05:00.000+0000",
    "active": true,
    "interval": 1,
    "intervalUnit": "WEEK",
    "runConfigurationId": 428934
}

A scheduler object has the following properties:

Property	Type	Description
`id`	`integer`	The unique identifier of the scheduler.
`name`	`string`	The name of the scheduler.
`startTime`	`datetime`	The date and time when the execution starts.
`nextTime`	`datetime`	The date and time for the next iteration of the execution.
`endTime`	`datetime`	The date and time when the execution should stop.
`active`	`boolean`	`true` when then associated `run configuration` is repeatedly scheduled or saved for manual trigger. See: Execute test runs manually.
`interval`	`integer`	How many intervals until the next execution. Applied when execution is repeated.
`intervalUnit`	`string`	The interval unit in use: `MINUTE` `HOUR` `DAY` `WEEK` `MONTH`
`runConfigurationId`	`integer`	The ID of the run configuration associated with the scheduler.
`exceededLimitTime`	`boolean`	`true` if the execution exceeded the TestCloud execution time limit.