get https://testops.katalon.io/api/v1/smart-scheduler/
A successful request to this endpoint retrieves a smart scheduler
object given the corresponding ID.
Request
This request uses the GET method, which is used to retrieve data for a specific test run or execution 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:
id
: the unique alphanumeric ID of the test schedule.
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:
|
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 when applicable):
smartSchedulerID
- Select the language in Language.
- Enter your user name or API credentials.
- Review your API call and click Try it!