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.

GraphQuery function

Retrieves a list of instances for the specified qualifications.

Namespace

*

http://atrium.bmc.com/2010/07/graphquery*
 

WSDL operation

<operation name="GraphQuery" parameterOrder="inargs">
<input message="tns:GraphQueryRequest" name="GraphQueryRequest"/>
<output message="tns:GraphQueryResponse"   name="GraphQueryResponse"/>
<fault message="tns:AtriumFault" name="AtriumFault"/>
</operation>

WSDL messages

<message name="GraphQueryRequest">
  <part element="types:GraphQuery" name="inargs"/>
</message>
<message name="GraphQueryResponse">
  <part element="types:GraphQueryOutput" name="outargs"/>
</message>
<fault message="tns:AtriumFault" name="AtriumFault"/>
</operation>

XSD schema

<element name="GraphQuery">
  <complexType>
    <sequence>
      <element name="loginInfo" nillable="true" 
       type="common:LoginInfo"/>
      <element name="graphQuery" type="tns:GraphQueryInput"/>
      <element name="datasetId" type="string"/>
      <element name="datasetMask" type="common:GetMask"/>
      <element name="firstRetrieve" type="int"/>
      <element name="maxRetrieve" type="int"/>
      <element name="formatType" 
       type="tns:QueryResultGraphFormat"/>
      <element name="extensions" nillable="true" 
       type="common:ExtensionList"/>
    </sequence>
  </complexType>
</element>
<element name="GraphQueryOutput">
  <complexType>
    <sequence>
      <element name="queryResult" type="tns:GraphQueryOutput"        nillable="true" />
      <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

 

loginInfo



User ID, passwords, domain and other information necessary to log on to the application. See LoginInfo.

graphQuery



Indicates the path that needs to be queried to return the wanted CIs and relationships. See GraphQueryInput.

datasetId



The unique identifier for the dataset. The data in the return values are based on the dataset ID specified in this parameter.

datasetMask



The ID that specifies the type of dataset on which to perform the operation.

0: None--Based on the datasetId being passed, instances are retrieved from either the overlay or the original dataset (CMDB_GET_MASK_NONE).

1<<0: Current Mode--Allows you to retrieve instances from the current dataset only (CMDB_GET_DATASET_MODE_CURRENT).

firstRetrieve

The instance ID of the class for which you want to retrieve relationships and instances.

maxRetrieve

The number of levels to traverse in the specified queryGraph. The value A-1 specifies the query to traverse to the end of the graph.

formatType



See GraphQueryOutput.

status



See StatusList.

extensions



The extension ID of the class for which you want to retrieve relationships and instances. This is required if the query graph contains the same CI class more than once and needs to distinguish one from another.See ExtensionList.

 

Return value

 

queryResult



List of one or more CI instances matching the specified criteria. The starting node is not included.

status

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

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