CreateAlertRuleRequest

  • channel
    Type: object · AlertRuleChannel
    required
    • type
      Type: integer · ChannelTypeenum
      required

      Integer numbers.

      values
      • 1

        Call

      • 2

        Sms

      • 3

        Telegram

      • 4

        Email

    • call
      Type: object · CallChannelOptions nullable
    • email
      Type: object · EmailChannelOptions nullable
    • sms
      Type: object · SmsChannelOptions nullable
    • telegram
      Type: object · TelegramChannelOptions nullable
  • recipient
    Type: object · Recipient
    required
    • culture
      required
    • phoneNumber
      Type: string
      required

      The phone number of the recipient in E.164 format (e.g. +1234567890).

    • timeZone
      required
    • description
      Type: null | string
  • dates
    Type: object · DateRange nullable

    The dates between which this alert rule is active, or null to disable this filter.

    • from
      Type: stringFormat: date
      required

      full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

    • to
      Type: stringFormat: date
      required

      full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

  • daysOfWeek
    Type: array integer[] | null · DayOfWeek[]enum

    The days of the week on which this alert rule is active, or null to disable this filter.

    values
    • 0
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • Type: integer · DayOfWeekenum

      Integer numbers.

      values
      • 0

        Sunday

      • 1

        Monday

      • 2

        Tuesday

      • 3

        Wednesday

      • 4

        Thursday

      • 5

        Friday

      • 6

        Saturday

  • insideGeofences
    Type: array string[] | null

    The geofences in any of which the asset must be for the alert rule to be active, or null to disable this filter.

  • isDisabled
    Type: null | boolean

    Indicates whether this alert rule is disabled, or null to disable this filter.

  • outsideGeofences
    Type: array string[] | null

    The geofences outside all of which the asset must be for the alert rule to be active, or null to disable this filter.

  • timeOfDay
    Type: object · TimeRange nullable

    The times of the day during which this alert rule is active, or null to disable this filter. Range may cross midnight (e.g. from 22:00 to 06:00).

    • from
      Type: stringFormat: time
      required

      Start time (00:00:00 - 23:59:59)

    • to
      Type: stringFormat: time
      required

      End time (00:00:00 - 23:59:59)