Object

Schedule

The scheduling information for a schedule item.

Fields

description(): String

The description of the schedule

initial_run_time(): Timestamp!

The time at which the scan is scheduled to start for the first time.

name(): String

The name of the schedule

rrule(): String

Determines how frequently the scan runs. This must be specified in RRULE format.

The structure of the RRULE format is described in RFC5545, RFC5546, and RFC5547.

For example, the following would run a scan that was scheduled to run once a month on the 19th of the month: FREQ=MONTHLY;INTERVAL=1;BYMONTHDAY=19

Run a scan every 10 minutes: FREQ=MINUTELY;INTERVAL=10

Run a scan every 3 hours: FREQ=HOURLY;INTERVAL=3

Run a scan every day FREQ=DAILY;INTERVAL=1

Run a scan every 2 days: FREQ=DAILY;INTERVAL=2

Run a scan every 2 weeks on a Tuesday: FREQ=WEEKLY;INTERVAL=2;BYDAY=TU

Run a scan every 4 weeks on Mondays: FREQ=WEEKLY;INTERVAL=4;BYDAY=MO

Run a scan every 4 weeks on Mondays, Wednesdays and Fridays: FREQ=WEEKLY;INTERVAL=4;BYDAY=MO,WE,FR

Run a scan every 6 months on the 16th day of the Month: FREQ=MONTHLY;INTERVAL=6;BYMONTHDAY=16

Run a scan every 6 months on the 3rd Wednesday: FREQ=MONTHLY;INTERVAL=6;BYDAY=3WE

The above rules can be combined with limits of an absolute number of scans and/or scanning until a set date:

Run a scan every day, until it has been done 10 times: FREQ=DAILY;COUNT=10;INTERVAL=1

Run a scan every hour until 2021-01-01 10:00: FREQ=HOURLY;UNTIL=20210101T100400Z;INTERVAL=1

Example

Query

query GetSchedule($id: ID!) {
  schedule_item(id: $id) {
    id
    schedule {
      rrule
      initial_run_time
      name
      description
    }
  }
}

Variables

{
  "id": "4"
}

Result

{
  "data": {
    "schedule_item": {
      "id": "4",
      "schedule": {
        "rrule": "FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,WE,FR,SU",
        "initial_run_time": "2020-04-1T12:00:00Z",
        "name": "Name",
        "description": "Description"
      },
    }
  }
}