RelationDefinition
ODP Node SDK / ODP / RelationDefinition
Interface: RelationDefinition
Defined in: src/Api/Types/Schema.ts:72
The ODP Relation definition payload for schema APIs.
See V3 Schema API
for details.
Properties
child_object
child_object:
string
Defined in: src/Api/Types/Schema.ts:86
The child or "target" object of this relation.
display_name
display_name:
string
Defined in: src/Api/Types/Schema.ts:82
The user-friendly name used within ODP.
Must be unique across all relation and field display names within the object.
join_fields
join_fields:
JoinField
[]
Defined in: src/Api/Types/Schema.ts:91
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.
name
name:
string
Defined in: src/Api/Types/Schema.ts:77
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.
Updated 4 days ago