ScheduleModel Data Type

Model for a scheduler schedule.

Properties
name data type constraints description
id number   Task ID
name string   Task name
description string   Task description
taskId number   ID of the executed task
scheduleData ScheduleData   Get the schedule data
parallel boolean   When true the schedule can be executed at the same time as other parallel schedules.
active boolean   True for internal tasks, false for external tasks
status ScheduleStatus   Get the current status of the schedule.
notificationEmail array of string   Get the notification email addresses.
runs number required int Get the number of executions for this schedule.
averageTime number required int Get the average runtime of this schedules executions.
lastExecution ExecutionModel   Get the data for the last execution if any.
creator User   Task creator
cdate number required int Task creation timestamp
editor User   Last task editor
edate number required int Last task edit timestamp

Example

{
  "id" : 12345,
  "name" : "...",
  "description" : "...",
  "taskId" : 12345,
  "scheduleData" : {
    "type" : "interval",
    "startTimestamp" : 12345,
    "endTimestamp" : 12345,
    "interval" : {
      "value" : 12345,
      "unit" : "hour"
    },
    "follow" : {
      "scheduleId" : [ 12345, 12345 ],
      "onlyAfterSuccess" : true
    }
  },
  "parallel" : true,
  "active" : true,
  "status" : "DUE",
  "notificationEmail" : [ "...", "..." ],
  "runs" : 12345,
  "averageTime" : 12345,
  "lastExecution" : {
    "id" : 12345,
    "scheduleId" : 12345,
    "startTime" : 12345,
    "endTime" : 12345,
    "duration" : 12345,
    "result" : true,
    "log" : "...",
    "running" : true
  },
  "creator" : {
    "id" : 12345,
    "firstName" : "...",
    "lastName" : "...",
    "description" : "...",
    "email" : "...",
    "groups" : [ {
      "id" : 12345,
      "name" : "...",
      "description" : "...",
      "children" : [ { }, { } ]
    }, {
      "id" : 12345,
      "name" : "...",
      "description" : "...",
      "children" : [ { }, { } ]
    } ],
    "login" : "...",
    "password" : "..."
  },
  "cdate" : 12345,
  "editor" : {
    "id" : 12345,
    "firstName" : "...",
    "lastName" : "...",
    "description" : "...",
    "email" : "...",
    "groups" : [ {
      "id" : 12345,
      "name" : "...",
      "description" : "...",
      "children" : [ { }, { } ]
    }, {
      "id" : 12345,
      "name" : "...",
      "description" : "...",
      "children" : [ { }, { } ]
    } ],
    "login" : "...",
    "password" : "..."
  },
  "edate" : 12345
}