Retrieve a scheduled execution

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.

Response

The response includes the configuration for a test run, including details about the agents, test cloud agents, cloud infrastructure, the most recent job run, and its associated configurations and scheduled tasks.

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`	String	The date and time when the execution starts.
`nextTime`	String	The date and time for the next iteration of the execution.
`endTime`	String	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 when applicable):
1. smartSchedulerID
Select the language in Language.
Enter your user name or API credentials.
Review your API call and click Try it!