Get Hierarchy Nodes
post
/config/sim/v2/hierarchy/getHierarchyNodes
Request
Supported Media Types
- application/json
- multipart/form-data
The input Body model that needs to be given.
Root Schema : schema
Type:
Show Source
object-
include:
string
If specified, limits the data returned to these fields.Example:
hierUnitId, objectNum, name -
includeAll:
string
If this value is specified, the include parameter is ignored.
Value Description basic Forces the response to include all fields except option string details detailed Forces the response to include all fields including option string details Example:detailed -
langIds:
string
If specified, limits translated strings returnedExample:
1,2,3 -
limit:
integer
If using paging, number of results returned in this page.Example:
100 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supportedExample:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
hierUnitId:asc -
searchCriteria:
string
If specified, returns records that match the criteria.Example:
where equals(hierUnitId, 7)
Response
Supported Media Types
- application/json
200 Response
A Collection of Hierarchy Nodes.
Root Schema : schema
Type:
Show Source
object-
count:
integer
Current response record count.Example:
9 -
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
false -
items:
array items
Array of Hierarchy Node records.
-
limit:
integer
Server page sizeExample:
10 -
offset:
integer
Starting resource record indexExample:
0 -
totalResults:
integer
Total number of rows (excluding the paging parameters)Example:
9
Nested Schema : items
Type:
arrayArray of Hierarchy Node records.
Show Source
-
Array of:
object HierarchyNode
Hierarchy Node record
Nested Schema : HierarchyNode
Type:
objectHierarchy Node record
Show Source
-
hierOptions:
string
A string of values 0s and 1s of length 16 representing the options for the hierarchy node
Position(starts from 1) Description 1 EnforceUniquePropertiesWithinZone 2 EnforceUniqueRVCsWithinZone 3 restrictModulesInChildZones 4 allRVCsfromSameLocation 5 sortAlphabetically Example:0000000000000000 -
hierStrucId:
integer
Unique reference of the hierarchy node.Example:
3597 -
hierType:
string
Type to determine if the node is associated to a zone or not.Example:
Default -
hierUnitId:
integer
Unique reference of the hierarchy unit. Multiple nodes with same hierUnitId but different hierStrucId indicate they are the same Location/RVC defined under zone(s) or sub-zone(s).Example:
3599 -
name:
object name
Hierarchy Unit Name
-
nodeType:
string
Type to determine if the node is a Location, RVC, Zone or the Enterprise.Example:
Location -
objectNum:
integer
Object number of the Location/RVC/Zone.Example:
1 -
parentHierStrucId:
integer
Unique reference of the parent hierarchy node.Example:
4223 -
parentHierUnitId:
integer
Unique reference of the parent hierarchy unit.Example:
4234
Nested Schema : name
Type:
objectHierarchy Unit Name
Example:
{
"1":"Subway",
"2":"U-Bahn",
"3":"Metro"
}