Entity-relation (List)#
Path: /facilities/data-sources/data-schemas/entity-schema/entity-relation
A relation between entities.
Keys: name
Parameters#
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| name | string (length: 1..64) | required | - | The relation name, such as ‘member’ or ‘owner’. |
| description | string | optional | - | A human readable description of the entity relation. |
| source | leafref → ../../entity/name | required | - | The source entity schema name. |
| target | leafref → ../../entity/name | required | - | The target entity schema name. |
| cardinality | enumeration (one-to-many, many-to-one, many-to-many) | optional | many-to-many | The relation cardinality. |
| is-system | boolean | optional | false | When true, this type is required for a system functionality and should not be manually edited. |