Custom complex types in the WSDL

CellInfo

The < wsdl:types > section describes the CellInfo complex type. Its data definition is as follows:

<xsd:complexType name="CellInfo">"
	<xsd:sequence>
		<xsd:element name="cell_name" type="xsd:string"/>
		<xsd:element name="cell_type" type="xsd:string"/>
		<xsd:element name="cell_hostname" type="xsd:string"/>
		<xsd:element name="port" type="xsd:unsignedInt"/>
		<xsd:element name="encryption_key" type="xsd:string"/>
		<xsd:element name="trusted_servers" type="xsd:string"/>
	</xsd:sequence>
</xsd:complexType>

The CellInfo complex type contains a sequence of child elements that identify the important attributes of the BMC Impact Manager instance or an Impact Integration instance. Each element must be declared in the sequence specified in the data definition.

The information contained in the CellInfo complex type is similar to the information that the mcell.dir file defines. The child elements are defined as follows:

CellInfo Child Elements

Element

Data Type

Description

cell_name

string

String description of the name of the BMC Impact Manager instance or an integration. For an Impact Integration Web Services integration, enter IIWSGatewayserver.

cell_type

string

String description that identifies the BMC Impact Manager instance as a cell or a gateway. Normally, you enter cell.

cell_hostname

string

String description that identifies the name of the system on which the instance resides

port

unsignedInt

Numerical designation that specifies the port number through which the BMC Impact Manager instance or integration listens. The default for BMC Impact Manager instances is 1828; the default for IIWSGatewayserver is 1859.

encryption_ key

string

String description of the encryption key that the BMC Impact Manager instance or integration uses. The default value is MC.

trusted_ servers

string

[ not implemented in this release ] string description that lists the host names or IP addresses of the authentication servers that are acceptable to the specified BMC Impact Manager instance or integration

ArrayOf_CellInfo

The < wsdl:types > section describes the ArrayOf_CellInfo complex type. Its data definition is as follows:

<xsd:complexType name="ArrayOf_CellInfo">"
	<xsd:sequence>
		<xsd:element minOccurs="0" maxOccurs="unbounded"
			name="CellInfo_element" type="tns:CellInfo"/>
	</xsd:sequence>
</xsd:complexType>

The complex type ArrayOf_CellInfo is a collection of BMC Impact Manager or Impact Integration instances. Each instance is represented by the CellInfo_element child element. The type of the child element is based on the complex type CellInfo. It can contain zero or more CellInfo_elements.

See also CellInfo_Array for a description of an element that is derived from the ArrayOf_CellInfo complex type.

ClassDefInfo

The data definition of the complex type ClassDefInf is as follows:

<xsd:complexType name="ClassDefInfo">
<xsd:sequence>
<xsd:element name="class_parent_idx" type="xsd:int"/>
<xsd:element name="class_child_cnt" type="xsd:int"/>
<xsd:element name="class_name" type="xsd:string"/>
<xsd:element name="child_list" type=""tns:ArrayOf_ClassDefInfo"/>
<xsd:element name="slots_count" type="xsd:int"/>
<xsd:element name="slots_list" type="tns:ArrayOf_SlotDefInfo"/>
</xsd:sequence>
</xsd:complexType>

This definition uses the types integers, strings, and arrays to specify class and slot information, including the position of the selected class within the class hierarchy.

Element

Description

class_parent_idx

Integer assigned to the selected parent class

class_child_cnt

Number of child classes

class_name

Name of the selected class

child_list

An array of class definitions of children of the selected parent class

slots_count

Number of slots in the selected class

slots_list

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 ','.

ArrayOf_ClassDefInfo

The data definition of the complex type ArrayOf_ClassDefInfo is as follows:

<xsd:complexType name="ArrayOf_ClassDefInfo">
<xsd:sequence>
<xsd:element
maxOccurs="unbounded"
minOccurs="0"
name="items"
type="tns:ClassDefInfo"/>
<xsd:element name="slots_list" type="tns:ArrayOf_SlotDefInfo"/>
</xsd:sequence>
</xsd:complexType>

The complex type ArrayOf_ClassDefInfo

SMComponent

The data definition of the complex type SMComponent is as follows:

<xsd:complexType name="SMComponent">
<xsd:complexContent>
<xsd:extension base="btypes:ArrayOf_NameValue"/>
</xsd:complexContent>
</xsd:complexType>

ArrayOf_SMComponent

The data definition of the complex type ArrayOf_SMComponent is as follows:

<xsd:complexType name="ArrayOf_SMComponent">
<xsd:sequence>
<xsd:element
maxOccurs="unbounded"
minOccurs="0"
name="SMComponent_element"
type="tns:SMComponent"/>
</xsd:sequence>
</xsd:complexType>

SlotDefInfo

The data definition of the complex type SlotDefInfo is as follows:

<xsd:complexType name="SlotDefInfo">
<xsd:sequence>
<xsd:element name="slot_name" type="xsd:string"/>
<xsd:element name="slot_type" type="xsd:string"/>
<xsd:element name="slot_rep_type" type="xsd:string"/>
<xsd:element name="slot_flags" type="xsd:string"/>
<xsd:element name="slot_def_val" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>

This definition uses string types to define the following elements:

Element

Description

slot_name

Name of the slot in the selected class

slot_type

Indicates the type of value that the slot contains. The value can be a single entry or a list-of entry. It can be one of the following types:

  • STRING
  • REAL
  • POINTER
  • INTEGER
  • EnumTypeName

slot_rep_type

Slot representation type that indicates what the slot type represents. Possible values include date and class. If the slot representation type is not specified, it is represented by an asterisk (*).

slot_flags

A Boolean indicator that indicates whether the slot has certain attributes. An uppercase character means that the attribute is true and does apply to the slot. A lower case character means that it is false and does not apply to the slot. The values are

  • r|R = read-only
  • k|K = key
  • p|P = parse
  • d|D = dup_detect
  • h|H = hidden

slot_def_value

The default value, if any, assigned to the selected slot

ArrayOf_SlotDefInfo

The data definition of the complex type ArrayOf_SlotDefInfo is as follows:

<xsd:complexType name="ArrayOf_SlotDefInfo">
<xsd:sequence>
<xsd:element
maxOccurs="unbounded"
minOccurs="0"
name="SMComponent_element"
type="tns:SlotDefInfo"/>
</xsd:sequence>
</xsd:complexType>

CStatus

The data definition of the complex type CStatus is as follows:

<xsd:complexType name="CStatus">
<xsd:sequence>
<xsd:element name="cmpStatus" type="xsd:string"/>
<xsd:element name="impStatus" type="xsd:string"/>
<xsd:element name="manStatus" type="xsd:string"/>
<xsd:element name="subStatus" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>

GetEventsResponse

The data definition of the complex type GetEventsResponse is as follows:

<xsd:complexType name="GetEventsResponse">
<xsd:sequence>
<xsd:element name="response" type="event:ArrayOf_Event"/>
<xsd:element name="num_of_events" type="xsd:int"/>
</xsd:sequence>
</xsd:complexType>

GetQueryResultResponse

The data definition of the complex type GetQueryResultResponse is as follows:

<xsd:complexType name="GetQueryResultResponse">
<xsd:sequence>
<xsd:element name="response" type="event:ArrayOf_Event"/>
<xsd:element name="num_of_events" type="xsd:int"/>
</xsd:sequence>
</xsd:complexType>

StateChangeType

The data definition of the complex type StateChangeType is as follows:

<xsd:complexType name="StateChangeType">
<xsd:sequence>
<xsd:element name="bCompChange" type="xsd:boolean"/>
<xsd:element name="bCompDelete" type="xsd:boolean"/>
<xsd:element name="bRelChange" type="xsd:boolean"/>
<xsd:element name="bRelDelete" type="xsd:boolean"/>
<xsd:element name="bAll" type="xsd:boolean"/>
</xsd:sequence>
</xsd:complexType>

execution_fault

The data definition of the complex type execution_fault is as follows:

<xsd:element name="execution_fault">
		<xsd:complexType>
		<xsd:sequence>
			<xsd:element name="IMFailure" nillable="true" type="xsd:string"/>
		</xsd:sequence>
		</xsd:complexType>
	</xsd:element>

execution_fault carries a string message that describes the operation executing errors. The execution_fault is generated by the BMC Impact Integration Web Services server and thrown to the client through the web service infrastructure.

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

Comments