Create a schedule

Request

This request uses the POST method, which is used to schedule a test run using Katalon TestOps from the specified resource.

For basic authorization, replace this with your actual username and password (or API key) in the header request in the username:password or username:api_key format. Your user creds are combined to form a Base64 encoded string.

The request data is provided as a JSON object.

You need to provide the following required query parameters:

verifyRunConfiguration - requires a Boolean parameter to indicate whether you skip verification of the run configuration or not.
runConfiguration - is an object containing configuration information for the test run.
configType - represents a specific test configuration type.
cloudType - suggesting that the test might be executed on a Kubernetes cluster.
projectId - the project ID.
teamId - the team or group associated with this test run.
testProjectId- test project ID.
agents - is an array of agents.

Response

The API response provides detailed information about a scheduled test run configuration and the associated parameters. The response contains a lot of data in a structured format, as demonstrated in this format:

{
  "runConfiguration": {
    "id": 0,
    "name": "string",
    "command": "string",
    "projectId": 0,
    "teamId": 0,
    "testProjectId": 0,
    "releaseId": 0,
    "testSuiteCollectionId": 0,
    "testSuiteId": 0,
    "executionProfileId": 0,
    "baselineCollectionGroupOrder": 0,
    "timeOut": 0,
    "kobitonDeviceId": "string",
    "configType": "TSC",
    "testProject": {
      "id": 0,
      "name": "string",
      "description": "string",
      "defaultTestProject": true,
      "uploadFileId": 0,
      "projectId": 0,
      "teamId": 0,
      "createdAt": "2023-11-01T19:59:30.351Z",
      "uploadFileName": "string",
      "type": "KS",
      "dirty": true
    },
    "agents": [
      {
        "id": 0,
        "name": "string",
        "ip": "string",
        "uuid": "string",
        "lastPing": "2023-11-01T19:59:30.351Z",
        "os": "string",
        "teamId": 0,
        "hostname": "string",
        "active": true,
        "threshold": 0,
        "numExecutingJobs": 0,
        "numAssignedJobs": 0,
        "agentVersion": "string",
        "deleted": true
      }
    ],
    "testCloudAgents": [
      {
        "id": 0,
        "name": "string",
        "os": "string",
        "osVersion": "string",
        "browser": "string",
        "browserVersion": "string",
        "deviceName": "string",
        "appId": "string",
        "appGroupId": "string",
        "appName": "string",
        "numExecutingJobs": 0,
        "numAssignedJobs": 0,
        "teamId": 0,
        "deleted": true,
        "apiKey": "string",
        "totalDuration": 0,
        "headless": true
      }
    ],
    "k8sAgents": [
      {
        "id": 0,
        "name": "string",
        "certificateAuthority": "string",
        "url": "string",
        "namespace": "string",
        "username": "string",
        "password": "string",
        "token": "string",
        "cluster": "string",
        "region": "string",
        "accessKey": "string",
        "privateAccessKey": "string",
        "teamId": 0,
        "apiKey": "string",
        "authenticationType": "BASIC_AUTH"
      }
    ],
    "circleCIAgents": [
      {
        "id": 0,
        "name": "string",
        "url": "string",
        "username": "string",
        "token": "string",
        "project": "string",
        "vcsType": "string",
        "branch": "string",
        "teamId": 0,
        "apiKey": "string"
      }
    ],
    "testCloudTestSuiteCollectionAgents": [
      {
        "testSuiteCollectionConfigurationId": 0,
        "testCloudAgent": {
          "id": 0,
          "name": "string",
          "os": "string",
          "osVersion": "string",
          "browser": "string",
          "browserVersion": "string",
          "deviceName": "string",
          "appId": "string",
          "appGroupId": "string",
          "appName": "string",
          "numExecutingJobs": 0,
          "numAssignedJobs": 0,
          "teamId": 0,
          "deleted": true,
          "apiKey": "string",
          "totalDuration": 0,
          "headless": true
        },
        "updatedAt": "2023-11-01T19:59:30.351Z"
      }
    ],
    "cloudType": "K8S",
    "latestJob": {
      "id": 0,
      "buildNumber": 0,
      "status": "QUEUED",
      "queuedAt": "2023-11-01T19:59:30.351Z",
      "startTime": "2023-11-01T19:59:30.351Z",
      "stopTime": "2023-11-01T19:59:30.351Z",
      "testProject": {
        "id": 0,
        "name": "string",
        "description": "string",
        "defaultTestProject": true,
        "uploadFileId": 0,
        "projectId": 0,
        "teamId": 0,
        "createdAt": "2023-11-01T19:59:30.351Z",
        "uploadFileName": "string",
        "type": "KS",
        "dirty": true
      },
      "execution": {
        "status": "PASSED",
        "startTime": "2023-11-01T19:59:30.351Z",
        "endTime": "2023-11-01T19:59:30.351Z",
        "duration": 0,
        "elapsedDuration": 0,
        "totalTests": 0,
        "totalPassedTests": 0,
        "totalFailedTests": 0,
        "totalErrorTests": 0,
        "totalIncompleteTests": 0,
        "totalSkippedTests": 0,
        "id": 0,
        "projectId": 0,
        "buildId": 0,
        "order": 0,
        "executionStage": "RUNNING",
        "hasComment": true,
        "sessionId": "string",
        "buildLabel": "string",
        "buildUrl": "string",
        "type": "KATALON",
        "useTestCloudTunnel": true
      },
      "agent": {
        "id": 0,
        "name": "string",
        "ip": "string",
        "uuid": "string",
        "lastPing": "2023-11-01T19:59:30.351Z",
        "os": "string",
        "teamId": 0,
        "hostname": "string",
        "active": true,
        "threshold": 0,
        "numExecutingJobs": 0,
        "numAssignedJobs": 0,
        "agentVersion": "string",
        "deleted": true
      },
      "testCloudAgent": {
        "id": 0,
        "name": "string",
        "os": "string",
        "osVersion": "string",
        "browser": "string",
        "browserVersion": "string",
        "deviceName": "string",
        "appId": "string",
        "appGroupId": "string",
        "appName": "string",
        "numExecutingJobs": 0,
        "numAssignedJobs": 0,
        "teamId": 0,
        "deleted": true,
        "apiKey": "string",
        "totalDuration": 0,
        "headless": true
      },
      "k8sAgent": {
        "id": 0,
        "name": "string",
        "certificateAuthority": "string",
        "url": "string",
        "namespace": "string",
        "username": "string",
        "password": "string",
        "token": "string",
        "cluster": "string",
        "region": "string",
        "accessKey": "string",
        "privateAccessKey": "string",
        "teamId": 0,
        "apiKey": "string",
        "authenticationType": "BASIC_AUTH"
      },
      "circleCiAgent": {
        "id": 0,
        "name": "string",
        "url": "string",
        "username": "string",
        "token": "string",
        "project": "string",
        "vcsType": "string",
        "branch": "string",
        "teamId": 0,
        "apiKey": "string"
      },
      "runConfiguration": {
        "id": 0,
        "name": "string",
        "command": "string",
        "projectId": 0,
        "teamId": 0,
        "testProjectId": 0,
        "releaseId": 0,
        "testSuiteCollectionId": 0,
        "testSuiteId": 0,
        "executionProfileId": 0,
        "baselineCollectionGroupOrder": 0,
        "timeOut": 0,
        "kobitonDeviceId": "string",
        "configType": "TSC",
        "cloudType": "K8S",
        "genericCommand": "string",
        "ksVersion": "string",
        "ksLocation": "string",
        "executionMode": "SEQUENTIAL",
        "enabledKobitonIntegration": true,
        "enabledTestCloudTunnel": true,
        "triggerMode": "TESTOPS_SCHEDULER",
        "browserType": "CHROME"
      },
      "order": 0,
      "parameter": {
        "downloadUrl": "string",
        "command": "string",
        "environmentVariables": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "sessionId": "string",
        "ksVersion": "string",
        "ksLocation": "string",
        "configType": "TSC",
        "type": "KS",
        "gitRepositoryResource": {
          "id": 0,
          "testProjectId": 0,
          "name": "string",
          "repository": "string",
          "branch": "string",
          "username": "string",
          "password": "string",
          "accessKeyId": "string",
          "secretAccessKey": "string",
          "projectId": 0,
          "description": "string",
          "vcsType": "GITHUB",
          "shouldMergeTestResultsForNewScriptRepo": true,
          "teamId": 0,
          "createdAt": "2023-11-01T19:59:30.351Z",
          "updatedAt": "2023-11-01T19:59:30.351Z"
        },
        "testOpsDownloadUrl": "string",
        "extraFiles": [
          {
            "contentUrl": "string",
            "path": "string",
            "writeMode": "OVERRIDE"
          }
        ],
        "organizationId": 0
      },
      "triggerBy": "MANUAL",
      "duration": 0,
      "triggerAt": "2023-11-01T19:59:30.351Z",
      "user": {
        "id": 0,
        "email": "string",
        "firstName": "string",
        "lastName": "string",
        "password": "string",
        "invitingUrl": "string",
        "trialExpirationDate": "2023-11-01T19:59:30.351Z",
        "surveyStatus": "NOT_SUBMITTED",
        "sessionTimeout": 0,
        "businessUser": true,
        "canCreateOfflineKSE": true,
        "canCreateOfflineRE": true,
        "samlSSO": true,
        "createdAt": "2023-11-01T19:59:30.351Z",
        "fullName": "string"
      },
      "scheduler": {
        "id": 0,
        "name": "string",
        "startTime": "2023-11-01T19:59:30.351Z",
        "nextTime": "2023-11-01T19:59:30.351Z",
        "endTime": "2023-11-01T19:59:30.351Z",
        "active": true,
        "interval": 0,
        "intervalUnit": "MINUTE",
        "runConfigurationId": 0,
        "exceededLimitTime": true
      },
      "project": {
        "id": 0,
        "name": "string",
        "teamId": 0,
        "status": "ARCHIVE"
      },
      "processId": 0,
      "nodeStatus": "PENDING_CANCELED",
      "runConfigurationId": 0
    },
    "genericCommand": "string",
    "ksVersion": "string",
    "ksLocation": "string",
    "nextRunScheduler": {
      "id": 0,
      "name": "string",
      "startTime": "2023-11-01T19:59:30.351Z",
      "nextTime": "2023-11-01T19:59:30.351Z",
      "endTime": "2023-11-01T19:59:30.351Z",
      "active": true,
      "interval": 0,
      "intervalUnit": "MINUTE",
      "runConfigurationId": 0,
      "runConfiguration": {
        "id": 0,
        "name": "string",
        "command": "string",
        "projectId": 0,
        "teamId": 0,
        "testProjectId": 0,
        "releaseId": 0,
        "testSuiteCollectionId": 0,
        "testSuiteId": 0,
        "executionProfileId": 0,
        "baselineCollectionGroupOrder": 0,
        "timeOut": 0,
        "kobitonDeviceId": "string",
        "configType": "TSC",
        "cloudType": "K8S",
        "genericCommand": "string",
        "ksVersion": "string",
        "ksLocation": "string",
        "executionMode": "SEQUENTIAL",
        "enabledKobitonIntegration": true,
        "enabledTestCloudTunnel": true,
        "triggerMode": "TESTOPS_SCHEDULER",
        "browserType": "CHROME"
      },
      "exceededLimitTime": true
    },
    "release": {
      "id": 0,
      "name": "string",
      "startTime": "2023-11-01",
      "endTime": "2023-11-01",
      "description": "string",
      "projectId": 0,
      "closed": true,
      "createdAt": "2023-11-01T19:59:30.351Z",
      "releaseStatus": "NOT_READY"
    },
    "build": {
      "id": 0,
      "projectId": 0,
      "releaseId": 0,
      "name": "string",
      "description": "string",
      "date": "2023-11-01T19:59:30.351Z"
    },
    "executionMode": "SEQUENTIAL",
    "enabledKobitonIntegration": true,
    "enabledTestCloudTunnel": true,
    "triggerMode": "TESTOPS_SCHEDULER",
    "browserType": "CHROME"
  },
  "scheduler": {
    "id": 0,
    "name": "string",
    "startTime": "2023-11-01T19:59:30.351Z",
    "nextTime": "2023-11-01T19:59:30.351Z",
    "endTime": "2023-11-01T19:59:30.351Z",
    "active": true,
    "interval": 0,
    "intervalUnit": "MINUTE",
    "runConfigurationId": 0,
    "runConfiguration": {
      "id": 0,
      "name": "string",
      "command": "string",
      "projectId": 0,
      "teamId": 0,
      "testProjectId": 0,
      "releaseId": 0,
      "testSuiteCollectionId": 0,
      "testSuiteId": 0,
      "executionProfileId": 0,
      "baselineCollectionGroupOrder": 0,
      "timeOut": 0,
      "kobitonDeviceId": "string",
      "configType": "TSC",
      "cloudType": "K8S",
      "genericCommand": "string",
      "ksVersion": "string",
      "ksLocation": "string",
      "executionMode": "SEQUENTIAL",
      "enabledKobitonIntegration": true,
      "enabledTestCloudTunnel": true,
      "triggerMode": "TESTOPS_SCHEDULER",
      "browserType": "CHROME"
    },
    "exceededLimitTime": true
  }
}

Refer to the following table about the response body properties for the runConfiguration object:

Property	Type	Description
`id`	Integer	The unique identifier of the run configuration.
`name`	Integer	The name of the test execution.
`command`	String	The execution command that specifies 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`	Object	The repository that contains the test cases.
`agents`	Array	An array of local agents used in the execution.
`testCloudAgents`	Array	An array of TestCloud agents used in the execution.
`k8sAgents`	Array	An array of Kubernetes (K8s) agents used in the execution.
`circleCIAgents`	Array	An array of CircleCI agents used in the execution.
`testCloudTestSuiteCollectionAgents`	Array	An array of agents 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`	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`	Object	The scheduler object for the next execution.
`release`	Object	The release object associated with the execution.
`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`

Refer to the following table about the response body properties for the scheduler object:

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.

Try it!

Provide the required parameters and values below (click the dropdown and plus icons):
1. verifyRunConfiguration - true or false
2. runConfiguration object
3. scheduler object
Select the language in Language.
Enter your user name or API credentials.
Review your API call and click Try it!