Configure tenant business settings for hierarchy
Learn more about the tenant business configuration settings used to define hierarchy types and control which entity types can use them.
Note: This feature is currently available only in AWS environments. Support for GCP and Azure will be available in a future release.
Define hierarchy types in tenant business configuration so they are available for use in the tenant. To enable hierarchy for an entity type, add a hierarchyTypes section to the tenant business configuration. Each hierarchy type entry can include a URI, a label, and a list of allowed entity types.Use allowedEntityTypes to restrict a hierarchy type to specific existing entity types. If allowedEntityTypes is not provided, the hierarchy type can use entities from any entity type.
The hierarchy section endpoint returns the hierarchy types defined for a tenant: GET /{{tenant}}/configuration/hierarchyTypes. This request requires an admin role and a bearer token.
Hierarchy type structure
A hierarchy type includes the following fields:
| Field | Description |
|---|---|
uri | URI of the hierarchy type. This value must use the pattern configuration/hierarchyTypes/{{HierarchyTypeName}}. |
label | Label of the hierarchy type used in the UI. This field is optional. |
allowedEntityTypes | List of entity type URIs that can use the hierarchy type. This field is optional. If this field is omitted, the hierarchy type can use any entity type. |
Business configuration example
The following example shows a hierarchyTypes section in tenant business configuration.
"hierarchyTypes": [
{
"uri": "configuration/hierarchyTypes/CommonHierarchy"
},
{
"uri": "configuration/hierarchyTypes/LocationHierarchy",
"allowedEntityTypes": [
"configuration/entityTypes/Location"
]
},
{
"uri": "configuration/hierarchyTypes/EntityHierarchy",
"label": "Hierarchy type for Entity",
"allowedEntityTypes": [
"configuration/entityTypes/HCP",
"configuration/entityTypes/HCO"
]
}
]Inheritance behavior
When hierarchyTypes entries with the same uri are inherited, the values are resolved as follows:
labelfrom L3 overrides the inherited value.allowedEntityTypesis merged from L2 and L3.