The Schedule model allows scheduling of execute actions. Scheduling can be performed once, or multiple times, depending on the choices given to the schedule instance.

An asterisk * in the title indicates the field is mandatory.
If a field has a default value, it is shown in the Description column.
If the field type is an array, the Field Name has a .[n] suffix, where n is the array index placeholder.
Object and array field names are listed to provide context. If a field belongs to an object or an array, the full field name is shown in dot separated notation.

Title

Description

Details

Schedule Name *

Name of this Schedule

Field Name: name
Type: String

Last Executed (UTC Time)

Last time that this schedule executed

Field Name: last_executed
Type: String

Owner

A business key that identifies the data/User who created the schedule.

Field Name: owner
Type: String

Schedule Type *

Type of Schedule

Field Name: schedule_type
Type: String
Choices: ["Single Execution", "Multi Execution"]

Active

Is the entire schedule active or not. Default: True

Field Name: active
Type: Boolean
Default: True

Scheduled resources

List of resources that will be actioned

Field Name: scheduled_resources.[n]
Type: Array
Cardinality: [1..n]

Action *

Action to perform

Field Name: scheduled_resources.[n].action
Type: String
Choices: ["Execute"]

Resource Type *

Resource types to which this schedule will apply.

Field Name: scheduled_resources.[n].resource_type
Type: String
Choices: [""]

Resource Attribute *

Resource attribute that will be used to filter/choose from.

Field Name: scheduled_resources.[n].resource_attribute
Type: String
Choices: [""]

Resource *

DESCRIPTION

Field Name: scheduled_resources.[n].resource_instance
Type: String
Choices: [""]

Perform Action

DESCRIPTION Default: True

Field Name: scheduled_resources.[n].perform_action
Type: Boolean
Default: True

Single Execution

Field Name: single_execute
Type: Object

Execution Date (YYYY-MM-DD. Local date)

Execution Date

Field Name: single_execute.single_date
Type: String
Pattern: ^\d{4}\-(0[1-9]|1[012])\-(0[1-9]|[12]\d|3[01])$

Execution Time (HH:MM:SS. Local time)

Execution Time

Field Name: single_execute.single_time
Type: String
Pattern: ^([0-1]\d|2[0-3]):(0[0-9]|[1-5]\d):(0[0-9]|[1-5]\d)$

Execution Timezone (Local timezone)

Timezone for Execution Default: 0

Field Name: single_execute.single_timezone
Type: String
Default: 0
Pattern: ^[-+]?\d+$

Multiple Executions

Multi Execution

Field Name: multi_execute
Type: Object

Use Specific Executions

Use specific executions.

Field Name: multi_execute.use_specific
Type: Boolean

Use Calendar Executions

Use calendar executions.

Field Name: multi_execute.use_calender
Type: Boolean

Use Timed Executions

Use timed executions.

Field Name: multi_execute.use_timed
Type: Boolean

Specific Execution Dates

Field Name: specific_execute.[n]
Type: Array

Execution Date (YYYY-MM-DD. Local date)

Execution Date

Field Name: multi_execute.specific_execute.[n].specific_date
Type: String
Pattern: ^\d{4}\-(0[1-9]|1[012])\-(0[1-9]|[12]\d|3[01])$

Execution Time (HH:MM:SS. Local time)

Execution Time

Field Name: multi_execute.specific_execute.[n].specific_time
Type: String
Pattern: ^([0-1]\d|2[0-3]):(0[0-9]|[1-5]\d):(0[0-9]|[1-5]\d)$

Execution Timezone (Local timezone)

Timezone for Execution Default: 0

Field Name: multi_execute.specific_execute.[n].specific_timezone
Type: String
Default: 0
Pattern: ^[-+]?\d+$

Calendar Executions

Repeated Execution by Calendar

Field Name: calender_execute
Type: Object

Calendar Month

Field Name: multi_execute.calender_execute.calender_month
Type: Integer
Minimum: 1
Maximum: 12

Calendar Day

Field Name: multi_execute.calender_execute.calender_day
Type: Integer
Minimum: 1
Maximum: 31

Calendar Hour

Field Name: multi_execute.calender_execute.calender_hour
Type: Integer
Maximum: 23

Calendar Minute

Field Name: multi_execute.calender_execute.calender_minute
Type: Integer
Maximum: 59

Execution Timezone (Local timezone)

Timezone for Execution Default: 0

Field Name: multi_execute.calender_execute.calender_timezone
Type: String
Default: 0
Pattern: ^[-+]?\d+$

Timed Executions

Timed Execution

Field Name: timed_execute
Type: Object

First Execution Date (YYYY-MM-DD. Local date)

Execution Date

Field Name: multi_execute.timed_execute.first_date
Type: String
Pattern: ^\d{4}\-(0[1-9]|1[012])\-(0[1-9]|[12]\d|3[01])$

First Execution Time (HH:MM:SS. Local time)

Execution Time

Field Name: multi_execute.timed_execute.first_time
Type: String
Pattern: ^([0-1]\d|2[0-3]):(0[0-9]|[1-5]\d):(0[0-9]|[1-5]\d)$

First Execution Timezone (Local timezone)

Timezone for Execution Default: 0

Field Name: multi_execute.timed_execute.first_timezone
Type: String
Default: 0
Pattern: ^[-+]?\d+$

Repeat after (x) Days

Repeat Days

Field Name: multi_execute.timed_execute.repeat_day
Type: Integer

Repeat after (x) Hours

Repeat Hours

Field Name: multi_execute.timed_execute.repeat_hour
Type: Integer

Repeat after (x) Minutes

Repeat Minutes

Field Name: multi_execute.timed_execute.repeat_minute
Type: Integer

Number of Repeats (0 = infinite)

Number of Repeats

Field Name: multi_execute.timed_execute.repeat_number
Type: Integer

Model: data/Schedule

Model Details