OBJECT

CustomGroup

Custom groups

link GraphQL Schema definition

  • type CustomGroup implements HasLocation {
  • # ID of the custom group
  • id: String!
  • # Name of the custom group
  • name: String!
  • # Type of group
  • groupType: CustomGroupType
  • # Expression of the custom group
  • expression: String
  • # Devices matching the custom group
  • #
  • # Arguments
  • # search: Search string for Omni-search
  • # pageSize: Size of a page
  • # page: Page number to return
  • # sortBy: Fields to sort results by
  • # sortOrder: Order to sort results by
  • # fromDate: Returns results updated after this time
  • relatedDevices(
  • search: String,
  • pageSize: Int,
  • page: Int,
  • sortBy: [String!],
  • sortOrder: SortingOrder,
  • fromDate: Date
  • ): DeviceList!
  • # Access points matching the custom group
  • #
  • # Arguments
  • # search: Search string for Omni-search
  • # pageSize: Size of a page
  • # page: Page number to return
  • # sortBy: Fields to sort results by
  • # sortOrder: Order to sort results by
  • # fromDate: Returns results updated after this time
  • relatedAccessPoints(
  • search: String,
  • pageSize: Int,
  • page: Int,
  • sortBy: [String!],
  • sortOrder: SortingOrder,
  • fromDate: Date
  • ): AccessPointList!
  • # Number of affected client hours for different incident metrics aggregated to
  • # this custom group
  • #
  • # Arguments
  • # metricCategory: Filter on an incident metric category
  • # metricIds: Filter on one or more incident metric IDs
  • affectedClientHours(
  • metricCategory: MetricCategory,
  • metricIds: [String!]
  • ): AffectedClientHours
  • # Location names
  • locationNames: [String!]!
  • }