Overview of BMC Impact Integration Web Services API

The BMC Impact Integration Web Services server passes events from event providers to a BMC Impact Manager cell or third-party application.

WSDL file and SOAP messages

BMC Impact Integration Web Services exposes its APIs through its wsdl files. It uses the document literal style of the SOAP messaging format to communicate with client programs. For more information, see BMC Impact Integration Web Services reference.

API

The following table lists the names and descriptions for the BMC Impact Integration Web Services server APIs.

BMC Impact Integration Web Services server API

Operation

Description

Connecting cells
Connect

Requests BMC Impact Integration Web Services to connect with specific instances in the BMC Impact Manager network

Disconnect

Requests BMC Impact Integration Web Services to disconnect from a connected instance

GetCellInfo

Obtains information about the BMC Impact Manager cells known by the BMC Impact Integration Web Services server

Send events

SendEvent

Sends an event to a connected BMC Impact Manager cell

Query events, data, and service models

EndQuery

Requests to end the query

GetQueryChangedResultCount

Used in an open query to periodically check for any results changes in the query range

GetQueryResultCount

Tallies the total number of events or data objects that the BMC Impact Integration Web Services server has retrieved in response to a query

QueryCausalEvents

Retrieves all causal events impacting a particular component and all underlying providers

QueryClassDefinitions

Retrieves the class and slot definitions of a specific base class and its subclasses

QueryData

Connects to a specific BMC Impact Manager cell and queries for data

QueryComponent

Connects to a specific BMC Impact Manager cell and retrieves the component data attributes

QueryComponentProvidersConnects to a specific BMC Impact Manager cell and queries for the providers of a component
QueryComponentStatusProvidersConnects to a specific BMC Impact Manager cell and queries for the providers that impact the status of a component

QueryComponentsByCondition

Connects to a specific BMC Impact Manager cell and queries for components by a specific condition

QueryComponentsByStatus

Connects to a specific BMC Impact Manager cell and queries for components by a specific status

QueryComponentEvents

Connects to a specific BMC Impact Manager cell and retrieves events associated with a component object

QueryComponentStatus

Connects to a specific BMC Impact Manager cell and queries for the status of specific components

QueryEvents

Connects to a specific BMC Impact Manager cell and queries for events

QueryEventsByDate

Connects to a specific BMC Impact Manager cell and queries for events that occurred within a specific date range

QueryEventByID

Connects to a specific BMC Impact Manager cell and queries for specific events by ID

QueryModelImpact

Retrieves possible consumer components of a specified component

QueryModelPossibleRootCause

Retrieves a component or components that have either an immediate, direct relationship with the specified component or a status that was propagated to the component.

RetrieveQueryResults

Retrieves the results that are returned for a query

UnregisterStateChange

Remove integration with a cell, which stops the receipt of state change events

RegisterStateChange

Registers integration with a cell, which enables receipt of state change events

SetMaintenanceMode

Sends a request to place a specified component in maintenance mode

SetManualStatus

Sends a request to set a designated manual status on the specified component

Subscribe events

AckEvents

Directs the web service client to notify the BMC Impact Integration Web Services server that it has received the events

GetEvents

Enables the web service client to poll events from the BMC Impact Integration Web Services server gateway

Subscribe

Allows the web service client to specify which event types it wants to receive. It opens the gateway server in BMC Impact Integration Web Services server to receive events from the cell.

Unsubscribe

Enables the web service client to stop its subscription to specified events.

GetFilterNames

Retrieves the names of the available selectors to which the client can subscribe

Was this page helpful? Yes No Submitting... Thank you

Comments