Click or drag to resize

ItemServicesGetItemWithChildren Method

Retrieves a single Item based on its UID (text-based unique identifier) and classification, along with its immediate children, and optionally all descendants.

Namespace:  FactoryLogix.xTend.Logistics
Assembly:  FactoryLogix.xTend.API (in FactoryLogix.xTend.API.dll) Version: 8.242.0.0 (8.242.0.0)
Syntax
Copy
public Item GetItemWithChildren(
	Guid sessionId,
	string itemUID,
	ItemClassification classification,
	bool allDescendants
)

Parameters

sessionId
Type: SystemGuid
The session identifier that was returned by the Connect(String, String, String, String, String) method.
itemUID
Type: SystemString
The UID of the item
classification
Type: FactoryLogix.xTend.DataObjectsItemClassification
An enumerated value of type ItemClassification describing the type or kind of the Item being sought.
allDescendants
Type: SystemBoolean
If null or false, the Item returned will include only its immediate descendants. If true, the Item returned will include all known descendants (entire genealogy).

Return Value

Type: Item
An Item object representing the item matching the specified UID and classification, along with its immediate children or all descendants. A value of null will be returned if the item is not found.
Exceptions
ExceptionCondition
InvalidSessionExceptionThrown if the sessionId parameter is invalid.
NotFoundExceptionThrown if the itemId parameter specifies an Item that does not exist.
See Also