Retrieve a scheduled execution

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:

PropertyTypeDescription
idintegerThe unique identifier of the scheduler.
namestringThe name of the scheduler.
startTimedatetimeThe date and time when the execution starts.
nextTimedatetimeThe date and time for the next iteration of the execution.
endTimedatetimeThe date and time when the execution should stop.
activebooleantrue when then associated run configuration is repeatedly scheduled or saved for manual trigger.

See: Execute test runs manually.
intervalintegerHow many intervals until the next execution. Applied when execution is repeated.
intervalUnitstringThe interval unit in use:

  • MINUTE

  • HOUR

  • DAY

  • WEEK

  • MONTH

runConfigurationIdintegerThe ID of the run configuration associated with the scheduler.
exceededLimitTimebooleantrue if the execution exceeded the TestCloud execution time limit.

Try it!

  1. Provide the required parameters and values below (click the dropdown and plus icons when applicable):
    1. smartSchedulerID
  2. Select the language in Language.
  3. Enter your user name or API credentials.
  4. Review your API call and click Try it!
Language
Authorization
Basic
base64
:
Click Try It! to start a request and see the response here!