BeginGraphWalk function

Specifies the start node for retrieving CI and relationship instances in a chunk. This operation sets up the starting node and query parameters for the graph walk, such as number of levels to walk in the relationship map, and maximum number of nodes to retrieve in one call.

This operation returns a structure that contains information such as, the list of classes walked in the query, available next chunk status, and the next object index.

WSDL operation

<operation name="BeginGraphWalk" parameterOrder="inargs">
<input message="tns:BeginGraphWalkRequest"
	name="BeginGraphWalkRequest"/>
<output message="tns:BeginGraphWalkResponse"
	name="BeginGraphWalkResponse"/>
<fault message="tns:AtriumFault"name="AtriumFault"/>
</operation>

WSDL messages

<message name="BeginGraphWalkRequest">
	<part element="types:BeginGraphWalk" name="inargs"/>
</message>
<message name="BeginGraphWalkResponse">
	<part element="types:BeginGraphWalkOutput" name="outargs"/>
</message>
<message name="AtriumFault">
	<part element="common:AtriumFault" name="errargs"/>
</message>

XSD schema

<element name="BeginGraphWalk">
	<complexType>
		<sequence>
			<element name="loginInfo" type="common:LoginInfo"
				nillable="true" />
			<element name="expiration"type="common:ExpirationIn"
				nillable="true" />
			<element name="startingClassNameId"
				type="common:ClassNameId" />
			<element name="startingInstanceId"type="string" />
			<element name="query" type="tns:GraphWalkQuery" />
			<element name="extensions"type="common:ExtensionList"
				nillable="true" />
		</sequence>
	</complexType>
</element>
<element name="BeginGraphWalkOutput">
	<complexType>
		<sequence>
			<element name="contextId" type="string" />
			<element name="expiration"type="common:ExpirationOut" />
			<element name="hasNext" type="boolean" />
			<element name="status" type="common:StatusList" />
			<element name="extensions"				type="common:ExtensionList"
				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

loginInfo	User ID, passwords, domain and other information necessary to log on to the application. See LoginInfo.
expiration	See ExpirationOut.
startingClassNameId	The class name ID to process first.
startingInstanceId	The ID of the instance to process first.
query	A qualification that determines the set of instances to retrieve. The qualification can include one or more attributes and any combination of conditional, relational, and arithmetic operations. See GraphWalkQuery.
extensions	A list of extension types for the operation.

Return value

contextId	The unique identifier for a particular set of circumstances.
expiration	Indicates when the graph walk query will expire.
hasNext	Valid values are "true" or "1" for true values, and "false" or "0" for false values.
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.