# ApiSchedule Data Model

Base class for commands that can be scheduled in Cloudera Manager.

Note that schedule IDs are not preserved upon import.

Properties
name | data type | description
--- | --- | ---
id | number | The schedule id.
displayName | string | The schedule display name.
description | string | The schedule description.
startTime | string | The time at which the scheduled activity is triggered for the first time.
endTime | string | The time after which the scheduled activity will no longer be triggered.
interval | number | The duration between consecutive triggers of a scheduled activity. Defaults to 0.
intervalUnit | ApiScheduleInterval | The unit for the repeat interval.
nextRun | string | Readonly. The time the scheduled command will run next.
paused | boolean | The paused state for the schedule. The scheduled activity will not be triggered as long as the scheduled is paused. Defaults to false.
alertOnStart | boolean | Whether to alert on start of the scheduled activity. Defaults to false.
alertOnSuccess | boolean | Whether to alert on successful completion of the scheduled activity. Defaults to false.
alertOnFail | boolean | Whether to alert on failure of the scheduled activity. Defaults to false.
alertOnAbort | boolean | Whether to alert on abort of the scheduled activity. Defaults to false.

Example

    {
      "id" : 12345,
      "displayName" : "...",
      "description" : "...",
      "startTime" : "...",
      "endTime" : "...",
      "interval" : 12345,
      "intervalUnit" : "MONTH",
      "nextRun" : "...",
      "paused" : true,
      "alertOnStart" : true,
      "alertOnSuccess" : true,
      "alertOnFail" : true,
      "alertOnAbort" : true
    }