Relationships schema overview
2 min
Relationship Definition
Representation describing a relationship between two objects. The Object containing the Relation definition is the parent object.
{
"name": "relation_name",
"display_name": "Relation Display Name",
"public_read": false,
"child_object": "child_object_name",
"join_fields": [{
"parent": "child_id",
"child": "child_id"
}]
}property | description |
|---|---|
name | name for the relation |
display_name | user-friendly name shows within ODP |
public_read | optional property for enabling access with the API public key. The default value is false. |
child_object | child Object name |
join_fields | collection of parent-child pairs. parent is the field name (foreign key) on the owning Object and child is the related Object's primary key. Multiple are allowed to support objects with compound primary keys. |