ODP Node SDK / Zaius / RelationDefinition

The Zaius Relation definition payload for schema APIs. See V3 Schema API for details.

The child or "target" object of this relation.

Defined in: src/Api/Types/Schema.ts:86

The user-friendly name used within Zaius. Must be unique across all relation and field display names within the object.

Defined in: src/Api/Types/Schema.ts:82

Collection of parent/child field pairs that define how to join the parent object to the child object. Multiple pairs are allowed to support objects with compound primary keys.

Defined in: src/Api/Types/Schema.ts:91

The name of the relation. Lower snake case, alphanumeric, must start with an alpha character. Must be unique across all relation and field names within the object.

Defined in: src/Api/Types/Schema.ts:77