Skip to main content

Check

An Avantra check.

interface Check {
id: ID!
monitoring: Boolean
name: String!
status: Status!
statusId: Int!
system: MonitoredSystem!
result(
format: ResultMode = TEXT
maxLength: Int
): String
resultTyped: CheckResult!
confirmation: Confirmation
customer: Customer!
lastRefresh: DateTime
lastStatusChange: DateTime
kind: CheckKind!
type: CheckType!
history: [CheckHistoric]! @deprecated
notifications(
where: FilterInput
order: OrderInput
): [CheckNotification]!
pagedNotifications(
pageRequest: PageRequest!
where: FilterInput
order: OrderInput
): NotificationPage!
customCheck: CustomCheck
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!
cycleTime: Int!
enabledFeatures: CheckFeatures!
}

Fields

Check.id ● ID! non-null scalar

The ID of this check.

Check.monitoring ● Boolean scalar

The monitoring status during the last refresh

Check.name ● String! non-null scalar

The name of the check.

Check.status ● Status! non-null enum

The status of the check.

Check.statusId ● Int! non-null scalar

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

Check.system ● MonitoredSystem! non-null interface

To which monitored system this check belongs.

Check.result ● String scalar

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

Check.result.format ● ResultMode enum
Check.result.maxLength ● Int scalar

Check.resultTyped ● CheckResult! non-null object

A typed check result.

Check.confirmation ● Confirmation object

Confirmation information.

Check.customer ● Customer! non-null object

The customer this check belongs to.

Check.lastRefresh ● DateTime scalar

The last time the check got refreshed.

Check.lastStatusChange ● DateTime scalar

The last time when the status changed

Check.kind ● CheckKind! non-null enum

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

Check.type ● CheckType! non-null object

The type of this check.

Check.history ● [CheckHistoric]! deprecated non-null object

DEPRECATED

there is the new events API

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

Check.notifications ● [CheckNotification]! non-null object

Associated notifications for this check.

Check.notifications.where ● FilterInput input
Check.notifications.order ● OrderInput input

Check.pagedNotifications ● NotificationPage! non-null object

Associated notifications for this check.

Check.pagedNotifications.pageRequest ● PageRequest! non-null input
Check.pagedNotifications.where ● FilterInput input
Check.pagedNotifications.order ● OrderInput input

Check.customCheck ● CustomCheck object

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

Check.timeline ● [CheckTimelineItem!]! non-null interface

Check timeline

Check.timeline.filter ● FilterInput input
Check.timeline.order ● OrderInput input

Check.pagedTimeline ● CheckTimelineEventPage object

Check timeline paged

Check.pagedTimeline.pageRequest ● PageRequest! non-null input
Check.pagedTimeline.filter ● FilterInput input
Check.pagedTimeline.order ● OrderInput input

Check.timelineRelay ● CheckTimelineItemConnection object

Relay connection for timeline

Check.timelineRelay.first ● Int scalar
Check.timelineRelay.after ● String scalar
Check.timelineRelay.where ● FilterInput input
Check.timelineRelay.order ● OrderInput input

Check.timelineItem ● CheckTimelineItem interface

Get a single timeline item by id.

Check.timelineItem.id ● ID! non-null scalar

Check.notificationSettings ● NotificationSettings! non-null object

Notification settings for this check.

Check.cycleTime ● Int! non-null scalar

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

Check.enabledFeatures ● CheckFeatures! non-null object

Enabled features.

Returned By

check query ● checks query ● confirm mutation ● unconfirm mutation

Member Of

BusinessService object ● CheckConnectionEdge object ● CheckNotification object ● CheckPage object ● CloudService object ● CustomCheck object ● Customer object ● Database object ● MonitoredSystem interface ● MonitoringParameterGroup object ● SapBusinessObject object ● SapInstance object ● SapSystem object ● Server object

Implemented By

DailyCheckDetail object ● RtmCheck object