Trigger a schedule

Request

This request uses the PUT method, which is used to execute a specific run configuration 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:

scheduleID: schedule ID.

Response

The response returns an array of objects containing detailed information about the run configuration, build, and test steps. Each object in the array represents a build execution and includes data such as build status, start and stop times, and specific steps with logs.

[
  {
    "build_num": 123,
    "job_id": 456,
    "build_time_millis": 50000,
    "status": "success",
    "usage_queued_at": "2025-01-17T22:17:22.033Z",
    "start_time": "2025-01-17T22:17:22.033Z",
    "stop_time": "2025-01-17T22:17:22.033Z",
    "steps": [
      {
        "logFileUrl": "https://example.com/logs/step1",
        "content": "Test step 1 completed successfully.",
        "name": "Step 1"
      },
      {
        "logFileUrl": "https://example.com/logs/step2",
        "content": "Test step 2 encountered an issue.",
        "name": "Step 2"
      }
    ]
  }
]

Refer to the following table about the response body properties:

Property	Type	Description
`build_num`	Integer	The build number of the test execution.
`job_id`	Integer	The unique identifier of the job associated with this build.
`build_time_millis`	Integer	The duration of the build in milliseconds.
`status`	String	The status of the build (e.g., `string`).
`usage_queued_at`	String (ISO 8601)	The timestamp of when the build was queued.
`start_time`	String (ISO 8601)	The timestamp of when the build started.
`stop_time`	String (ISO 8601)	The timestamp of when the build finished.
`steps`	Array of Objects	An array containing details of each step executed in the build.
`steps.name`	String	The name of the individual test step.
`steps.content`	String	The content or log of the test step executed.
`steps.logFileUrl`	String	The URL of the log file for the test step.

Try it!

Provide the required parameters and values below (click the dropdown and plus icons):
Select the language in Language.
Enter your user name or API credentials.
Review your API call and click Try it!