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.

QueryByPath function (query_bypath)

Retrieves a list of instances for the specified qualifications. To improve the performance of the queries, add indexes in the query qualifier. You must create indexes on only those attributes that are frequently used in the query qualifier because adding indexes incur some amount of overhead.

Namespace



*

http://atrium.bmc.com/2011/02/query*
 

WSDL operation

<operation name="QueryByPath" parameterOrder="inargs">
	<input message="tns:QueryByPathRequest" 
	  name="QueryByPathRequest"/>
	<output message="tns:QueryByPathResponse" 
	  name="QueryByPathResponse"/>
	<fault message="tns:AtriumFault" name="AtriumFault"/>
</operation>

WSDL messages

<message name="QueryByPathRequest">
	<part element="types:QueryByPath" name="inargs"/>
</message>
<message name="QueryByPathResponse">
	<part element="types:QueryByPathOutput" name="outargs"/>
</message>
<message name="AtriumFault">
	<part element="common:AtriumFault" name="errargs"/>
</message>

XSD schema

<element name="QueryByPath">
	<complexType>
		<sequence>
			<element name="loginInfo" nillable="true" type="common:LoginInfo"/>
			<element name="input" type="tns:Query"/>
			<element name="extensions" nillable="true" type="common:ExtensionList"/>
		</sequence>
	</complexType>
</element>
<element name="QueryByPathOutput">
	<complexType>
		<sequence>
			<element name="queryResult" type="tns:QueryResultGraph"/>
			<element name="status" type="common:StatusList"/>
			<element name="extensions" nillable="true" type="common:ExtensionList"/>
		</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

 

input

See QueryByPathInput.

executeOption

See SavedQueryInfo.

 

Return values

 

queryResult

Values returned for a particular query.

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. See ExtensionList.

 

Fault message

 

Fault message

See Fault message.

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

Comments