Skip to main content

# RtmCheck

No description

    type RtmCheck implements Check {
      id: ID!
      monitoring: Boolean
      name: String!
      status: Status!
      statusId: Int!
      system: MonitoredSystem!
      result(
        format: ResultMode = TEXT
        maxLength: Int
      ): String
      confirmation: Confirmation
      customer: Customer!
      lastRefresh: DateTime
      lastStatusChange: DateTime
      kind: CheckKind!
      type: CheckType!
      resultTyped: CheckResult!
      history: [CheckHistoric]!
      notifications(
        where: FilterInput
        order: OrderInput
      ): [CheckNotification]!
      pagedNotifications(
        pageRequest: PageRequest!
        where: FilterInput
        order: OrderInput
      ): NotificationPage!
      customCheck: CustomCheck
      cycleTime: Int!
      timeline(
        filter: FilterInput
        order: OrderInput
      ): [CheckTimelineItem!]!
      pagedTimeline(
        pageRequest: PageRequest!
        filter: FilterInput
        order: OrderInput
      ): CheckTimelineEventPage
      timelineRelay(
        first: Int
        after: String
        where: FilterInput
        order: OrderInput
      ): CheckTimelineItemConnection
      timelineItem(
        id: ID!
      ): CheckTimelineItem
      notificationSettings: NotificationSettings!
      enabledFeatures: CheckFeatures!
    }

### Fields​

#### `RtmCheck.id` ● `ID!` non-null scalar​

The ID of this check.

#### `RtmCheck.monitoring` ● `Boolean` scalar​

The monitoring status during the last refresh

#### `RtmCheck.name` ● `String!` non-null scalar​

The name of the check.

#### `RtmCheck.status` ● `Status!` non-null enum​

The status of the check.

#### `RtmCheck.statusId` ● `Int!` non-null scalar​

The check status as number: 2 => CRITICAL 1 => WARNING 0 => OK -1 => UNKNOWN -2 => DISABLED

#### `RtmCheck.system` ● `MonitoredSystem!` non-null interface​

To which monitored system this check belongs.

#### `RtmCheck.result` ● `String` scalar​

The result of this check. If it is fetch the user can decide which format he/she wants.

##### `RtmCheck.result.format` ● `ResultMode` enum​

##### `RtmCheck.result.maxLength` ● `Int` scalar​

#### `RtmCheck.confirmation` ● `Confirmation` object​

Confirmation information.

#### `RtmCheck.customer` ● `Customer!` non-null object​

The customer this check belongs to.

#### `RtmCheck.lastRefresh` ● `DateTime` scalar​

The last time the check got refreshed.

#### `RtmCheck.lastStatusChange` ● `DateTime` scalar​

The last time when the status changed

#### `RtmCheck.kind` ● `CheckKind!` non-null enum​

What kind of check is it. At the moment the possible values are RTM, DAILY_CHECK_DETAIL.

#### `RtmCheck.type` ● `CheckType!` non-null object​

The type of this check.

#### `RtmCheck.resultTyped` ● `CheckResult!` non-null object​

A typed check result.

#### `RtmCheck.history` ● `[CheckHistoric]!` non-null object​

The history of this check. The history of a historic check itself will be empty. The order of the list is newer to older.

#### `RtmCheck.notifications` ● `[CheckNotification]!` non-null object​

Associated notifications for this check.

##### `RtmCheck.notifications.where` ● `FilterInput` input​

##### `RtmCheck.notifications.order` ● `OrderInput` input​

#### `RtmCheck.pagedNotifications` ● `NotificationPage!` non-null object​

##### `RtmCheck.pagedNotifications.pageRequest` ● `PageRequest!` non-null input​

##### `RtmCheck.pagedNotifications.where` ● `FilterInput` input​

##### `RtmCheck.pagedNotifications.order` ● `OrderInput` input​

#### `RtmCheck.customCheck` ● `CustomCheck` object​

Linked custom check. If this check is not managed by a custom check this will be null.

#### `RtmCheck.cycleTime` ● `Int!` non-null scalar​

This checks cycle time in minutes. That is the interval for which the check is refreshed.

#### `RtmCheck.timeline` ● `[CheckTimelineItem!]!` non-null interface​

Check timeline

##### `RtmCheck.timeline.filter` ● `FilterInput` input​

##### `RtmCheck.timeline.order` ● `OrderInput` input​

#### `RtmCheck.pagedTimeline` ● `CheckTimelineEventPage` object​

Check timeline paged

##### `RtmCheck.pagedTimeline.pageRequest` ● `PageRequest!` non-null input​

##### `RtmCheck.pagedTimeline.filter` ● `FilterInput` input​

##### `RtmCheck.pagedTimeline.order` ● `OrderInput` input​

#### `RtmCheck.timelineRelay` ● `CheckTimelineItemConnection` object​

Relay connection for timeline

##### `RtmCheck.timelineRelay.first` ● `Int` scalar​

##### `RtmCheck.timelineRelay.after` ● `String` scalar​

##### `RtmCheck.timelineRelay.where` ● `FilterInput` input​

##### `RtmCheck.timelineRelay.order` ● `OrderInput` input​

#### `RtmCheck.timelineItem` ● `CheckTimelineItem` interface​

Get a single timeline item by id.

##### `RtmCheck.timelineItem.id` ● `ID!` non-null scalar​

#### `RtmCheck.notificationSettings` ● `NotificationSettings!` non-null object​

Notification settings for this check.

#### `RtmCheck.enabledFeatures` ● `CheckFeatures!` non-null object​

Enabled features.

### Interfaces​

#### `Check` interface​

An Avantra check.