Skip to main content
Get Hierarchy From Path

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Path Parameters

domain
enum<string>
required

Type of items to get

Available options:
Unknown,
ExtraTables,
ScreenDefinitions,
Scripts,
Selections,
ExternalDocuments,
UserGroups,
ExternalDocumentRelatedToSpmMessage,
Dashboards,
EmailFlows
path
string
required

Hierarchy path to item

Query Parameters

children
boolean

Include sub-items?

Response

OK

Folder structures Carrier object for HierarchyEntity. Services for the HierarchyEntity Carrier is available from the List Agent.

HierarchyId
integer<int32>

The primary key (auto-incremented)

Domain
enum<string>

Domain seperating the different hierarchy

Available options:
Unknown,
ExtraTables,
ScreenDefinitions,
Scripts,
Selections,
ExternalDocuments,
UserGroups,
ExternalDocumentRelatedToSpmMessage,
Dashboards,
EmailFlows
Name
string

Name of this hierarchy folder.

Fullname
string

The full name of this category, i.e. Foo/bar/test.

ParentId
integer<int32>

Parent table

Children
array

Sub-items, if any.

Registered
string<date-time>

Registered when in UTC.

RegisteredAssociateId
integer<int32>

Registered by whom

Updated
string<date-time>

Last updated when in UTC.

UpdatedAssociateId
integer<int32>

Last updated by whom

TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.