Elements

The following table describes the elements that the < wsdl:types > section exposes. These elements are derived from built-in, simple, and complex data types.

Elements

Element

Built-in Data Type

Simple Type

Complex Type

baseClass

string

--

--

bufferType

--

IMBufferType

--

CellInfo_Array

--

--

ArrayOf_CellInfo

ClassDefInfo_Array

--

--

ArrayOf_ClassDefInfo

ClassDefInfo_element

--

--

ClassDefInfo

className

string

--

--

classNames

string

--

--

classOnly

boolean

--

--

comment

string

--

--

componentCauseId

string

--

--

componentId

string

--

--

componentStatus

string

--

--

componentStatusId

string

--

--

condition

string

--

--

connection

long

--

--

connectionId

long

--

--

context

string

--

--

context_nio

string

--

--

deleteBuffer

boolean

--

--

endDate

string

--

--

errorCode

int

--

--

eventID

string

--

--

filterName

string

--

--

GetEventsResponse_ element

--

--

GetEventsResponse

GetQueryResultResponse_element

--

--

GetQueryResultResponse

getSubclasses

boolean

--

--

imFailure

string

--

--

imname

string

--

--

long_Response

long

--

--

message

--

--

Event

messageClass

string

--

--

messageID

string

--

--

messageType

--

IMMessageType

--

modeToSet

string

--

--

num_of_components

int

--

--

num_of_events

int

--

--

num_of_results

int

--

--

onlyImpacted

boolean

--

--

password

string

--

--

query

string

--

--

QueryMode_element

--

--

QueryMode

query_ev

string

--

--

regID

string

--

--

reliable

boolean

--

--

resultCode

int

--

--

resultHandle

string

--

--

retrieveResultHandle

string

--

--

securityToken

string

--

--

serverName

string

--

--

setOrCleared

boolean

--

--

SlotDefInfo_Array

--

--

ArrayOf_SlotDefInfo

SlotDefInfo_element

--

--

SlotDefInfo

slotsList

string

--

--

SMComponent_element

--

--

SMComponent

SMComponentArray_ element

--

--

ArrayOf_SMComponent

startDate

string

--

--

startIndex

long

--

--

StateChangeType_ element

--

--

StateChangeType

timeout

int

--

--

trueCause

boolean

--

--

userName

string

--

--

baseClass

 This element is used as an input parameter in the QueryComponentsByStatus and QueryClassDefinitions query operations. The baseClass value specifies the class at which the query starts.The declaration for the element baseClass is shown as follows:

<xsd:element name="baseClass" nillable="true" type="xsd:string"/>

bufferType

The element declaration for the element bufferType is shown as follows:

<xsd:element name="bufferType" nillable="true"
	type="tns:IMBufferType"/>

The bufferType element specifies one of the enumerated buffering routines defined under the simple type definition of IMBufferType in this namespace. The simple type from which the element is defined uses the built-in type string. The bufferType element is valid even when it carries no content. The bufferType element is part of the Connect_Request message.

For more information about the underlying simple type, see the description of the simple type IMBufferType under IMBufferType.

CellInfo_Array

The < wsdl:types > section describes the CellInfo_Array element. Its element declaration is shown as follows:

<xsd:element name="CellInfo_Array"
	type="tns:ArrayOf_CellInfo"/>

The CellInfo_Array element is defined from the complex type ArrayOf_CellInfo.

For more information about the underlying complex type, see the description of the ArrayOf_CellInfo complex type under ArrayOf_CellInfo.

ClassDefInfo_Array

The element declaration for the element ClassDefInfo_Array is shown as follows:

<xsd:element name="ClassDefInfo_Array"
type="tns:ArrayOf_ClassDefInfo"/>

This element references the complex type ArrayOf_ClassDefInfo, described in ArrayOf_ClassDefInfo.

ClassDefInfo_element

The element declaration for the element ClassDefInfo_element is as follows:

<xsd:element name="ClassDefInfo_element" type="tns:ClassDefInfo"/>

This element references the complex type ClassDefInfo, described in ClassDefInfo.

className

The element declaration for className is shown as follows:

<xsd:element name="className" nillable="true" type="xsd:string"/>

Used in the QueryClassDefinitions operation, the className parameter specifies the name of a particular class definition for the query to retrieve.

classNames

The element declaration for the element classNames is as follows:

<xsd:element name="classNames" nillable="true"
	type="xsd:string"/>

classOnly

The declaration for the Boolean element classOnly is as follows.

<xsd:element name="classOnly" type="xsd:boolean"/>

Used in the QueryClassDefinitions operation, the classOnly element, if set to true, restricts the query to return class definitions only, not slots or slot definitions.

comment

The declaration for the element comment is as folllows:

<xsd:element name="comment" nillable="true" type="xsd:string"/>

The comment element is used as input parameter in the SetMaintenanceMode and SetManualStatus operations. You can include explanatory text about the reason for setting the maintenance mode or the manual status of the component.

componentCauseId

The declaration for the element componentCauseId is as follows:

<xsd:element name="componentCauseId" nillable="true" type="xsd:string"/>

componentId

The declaration for the element componentId is as follows:

<xsd:element name="componentId" nillable="true" type="xsd:string"/>

The componentId parameter is used in several queries and operations. It specifies the universal data ID (mc_udid) of the component object to be retrieved.

componentStatus

The declaration for the element componentStatus is as follows:

<xsd:element name="componentStatus" nillable="true" type="xsd:string"/>

The element componentStatus is used as a parameter for queries and operations. It specifies one of the computed statuses of a component: status, self_status, computed_status, impact_status, and manual_status.

componentStatusId

The declaration for the element componentStatusId is as follows:

<xsd:element name="componentStatusId" nillable="true" type="xsd:string"/>

condition

The element declaration for the element condition is as follows:

<xsd:element name="condition" nillable="true" type="xsd:string"/>

Used as an input parameter in the QueryComponentsByCondition operation, the condition element specifies the selection criteria for a component. It specifies the selection criteria in a where clause that follows Master Rule Language syntax and conventions.

connection

The < wsdl:types > section contains the element declaration for the element connection.

<xsd:element name="connection" type="xsd:long"/>

The connection value is the long integer assigned to a specific BMC Impact Manager instance connection request. (See also the connectionId element.) It is defined by the built-in type long. The connection element is part of the following messages:

  • Disconnect_Request
  • SendEvent_Request

connectionId

The < wsdl:types > section contains the element declaration for the element connectionId.

<xsd:element name="connectionId" type="xsd:long"/>

The connectionId value is a long integer (with a minimum value of -9223372036854775808 and maximum of 9223372036854775807) assigned to a specific BMC Impact Manager instance connection request. It is defined by the built-in type long. The connectionId element is part of the following messages:

  • Connect_Request
  • Connect_Response

context

The < wsdl:types > section contains the element declaration for the element context.

<xsd:element name="context" nillable="true"
	type="xsd:string"/>

The context value is a literal or string representation (called the context ID) that identifies the web service client. It is defined by the built-in type string. It is valid even when it carries no content. The context element is part of the following messages:

  • Subscribe_Request
  • Unsubscribe_Request

context_nio

The declaration for the element context_nio is as follows:

<xsd:element name="context_ack" nillable="true" type="xsd:string"/>

The context_nio element is used to specify web service clients in GetEvents and AckEvents operations.

Cstatus_element

The declaration for the element Cstatus_element is as follows:

<xsd:element name="Cstatus_element"type="tns:CStatus"/>

The Cstatus_element references the complex type CStatus, which is described in CStatus.

cStatusHigh

The declaration for the element cStatusHigh is as follows:

<xsd:element name="cStatusHigh" nillable="true" type="xsd:string"/>

Used as a parameter in the QueryComponentsByStatus operation, it designates the highest component status value taken from the status values of self_status, computed_status, impact_status, and manual_status.

The CStatusHigh and CStatusLow parameter values define a range of values.

cStatusLow

The declaration for the element cStatusLow is as follows:

<xsd:element name="cStatusLow" nillable="true" type="xsd:string"/>


Also used as a parameter in the QueryComponentsByStatus operation, it designates the lowest component status value taken from the status values of self_status, computed_status, impact_status, and manual_status.

deleteBuffer

The < wsdl:types > section contains the element declaration for the element deleteBuffer.

<xsd:element name="deleteBuffer" type="xsd:boolean"/>


The deleteBuffer value is a Boolean indicator that tells whether to delete the persistent buffer (where the events and data are stored) when the web service disconnects from the BMC Impact Manager instance. It is defined by the built-in type boolean. The deleteBuffer element is part of the Disconnect_Request message.

endDate

The < wsdl:types > section contains the element declaration for the element endDate. Its element declaration is as folllows:

<xsd:element name="endDate" nillable="true"
	type="xsd:dateTime"/>

The endDate value is defined by the built-in type dateTime. It is valid even when it carries no content. Used in query requests by the web service client, the endDate element defines a specific date and time, typically in GMT. The web service client uses the endDate element, along with the startDate element, to make a query for events within a specified time frame. The endDate element is part of the QueryEventsByDate_Request message.

errorCode

The declaration for the element errorCode is as follows:

<xsd:element name="errorCode" nillable="true" type="xsd:int"/>

The errorCode element contains an integer that represents a BMC Impact Integration Web Services server error message. The SetManualStatus and SetMaintenanceMode operations return error codes in their responses.

eventID

The declaration for the element eventID is as folllows:

<xsd:element name="eventID" nillable="true" type="xsd:string"/>

The event ID specifies the unique event identifier (mc_ueid) associated with the event that the client is requesting.

filterName

The < wsdl:types > section contains the element declaration for the element filterName.

<xsd:element name="filterName" nillable="true"
	type="xsd:string"/>

The filterName value defines the name of the event filter (also called the selector ) to which the web service client subscribes. Events that match the criteria of the specified selector are dispatched to the web service client. This element is defined by the built-in type string. It is valid even when it carries no content. The filterName element is part of the following messages:

  • Subscribe_Request
  • Unsubscribe_Request

GetEventsResponse_element

The declaration for the element GetEventsResponse_element is as folllows:

<xsd:element name="GetEventsResponse_element" nillable="true"
	type="tns:GetEventsResponse"/>

The GetEventsResponse_element references the complex type GetEventsResponse, described in GetEventsResponse.

GetQueryResultResponse_element

The declaration for the element GetQueryResultResponse_element is as follows:

<xsd:element name="GetQueryResultResponse_element" nillable="true"
	type="tns:GetQueryResultResponse"/>

The GetQueryResultResponse element references the complex type GetQueryResultResponse, described in GetQueryResultResponse.

getSubclasses

The declaration for the Boolean element getSubclasses is as folllows:

<xsd:element name="getSubclasses"type="xsd:boolean"/>

Used as Boolean indicator in the QueryComponentsByStatus operation, it indicates whether to extend the query to the subclasses of the designated base class.

imFailure

The declaration for the element imFailure is as follows:

<xsd:element name="imFailure" nillable="true" type="xsd:string"/>

The element imFailure is used in fault messages as the parameter that contains the fault error.

imName

The < wsdl:types > section contains the element declaration for the element imName.

<xsd:element name="imName" nillable="true" type="xsd:string"/>

The imname element specifies the name of the BMC Impact Manager instance. It is defined by the built-in type string. It is valid even when it carries no content. The imname element is part of the Connect_Request message.

long_Response

The < wsdl:types > section contains the element declaration for the element long_Response.

<xsd:element name="long_Response" type="xsd:long"/>

The long_Response value is the long integer that represents the response element received from the web services component. It is defined by the built-in type long. The long_Response element is part of the Connect_Response message.

message

The < wsdl:types > section contains the element declaration for the element message. Its element declaration is shown as follows:

<xsd:element name="message" nillable="true"
	type="event:Event"/>

The message element contains the event information exchanged between BMC Impact Integration Web Services and the BMC Impact Manager instance. Its data type is a complex type called Event, defined in the schema definition file Event.xsd. This element of type Event is valid even when it carries no content. The message element is part of the SendEvent_Request message.

For more information about the underlying complex type,see the description of the Event complex type under Event.

messageClass

The < wsdl:types > section contains the element declaration for the element messageClass.

<xsd:element name="messageClass" type="xsd:string"/>

The messageClass value specifies the name of the class of the event or data. The value can be any valid class name. It is defined by the built-in type string. The messageClass element is part of the SendEvent_Request message.

messageID

The < wsdl:types > section contains the element declaration for the element messageID. Its element declaration is as follows:

<xsd:element name="messageID" nillable="true"
	type="xsd:string"/>

The messageID value is defined by the built-in type string. It is valid even when it carries no content. Used in query operations, the messageID element represents the event ID or data ID of the information for which the web service client is inquiring. The messageID is part of the QueryEventByID_Request messages.

messageType

The < wsdl:types > section contains the element declaration for the element messageType.

<xsd:element name="messageType" nillable="true"
	type="tns:IMMessageType"/>

The messageType element specifies one of the enumerated message types defined under the simple type definition of IMMessageType in this namespace. The simple type from which the element is defined uses the built-in type string. The messageType element is valid even when it carries no content. Used to send event or data information, the messagetype element is part of the SendEvent_Request message.

See the description of the simple type IMMessageType under IMMessageType for more information about the underlying simple type.

modeToSet

The declaration for the element modeToSet is shown as follows:

<xsd:element name="modeToSet" nillable="true" type="xsd:string"/>

Used as an input parameter in the SetMaintenanceMode operation, it defines the maintenance mode that the operation will set.

num_of_components

The declaration for the element num_of_components is as follows:

<xsd:element name="num_of_components" type="xsd:int"/>

The num_of_components element is an integer that indicates the number of components that a query returns.

num_of_events

The < wsdl:types > section contains the element declaration for the element num_of_events.

<xsd:element name="num_of_events" type="xsd:int"/>

Used in query and polling operations, the num_of_events element represents both an input and an output argument. It is part of the GetEvents_Request and Response messages. Its value is an integer that defines the number of events that the web service client has requested and the number of events that the server is able to return per polling call or query.

The value of the request (the input argument) and the value of the response (the output argument) can be different.

When used in query operations, the num_of_events element is implemented with the startIndex element. For more information, see startIndex.

num_of_results

The declaration for the element num_of_results is as follows:

<xsd:element name="num_of_results" type="xsd:int"/>

Used as an input parameter in the RetrieveQueryResults operation, it specifies the number of query results that are requested.

onlyImpacted

The declaration for the element onlyImpacted is as follows:

<xsd:element name="onlyImpacted" type="xsd:boolean"/>

The Boolean element onlyImpacted indicates whether the query is restricted to those events that affect the mode of the component (impact events), and not direct events that originate from the component. The onlyImpacted parameter is used in the QueryComponentEvent operation.

password

The < wsdl:types > section contains the element declaration for the element password.

<xsd:element name="password" nillable="true"
	type="xsd:string"/>

The password element specifies the password that is defined for a BMC Impact Manager instance. It is defined by the built-in type string. It is valid even when it carries no content. The password element is part of the Connect_Request message.

query

The < wsdl:types > section contains the element declaration for the element query. Its element declaration is as follows:

<xsd:element name="query" nillable="true"
	type="xsd:string"/>

The query value is defined by the built-in type string. It is valid even when it carries no content. The web service client uses the query element to connect with specific BMC Impact Manager instances and initiate query requests for events or data.

Note

The query contents have to be a valid Impact Manager cell communication command for data and event manipulation. The syntax for the communication command is not within the scope of this documentation. Client developer needs to be familiar with cell communication commands to construct the query.

The query element is part of the QueryEvents_Request and the QueryData_Request messages.

QueryMode_element

The declaration for the element QueryMode_element is as follows.

<xsd:element name="QueryMode_element" type="tns:QueryMode"/>

The QueryMode_element references the simple type QueryMode, described in QueryMode.

regID

The declaration for the element regID is as follows:

<xsd:element name="regID" nillable="true" type="xsd:string"/>

The regID element is the registration ID assigned to registration requests that are part of the RegisterStateChange and UnregisterStateChange operations. The registration ID is used to associate your integration component with the data instance that the RegisterStateChange operation creates in the BMC SIM cell.

reliable

The declaration for the element reliable is as follows:

<xsd:element name="reliable" type="xsd:boolean"/>

The Boolean indicator reliable is used in subscription requests to guarantee delivery of messages and to persist messages when the connections among the web service client, BMC Impact Integration Web Services server, and the C APIs are disrupted.

resultCode

The declaration for the element resultCode is as follows.

<xsd:element name="resultCode" type="xsd:int"/>

The resultCode element contains an integer that specifies the server response to the unregister state change request.

resultHandle

The < wsdl:types > section contains the element declaration for the element resultHandle. Its element declaration is as follows:

<xsd:element name="resultHandle" nillable="true"
	type="xsd:string"/>

The resultHandle value is defined by the built-in type string. It is valid even when it carries no content. The resultHandle element refers to an ID that the web service client attaches to its query requests. This ID is taken from the resultHandle value that the server sends to the client in its initial query response. The client uses the resultHandle element to identify a series of query requests in a query cycle.

It is part of the following query request messages:

  • GetQueryResultCount_Request
  • EndQuery_Request

Example

The web service client initiates a _queryEvents_Request. The BMC Impact Integration Web Services server responds with a resultHandle of 100. The _getQueryResultCount and _endQuery request messages that the client launches in the same query cycle carry the same resultHandle value of 100.

retrieveResultHandle

The declaration for the element retrieveResultHandle is as follows:

<xsd:element name="retrieveResultHandle" nillable="true" type="xsd:string"/>

Used in query requests, the retrieveResultHandle element contains a string type that contains the ID returned by the server's response to the initial query request. This ID is attached to all query requests in the query cycle.

securityToken

The declaration for the element securityToken is as follows:

<xsd:element name="securityToken" nillable="true" type="xsd:string"/>

The securityToken element is a placeholder for future security implementations.

serverName

The declaration for the element serverName is as follows:

<xsd:element name="serverName" nillable="true" type="xsd:string"/>

The serverName element is a string type that specifies the name of the BMC Impact Integration Web Services server that will be receiving the state change events through the RegisterStateChange operation.

setOrCleared

The declaration for the element setOrCleared is as follows:

<xsd:element name="setOrCleared" type="xsd:boolean"/>

Used in the bmiiws_setMaintenanceMode operation, the setOrCleared Boolean indicator specifies whether the selected component is available to have its maintenance mode set.

SlotDefInfo_Array

The declaration for the element SlotDefInfo_Array is as follows:

<xsd:element name="SlotDefInfo_Array"
type="tns:ArrayOf_SlotDefInfo"/>

The element SlotDefInfo_Array references the complex type, ArrayOf_SlotDefInfo, defined on ArrayOf_SlotDefInfo.

SlotDefInfo_element

The declaration for the element SlotDefInfo_element is as follows:

<xsd:element name="SlotDefInfo_element"type="tns:SlotDefInfo"/>

The SlotDefInfo_element references the complex type SlotDefInfo, described in SlotDefInfo.

slotsList

The declaration for the element slotsList is as follows:

<xsd:element name="slotsList" nillable="true" type="xsd:string"/>

The slotsList is an output parameter for several queries. It is a string description that specifies the slot name or names, the values for which the query returns. The slot names in the string are separated by commas, as in ','. See also the complex type SlotDefInfo on SlotDefInfo for more information.

SMComponent_element

The declaration for the element SMComponent_element is as follows:

<xsd:element name="SMComponent_element" type="tns:SMComponent"/>

The SMComponent_element references the complex type SMComponent, described in SMComponent.

SMComponentArray_element

The declaration for the element SMComponentArray_element is as follows:

<xsd:element name="SMComponentArray_element"
type="tns:ArrayOf_SMComponent"/>

The SMComponentArray_element references the complex type ArrayOf_SMComponent, described in ArrayOf_SMComponent.

startDate

The < wsdl:types > section contains the element declaration for the element startDate. Its element declaration is as follows:

<xsd:element name="startDate" nillable="true"
	type="xsd:dateTime"/>

The startDate value is defined by the built-in type dateTime. It is valid even when it carries no content. Used in query requests by the web service client, the startDate element defines a specific date and time, typically in GMT. The web service client uses the startDate element, along with the endDate element, to make a query for events within a specified time frame. The startDate element is part of the QueryEventsByDate_Request message.

startIndex

The < wsdl:types > section contains the element declaration for the element startIndex.

<xsd:element name="startIndex" type="xsd:long"/>

Used in query operations, the startIndex value is the long integer that indicates the position in the event or data object list from which the client can request a specific number of events or data objects from the BMC Impact Integration Web Services server. The startIndex is implemented with the num_of_events element.

Example

A query has generated 100 events for the specified result handle ID. The web service client invokes a call to get the query results. The call specifies a startIndex value of 50 and requests that 20 events ( num_of_events value) be sent. The BMC Impact Integration Web Services server returns events 50 through 69.

StateChangeType_element

The declaration for the element StateChangeType_element is as follows:

<xsd:element name="StateChangeType_element"
type="tns:StateChangeType"/>

The StateChangeType_element references the complex type StateChangeType, described in StateChangeType.

timeout

The < wsdl:types > section contains the element declaration for the element timeout.

<xsd:element name="timeout" type="xsd:int"/>

The timeout value is the time that the SendEvent operation, which carries the event message, waits for a response from the BMC Impact Manager instance. If no response is received within the specified time, then the events and data are stored in the buffer — if one is defined for the BMC Impact Manager instance — and the SendEvent operation exits.

The timeout element is defined by the built-in type int. The timeout element is part of the bmciis_send_Request message.

trueCause

The declaration for the element trueCause is as follows:

<xsd:element name="trueCause" type="xsd:boolean"/>

Used in the QueryModelPossibleRootCauses operation, the Boolean indicator trueCause specifies that, when set to true, the query traverses the provider components for the possible root cause. In most instances, the root cause is equal to the true cause of the component's status.

userName

The < wsdl:types > section contains the element declaration for the element userName.

<xsd:element name="userName" nillable="true"
	type="xsd:string"/>

The userName element specifies the user name that is defined for a BMC Impact Manager instance. It is defined by the built-in type string. It is valid even when it carries no content. The userName element is part of the Connect_Request message.

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

Comments