HomeGuidesAPI ReferenceGraphQL
Submit Documentation FeedbackJoin Developer CommunityOptimizely GitHubOptimizely NuGetLog In

Relationships schema

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"
  }]
}
propertydescription
namename for the relation
display_nameuser-friendly name shows within ODP
public_readoptional property for enabling access with the API public key. The default value is false.
child_objectchild Object name
join_fieldscollection 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.