The scheduler object

The scheduler object describes the execution trigger and schedule.

Scheduler properties

{
    "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:

  • 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.