This documentation supports the 9.1 to 9.1 Service Pack 3 version and its patches of BMC Atrium Core. The documentation for version 9.1.04 and its patches is available here.

To view the latest version, select the version from the Product version menu.

ListClasses function

Retrieves relationship classes whose relatedClass parameter contains the specified class, and information about those classes.

Namespace



*

http://atrium.bmc.com/2009/01/classes/types*
 

WSDL operation

<operation name="ListClasses" parameterOrder="inargs">
<input message="tns:ListClassesRequest"
	 name="ListClassesRequest"/>
<output message="tns:ListClassesResponse"
	name="ListClassesResponse"/>
<fault message="tns:AtriumFault"name="AtriumFault"/>
</operation>

WSDL messages

<message name="ListClassesRequest">
	 <part element="types:ListClasses" name="inargs"/>
</message>
<message name="ListClassesResponse">
	 <part element="types:ListClassesOutput" name="outargs"/>
</message>
<message name="AtriumFault">
	<part element="common:AtriumFault" name="errargs"/>
</message>

XSD schema

<element name="ListClasses">
	<complexType>
		<sequence>
			<element name="lang" type="string"/>
			<element name="namespace" type="string" nillable="true"/>
			<element name="relatedClass"  type="common:ClassNameId"  
				nillable="true"/>
			<element name="superClass" type="common:ClassNameId"  
				nillable="true"/>
			<element name="propInfo" type="common:PropInfoList" 
				nillable="true"/>
			<element name="getHidden" type="boolean"/>
			<element name="extensions" type="common:ExtensionsList" 
				nillable="true" />
		</sequence>
	</complexType>
</element>
<element name="ListClassesOutput">
		<complexType>
	<sequence>
			<element name="classList" type="common:ClassNameIdList"/>
			<element name="status"    type="common:StatusList"/>
			<element name="extensions" type="common:ExtensionsList" 
				nillable="true" />
		</sequence>
	</complexType>
</element>
<element name="AtriumFault">
	<complexType>
		<choice>
			<element name="serviceFault"
				type="tns:AtriumServiceFault" />
			<element name="backendFault"
				type="tns:AtriumBackendFault" />
		</choice>
	</complexType>
</element>

Input arguments

 

lang

The language of the product specific to the locale. If no language is specified, the default language is used.

namespace

The name of the namespace to which the class belongs. Namespaces are a way of partitioning your data model to create logical groups of classes.

relatedClass

Specifies the class to which the returned classes must be related.

superClass

Specifies the class from which the returned classes must be derived.

propInfo

Specifies the properties that the returned classes must match.

getHidden

Specifies whether to return hidden classes. Valid values are "true" or "1" for true values, and "false" or "0" for false values.

extensions

A list of extension types for the operation.

 

Return values

 

classList

A list of class names that match the criteria specified in the input parameters.

status

A list of zero or more notes, warnings, or errors generated from a call of this operation.

extensions

A list of extension types for the operation.

 

Fault message

 

Fault message

See Fault message.

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

Comments