data – schedule properties
| Name | Value | Count | |
|---|---|---|---|
| type | CALENDAR CRON DAILY DATE MONTHLY REPEAT SOLAR |
1 | Schedule type. |
| additional CALENDAR schedule properties | |||
| boundary | START END BOTH |
0/1 | Calendar event boundary/s to trigger on. Default = START. |
| direction | BEFORE AFTER INSIDE OUTSIDE |
0/1 | Direction of offset from boundary. Default = BEFORE. |
| offset | period | 0/1 | Offset from boundary. Default = 0. |
| additional CRON schedule properties | |||
| expression | cron_expression | 1 | Cron expression defined when schedule should trigger. |
| additional DAILY schedule properties | |||
| days | MONDAY TUESDAY WEDNESDAY THURSDAY FRIDAY SATURDAY SUNDAY DAILY WEEKDAY WEEKEND |
0+ | Days to trigger. Default = DAILY. |
| time | time | 1 | Time to trigger schedule. |
| additional DATE schedule properties | |||
| when | time date | 1 | Time and date to schedule trigger. |
| additional MONTHLY schedule properties | |||
| day | MONDAY TUESDAY WEDNESDAY THURSDAY FRIDAY SATURDAY SUNDAY DAY WEEKDAY WEEKEND |
0/1 | Day to trigger. Default = DAY. |
| time | time | 1 | Time to trigger schedule. |
| position | integer | 0/1 | Default = 1. |
| last | boolean | 0/1 | Default = false. |
| additional REPEAT schedule properties | |||
| period | period | 1 | Period between schedule triggers. |
| epoch | time date | 0/1 | Time and date of first execution of the schedules trigger. |
| additional SOLAR schedule properties | |||
| city | city | 1 | City whose sunrise/sunset to trigger. |
| zenith | ASTRONOMICAL CIVIL NAUTICAL OFFICIAL |
1 | Zenith of sun to trigger on. |
| event | SUNRISE SUNSET |
1 | Event to trigger on. |
| direction | BEFORE AFTER |
0/1 | Direction of offset from sunrise/sunset. Default = BEFORE. |
| offset | period | 0/1 | Offset from sunrise/sunset. Default = 0. |
Examples
Calendar schedule
Trigger 15 minutes before the end of each calendar event.
{ "type": "CALENDAR", "boundary": "END", "offset": "15 minutes" }
type: CALENDAR boundary: END offset: 15 minutes
Cron schedule
Trigger on the last Friday of the month at 17:50.
{ "type": "CRON", "expression": "0 30 17 ? * FRIL" }
type: CRON expression: '0 30 17 ? * FRIL'
Daily schedule
Trigger Mondays & Fridays at 23:50.
{ "type": "DAILY", "days": [ "MONDAY", "FRIDAY" ], "time" "23:50:00" }
type: DAILY days: [MONDAY, FRIDAY] time: '23:50:00'
Date schedule
Trigger at 6pm, 19th May 2019.
{ "type": "DATE", "when": "18:00:00 19/05/2019" }
type: DATE when: '18:00:00 19/05/2019'
Monthly schedules
First weekday of month at 09:00.
{ "type": "MONTHLY", "day": "WEEKDAY", "time": "09:00:00" }
type: MONTHLY day: WEEKDAY time: '09:00:00'
Second day of month at 10:00.
{ "type": "MONTHLY", "time": "10:00:00", "position": 2 }
type: MONTHLY time: '10:00:00' position: 2
Fifth last day of month at 10:00.
{ "type": "MONTHLY", "time": "10:05:00", "position": 5, "last": true }
type: MONTHLY time: '10:05:00' position: 5 last: true
Repeat schedule
Trigger every 6 hours.
{ "type": "REPEAT", "period": "6 HOURS", "epoch": "09:00:00 05/01/2017" }
type: REPEAT period: 6 HOURS epoch: 09:00:00 05/01/2017
Solar schedule
Trigger 15 minutes before civil sunset in Tokyo.
{ "type": "SOLAR", "city": "Tokyo, Japan", "zenith": "CIVIL", "event": "SUNSET", "offset": "30 minutes" }
type: SOLAR city: 'Tokyo, Japan' zenith: CIVIL event: SUNSET offset: 30 minutes