Magidoc

Query
Object

Fields

#

performanceResourceTypes

Non-null

pagedPerformanceResourceTypes

performanceResources

Non-null

performanceResourcesRelay

performanceValues

Non-null

performanceValuesRelay

serviceLevelAgreements

Non-null

Returns all the available service level agreements.

roles

[ Role ]

role

users

[ User ]

Query all users.

user

Query user by his id.

validatePassword

currentUser

Returns the currently logged on user alongside with its permissions.

currentUserPermissionOnCustomers

Non-null

This query returns the list of customers for which the current user has the permission given by permissionName. E.g. to get the list of customer for which the current user has the permission 'SYSTEM_VIEW' the query would look like:

query { currentUserPermissionOnCustomers(permissionName:'SYSTEM_VIEW') { id label } }

If the permission is invalid an error will be returned.

usersForCustomerAndWithPermission

Non-null

Get a list of users for a customer ID and a permission.

selectorAttributes

Get a list of allowed selector attributes for the given object type.

selectorAttribute

Get one selector attribute for the given object type and id.

getPublicSystemSelectors

Provides all pre-defined system selectors

getPublicCheckSelectors

Provides all pre-defined check selectors. Use following types null: to return all check selectors rtm only checks: 1000 daily check details: 1001 all checks: 1002 dailys checks only: 1003

checks

[ Check !]!
Non-null

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" }

checkCount

Non-null

Count the affected checks.

check

Get a check by ID. As a default it tries to return a RTM check.

checkTypes

get all visible check types

customChecks

get all visible custom checks

compositeChecks

get all visible composite checks

pagedChecks

The paged variant of the checks query

checkSelectors

Non-null

Get all the system selector visible for the current user.

checkSelector

Get the check selector for the given ID if it is available.

ping

Non-null

applicationTypes

Non-null

Get all the available application types.

groups

[ Group ]

group

customAttributeDefinitions

Non-null

Get all the custom attribute definition.

customAttributeDefinition

Get a single custom attribute definition.

globalPerformanceResources

Non-null

pagedGlobalPerformanceResources

globalPerformanceResource

globalPerformanceValues

Non-null

sapNotes

customers

[ Customer !]!
Non-null

customersRelay

customer

customersCount

Non-null

systemRoles

systemRole

proxies

[ Proxy !]!
Non-null

Get all the available proxies.

proxiesAssignableToSystems

Non-null

Get all the proxy objects that are assignable to a monitored system for the currently logged on user.

systemSelectors

Non-null

Get all the system selector visible for the current user.

systemSelector

Get the system selector for the given ID if it is available.

creatableDashletTypes

dashboard

dashboards

dashboardValues

provides the data used to render the dashlets

dashboardValuesEx

public List dashboardValuesEx(Integer customerId, String definition, List dashletUuids) { provides dashlet data used in edit mode

automationJob

automationJobs

Non-null

automationExecution

get runtime information about a current execution

automationExecutions

Non-null

getAvailableAutomationActionTypes

get all automation actions which are available for the given system

executeAutomationAction

execute an automation action on the given system. Returns the automation execution ID call automationExecutions to retrieve runtime information

chartTypes

return the defined chart types (definitions.xml and custom charts)

chartData

return the chart data used to render a real chart

businessObjects

Non-null

businessObject

pagedBusinessObjects

cloudServices

Non-null

cloudService

pagedCloudServices

sapNeoRegions

Non-null

Get all the SAP NEO regions.

sapInstances

Non-null

sapInstance

pagedSapInstances

sapInstanceTypes

Get all the SAP instance types available.

databases

[ Database !]!
Non-null

database

pagedDatabases

databaseTypes

Non-null

Get the available database types.

dnsDomains

Non-null

businessService

businessServices

Non-null

pagedBusinessService

businessServiceNodes

servers

[ Server !]!
Non-null

server

pagedServers

cloudServiceAuthentications

Non-null

Get all the available cloud service authentication object to be used with servers. Parameter:

  • cloudType (optional): if set the query will only return cloud service authentication for a specific cloud type. Otherwise all visible are returned.

switchMonitoringDependentSystems

Find all the dependent systems in case of a monitoring switch.

system

Get one monitored system for the given ID.

systems

Non-null

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

pagedSystems

Non-null

This is the paged variant of the systems query. If the requested page does not exist an error will be raised.

systemsCount

Non-null

Count the systems affected by the filter.

systemsRelay

sapSystems

Non-null

sapSystem

pagedSapSystems

credentials

Non-null

credential

workflow

Find a workflow by its name and namespace.

workflows

[ Workflow !]!
Non-null

Get all the workflows the authenticated user has access to. The query offers some filter like the namespace of the workflows and whether they posses any variant or not.

workflowExecutionsByWorkflowId

Non-null

Get workflow executions for an workflow given its ID.

workflowExecutionsByWorkflowName

Non-null

Get workflow executions for an workflow given its namespace and name.

workflowExecutionCountByWorkflowVariant

Non-null

Get workflow execution count for an workflow variant.

workflowExecutionsByWorkflowVariant

Non-null

Get workflow executions for an workflow variant.

workflowExecution

Get a workflow execution for an ID.

workflowExecutionSetSummary

Non-null

Get a summary of a set of executions. NOTE: This query does not check whether all the execution IDs come from the same workflow. It will just generate the summary for the given IDs.

mobileNotification

mobileNotifications

Non-null

mobileNotificationRelay

change

Change by id

changeComponents

Non-null

All the available change component types.

changeReasons

Non-null

All the available change reasons.