[Index]
Model: relation/HcsHierarchyNodeREL
Hierarchy
Full HTML Help
Role-based Access to the Hierarchy
An administrator can view the portion of the hierarchy they have access to.
- A provider administrator can view the complete hierarchy.
- A customer administrator can view the customer, any intermediate nodes
beneath the customer, and customer sites.
View, Sort, and Search the Hierarchy
You can view the hierarchy on the relevant hierarchy list view. Hierarchy nodes visible to
the administrator display in a table:
| Field |
Description |
|---|
| Name |
Node name |
| Description |
Node description |
| Hierarchy Node Type |
Either Provider, Reseller, Customer, or
Site. Blank for an intermediate node. |
| Located At |
The node location in the hierarchy, in
dot notation. |
To view a subset of the visible hierarchy, adjust the hierarchy path. For example,
if a provider administrator sets the path to point to a particular customer, they
can see only the hierarchy nodes for that customer.
To sort hierarchy nodes, click on the field headers.
To search hierarchy nodes, click the search icon on the field headers.
Related Topics
Navigating the Hierarchy in the Core Feature Guide
Model Details: relation/HcsHierarchyNodeREL
- An asterisk * in the title indicates the field is mandatory.
- If a field has a default value, it is shown in the Description column.
- If the field type is an array, the Field Name has a .[n] suffix, where n is the array index placeholder.
- Object and array field names are listed to provide context. If a field belongs to an object or an array,
the full field name is shown in dot separated notation.
|
Name *
|
The name by which this hierarchy node will be known.
|
- Field Name:
name
- Type: String
- Pattern: ^([A-Za-z0-9_\-][A-Za-z0-9_\ -]*[A-Za-z0-9_\-]|[A-Za-z0-9_\-])$
|
|
Description
|
A general description for the hierarchy node.
|
- Field Name:
description
- Type: String
|
|
Hierarchy node type
|
A type label for this node which refers to a Hierarchy Node Type.
|
- Field Name:
node_type
- Type: String
- Target: /api/data/HierarchyNodeType/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24IVJPyfUfEvue1Zbd%24a0r2DwdKFMi9cNCxmzQEkqMi2dtEUvmeBXG1uOG5kcD%2BVH89MT6P7BH/IZ19r9OkW7/1pLBagiEMpMTuaG1iCVubiHeb0QXjd1MqyhvJNkeHHOQgrTAhcOXOTJ2QTjybYkwqRV%2B9YXaMwRCVQwdOWpkKW%2Bl8%2Bp085lRM0ksbSxpaw5tehXRgYYKT9gAXmPBBi%2BXlUAOK8ee63HUqrNnB7kKZyiSfkatlRvpsP2nEAXiznfkZrtAjetkDBsrLiIBRgzFB7dMAfMa6AYfcup%2BinW2NEL4UJClvlsIUIpOoINfBi8Bod%2BQizIiCVyaJoLKyGJnqh3O48yTA1iNKPLBQPSN/KWV77iA7aFRAiyRZm8g8LWOU1tdx2CiD862hrP5Aino5X18Hu2tFAKGWCLmp3ezAEflPyUPcHc2OmWFk7Ax0F8FYXz3bDWN7qTO3aEUqi68HfbGYUxSe%2BwJROQB4oF5PuqlNJ3TTmihym5QphTAwTcloEUjLpU/RAZnt5JGiQr/kvZwnXQ%3D%3D%24%3D%3D
- Target attr: name
- Target Model Type: data/HierarchyNodeType
- Format: uri
- Choices: []
|
|
Shadow |
|
- Field Name: shadow.[n]
- Type: Array
- Cardinality:
[0..1]
|
|
|
Name * |
|
- Field Name:
shadow.[n].name
- Type: String
- MaxLength: 1024
|