MES Stateless API

GetTargetStorageLocationsTree(String,String,Nullable<Int32>) Method

Save PDF

GetTargetStorageLocationsTree(String,String,Nullable<Int32>) Method

Save PDF

Last UpdatedNov 06, 2025
3 minute read

The GetTargetStorageLocationsTree() method retrieves a list of all entities, movable or non-movable, that contain inventory. This method is similar to the GetTargetStorageLocations() method, except that it returns additional parent, child, and entity tree information about the entities.

For this overload of the method, the optional entity filter is identified by its entity ID.

Syntax

'Declaration
 
Public Overloads Shared Function GetTargetStorageLocationsTree( _
   ByVal woId As String, _
   ByVal operId As String, _
   ByVal entId As Nullable(Of Integer) _
) As DataSet

'Usage
 
Dim woId As String
Dim operId As String
Dim entId As Nullable(Of Integer)
Dim value As DataSet
 
value = StorageExec.GetTargetStorageLocationsTree(woId, operId, entId)

public static DataSet GetTargetStorageLocationsTree( 
   string woId,
   string operId,
   Nullable<int> entId
)

Parameters

woId: Optional filter parameter. Holds a job's work order ID, for filtering the retrieved entities. Refer to the Remarks for more information.
operId: Optional filter parameter. Holds a job's operation ID, for filtering the retrieved entities. Refer to the Remarks for more information.
entId: Optional filter parameter. Holds the ID of an entity. Refer to the Remarks for more information.

Return Value

Returns a DataSet that contains records for movable and non-movable storage entities, as specified by the filter parameters (refer to the Remarks for more information). If no matching records are found, an empty DataSet is returned.

The columns of the returned DataSet are described below.

Column Name	Description
root_ent_id	An integer that is the ID of the root entity, from the ent.ent_id column. The entity returned in this column does not have any parents. Hence, this entity is always considered as the topmost entity in the entity hierarchy.
ent_id	An integer that is the ID of the entity, from the ent.ent_id column.
ent_name	A string that is the name of the entity, from the ent.ent_name column.
parent_ent_id	An integer that is the ID of the immediate parent entity for the ent_id column retrieved, from the ent.parent_ent_id column.
parent_ent_name	A string that is the name of the parent entity, from the ent.ent_name column linked to this parent_ent_id column.
child_level	An integer that is the entity hierarchy. For example: 1 represents the top level entity, which does not have any parent; 2 represents the first child entity, whose parent is the topmost entity; 3 represents the grandchild for the topmost entity; and so on.
ent_tree	A string that represents a list of ancestor entities, from the topmost entity but excluding this entity separated by hyphen. For example: 1-101-1001 represents 1 being the topmost entity, 101 represents the child for 1, 1001 represents the child for 101, and 1001 represents the parent entity for this entity.
selectable	An integer that indicates whether this storage entity is a non-movable entity. 1 indicates that this storage entity is non-movable; otherwise, the entity is movable.

MES Stateless API