Get Hierarchies
post
/config/sim/v2/hierarchy/getHierarchy
Gets a list of hierarchies in a given organization
Request
Supported Media Types
- application/json
- multipart/form-data
A request body
Root Schema : HierachyGetRequestBodyv2
Type:
objectThe input Body model that needs to be given.
Show Source
-
include:
string
Objects included in responseExample:
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 -
langIds:
string
If specified, limits translated strings returned.Example:
1,2,3 -
limit:
integer
If using paging, number of results returned in this page.Example:
10 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supportedExample:
2 -
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 valueExample:
where equals(objectNum,1)
Response
Supported Media Types
- application/json
200 Response
A collection of hierarchies in organization.
Root Schema : HierarchyGetResponsev2
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 Hierarchyv2
Model for a Hierarchy Object
Nested Schema : Hierarchyv2
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
Hierachy 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:
objectHierachy Name
Example:
{
"1":"Enterprise",
"2":"Unternehmen",
"3":"Empresa"
}Nested Schema : nodes
Type:
arrayAn array of Hierarchy.
Show Source
-
Array of:
object Hierarchyv2
Model for a Hierarchy Object
400 Response
400 Bad Request
Root Schema : ErrorDetails
Type:
objectResponse body when the request returns an error.
Show Source
-
detail(required):
string
A short, human-readable summary of the problem.Example:
Specified Data is invalid -
errorDetails(required):
string
A human-readable explanation specific to this occurrence of the problem.Example:
Entity Does Not Exist -
o:errorCode(required):
integer
Error code of the problemExample:
55223 -
status(required):
integer
HTTP status code.Example:
400 -
title(required):
string
A short, human-readable summary of the problem type.Example:
VALIDATION ERROR -
type(required):
string
A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".Example:
http://www.abc.org/xyz.html
404 Response
404 Requested resource not found