Get Hierarchies
post
/config/sim/v1/hierarchy/getHierarchy
Gets a list of hierarchies in a given organization
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
Objects included in the response.Example:
hierUnitId -
includeAll:
string
This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except
Ext values. If 'detailed' is specified, The response contains all the properties of the object. Example:detailed -
languages:
string
If specified, limits the translated strings returned.Example:
en-US, es-ES, es-MX -
limit:
integer
If using paging, number of results returned in this page.Example:
0 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supported.Example:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
objectNum:asc -
searchCriteria:
string
Search criteria to filter results based on field value.Example:
where equals(objectNum,1)
Response
Supported Media Types
- application/json
200 Response
A Collection of Hierarchies.
Root Schema : HierarchyGetResponsev1
Type:
Show Source
object-
count:
integer
Current response record count.Example:
9 -
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items:
array items
Array of Hierarchy objects of the organization.
-
limit:
integer
Server page sizeExample:
10 -
offset:
integer
Starting resource record indexExample:
0 -
totalResults:
integer
Total number of rows (excluding the paging parameters)Example:
1
Nested Schema : items
Type:
arrayArray of Hierarchy objects of the organization.
Show Source
-
Array of:
object Hierarchyv1
Model for a Hierarchy Object
Nested Schema : Hierarchyv1
Type:
objectModel for a Hierarchy Object
Show Source
-
hierStrucId:
integer
Hierarchy Structure Id of the node of the hierarchy. Excluded by default.Example:
1 -
hierType:
string
Type of Hierarchy NodeExample:
Default -
hierUnitId:
integer
Hierarchy Unit Id of the root node of the hierarchyExample:
1 -
hierUnitObjNum:
integer
Object number of the hierarchy unit.Example:
1 -
locRef:
string
Location Reference of the node (Only valid for hierType = Location). Excluded by default.Example:
Location-1 -
name:
object name
Hierarchy Name
-
nodes:
array nodes
An array of Hierarchy.
-
parentHierStrucId:
integer
Hierarchy Structure Id of the parent node. Excluded by default.Example:
0 -
parentHierUnitId:
integer
Hierarchy unit id of the parent nodeExample:
0 -
parentLocRef:
string
Location Reference of the parent node (Only valid for hierType = RVC). Excluded by default.Example:
Location-1 -
simphonyType:
string
Determines the simphony type (essentials or standard) of organization. This field is present in the first object of the response and searching using this field is not allowed.Example:
Essentials
Nested Schema : name
Type:
objectHierarchy Name
Example:
{"en-US":"Enterprise", "de-DE": "Enterprise", "ar-AR": "??????????????"}Nested Schema : nodes
Type:
arrayAn array of Hierarchy.
Show Source
-
Array of:
object Hierarchyv1
Model for a Hierarchy Object