Entity (List)#
Path: /facilities/data-sources/data-schemas/entity-schema/entity
Defines an entity type/schema, such as a group or an organization.
Keys: name
Parameters#
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| name | string (length: 1..64) | required | - | The entity schema name, unique among all entities in the containing ‘entity-schema’. |
| description | string | optional | - | A human readable description of the entity schema. |
| parent | leafref → ../../entity/name | optional | - | The optional parent entity for this entity, which is another entity type. Two entity instances can have the same type and value as long as they have different parents. That is, the (type. value) pair is only unique inside a given parent. |
| is-partitioned | empty | optional | - | If enabled, this entity type is partitioned by the schema’s partition entity. |
| is-system | boolean | optional | false | When true, this type is required for a system functionality and should not be manually edited. |