Object

ScheduleItem

Exposes all of the scheduling data about a configured scan, such as the time and date when the scan is scheduled to run, and how frequently. When a scheduled scan is due to start, a Scan object is created based on the associated schedule item. Note that for recurring scans, all individual occurrences of the scan share a common schedule item.

Fields

folders(): [Folder!]!
The folders on which scans created from this schedule item are performed.
has_run_more_than_once(): Boolean
Indicates whether a recurring scan created from this schedule item has run more than once.
id(): ID!
The unique identifier of the schedule item.
scan_configurations(): [ScanConfiguration!]!
A list of the scan configurations used by scans created from this schedule item.
schedule(): Schedule!
Information about the time at which scans created from this schedule item run, and their frequency.
scheduled_run_time(): Timestamp
The next time that a scan created from this schedule item is due to run.
site(): Site
Deprecated: Use the 'sites' field instead, which supports multiple sites.
The first site on which scans created from this schedule item are performed.
sites(): [Site!]!
The sites on which scans created from this schedule item are performed.

Example

Query 
query GetScheduleItem($id: ID!) {
  schedule_item(id: $id) {
    id
    sites {
      id
      name
    }
    folders {
      id
      name
    }
    schedule {
      rrule
      initial_run_time
      name
      description
    }
    scheduled_run_time
  }
}
Variables 
{
  "id": "4"
}
Result 
{
  "data": {
    "schedule_item": {
      "id": "4",
      "sites": [
        {
          "id": "1",
          "name": "Site 1"
        },
        {
          "id": "2",
          "name": "Site 2"
        }
     ],
     "folders": [
        {
          "id": "1",
          "name": "Folder 1"
        },
        {
          "id": "2",
          "name": "Folder 2"
        }
     ],
      "schedule": {
        "rrule": "FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,WE,FR,SU",
        "initial_run_time": "2020-04-1T12:00:00Z",
        "name": "Name",
        "description": "Description"
      },
      "scheduled_run_time": "2020-04-10T12:00:00Z"
    }
  }
}