Customer

An Avantra customer. NOTE: If the current user has no CUSTOMER_VIEW permission for this customer the fields 'id' and 'name' are available to be read.

type Customer {
  id: ID!
  name: String!
  sapCustomerNumber: String
  description: String
  remarks: String
  phone: String
  mobile: String
  fax: String
  email: String
  timezone: String
  address: String
  postbox: String
  postalCode: String
  city: String
  country: String
  timestamp: DateTime
  customerUrl: String
  customData: String
  guid: String
  parent: Customer
  children: [Customer]!
  childrenCount: Int!
  checks(
    where: FilterInput
    order: OrderInput
  ): [Check!]!
  checkCount(
    where: FilterInput
  ): Int!
  checksRelay(
    first: Int
    after: String
    where: FilterInput
    order: OrderInput
  ): CheckConnection
  systems(
    where: FilterInput
    order: OrderInput
  ): [MonitoredSystem!]!
  systemsCount(
    where: FilterInput
  ): Int!
  systemsRelay(
    first: Int
    after: String
    where: FilterInput
    order: OrderInput
  ): MonitoredSystemConnection
  systemsSummary(
    includeChildCustomer: Boolean = false
    monitoring: Boolean
    operational: Boolean
    where: FilterInput
  ): CustomerSystemSummary!
}

Fields

Customer.id ● ID! non-null scalar

The customer ID

Customer.name ● String! non-null scalar

The customer name

Customer.sapCustomerNumber ● String scalar

Customer.description ● String scalar

Customer.remarks ● String scalar

Customer.phone ● String scalar

Customer.mobile ● String scalar

Customer.fax ● String scalar

Customer.email ● String scalar

Customer.timezone ● String scalar

Customer.address ● String scalar

Customer.postbox ● String scalar

Customer.postalCode ● String scalar

Customer.city ● String scalar

Customer.country ● String scalar

Customer.timestamp ● DateTime scalar

Customer.customerUrl ● String scalar

Customer.customData ● String scalar

Customer.guid ● String scalar

Customer.parent ● Customer object

This customer's parent customer. If this is the root customer there is no parent customer.

Customer.children ● [Customer]! non-null object

Customer.childrenCount ● Int! non-null scalar

The number of child customers

Customer.checks ● [Check!]! non-null interface

Get all the available RTM checks for the given status selection. If the call should return different kind of checks the filter input has to be used with the explicit value for the kind field. If there is no kind filter field defined it defaults to: { name: "kind" operator: eq value: "RTM" }

Customer.checks.where ● FilterInput input

The filter conditions for this query.

Customer.checks.order ● OrderInput input

Customer.checkCount ● Int! non-null scalar

Count the affected checks.

Customer.checkCount.where ● FilterInput input

The filter conditions for this query.

Customer.checksRelay ● CheckConnection object

Customer.checksRelay.first ● Int scalar

Customer.checksRelay.after ● String scalar

Customer.checksRelay.where ● FilterInput input

Customer.checksRelay.order ● OrderInput input

Customer.systems ● [MonitoredSystem!]! non-null interface

Get all the available monitored systems for the given status selection.

Customer.systems.where ● FilterInput input

Filter for monitored systems

Customer.systems.order ● OrderInput input

Customer.systemsCount ● Int! non-null scalar

Count the systems affected by the filter.

Customer.systemsCount.where ● FilterInput input

Filter for monitored systems

Customer.systemsRelay ● MonitoredSystemConnection object

Customer.systemsRelay.first ● Int scalar

Customer.systemsRelay.after ● String scalar

Customer.systemsRelay.where ● FilterInput input

Filter for monitored systems

Customer.systemsRelay.order ● OrderInput input

The order of the result

Customer.systemsSummary ● CustomerSystemSummary! non-null object

Request summarizing information about this customer (system role, system type counts).

Customer.systemsSummary.includeChildCustomer ● Boolean scalar

Whether to include child customers in the system count or not.

Customer.systemsSummary.monitoring ● Boolean scalar

Whether to filter on the monitoring status if null is set monitored as well as non-monitored systems are returned.

Customer.systemsSummary.operational ● Boolean scalar

Whether to filter on the operational status of a monitored system if null is set monitored as well as non-monitored systems are returned.

Customer.systemsSummary.where ● FilterInput input

Filter the monitored systems

Returned By

customer query ● customers query

Member Of

AutomationExecution object ● AutomationJob object ● BusinessService object ● CcmsAlertNotification object ● ChangeNotification object ● Check interface ● CheckHistoric object ● CheckNotification object ● CheckSelector object ● CloudService object ● CloudServiceAuthentication object ● CompositeCheck object ● Credentials object ● CredentialsPurpose object ● CustomCheck object ● Customer object ● CustomerConnectionEdge object ● CustomerReference object ● CustomersForPermission object ● DailyCheckDetail object ● DailyCheckNotification object ● Dashboard object ● DashboardSharing object ● Database object ● HotNewsNotification object ● MonitoredSystem interface ● MonitoringParameterSet object ● Notification interface ● Proxy object ● Role object ● RtmCheck object ● SapBusinessObject object ● SapInstance object ● SapSystem object ● Selector object ● SelectorBase interface ● Server object ● ServerEventNotification object ● SystemSelector object ● TicketNotification object ● User object ● WorkflowStepEventNotification object