[Index]

Model: data/Relation

A Relation joins related models, and represents their attributes as a single entity.

Model Details

Title Description Details
Name *
  • Field Name: name
  • Type: String
Documentation Used for generating reference documentation for the Relation.
  • Field Name: doc
  • Type: String
Visible at Lower Hierarchy When enabled, model instances defined at higher levels in the hierarchy will be visible at lower hierarchy levels.
  • Field Name: visible_at_lower_hierarchy
  • Type: Boolean
Models To Join
  • Field Name: join.[n]
  • Type: Array
Left Model Type
  • Field Name: join.[n].left_model_type
  • Type: String
  • Format: uri
Left Alias
  • Field Name: join.[n].left_alias
  • Type: String
Right Model Type
  • Field Name: join.[n].right_model_type
  • Type: String
  • Format: uri
Right Alias
  • Field Name: join.[n].right_alias
  • Type: String
Cardinality
  • Field Name: join.[n].cardinality
  • Type: String
  • Choices: ["One-to-one", "One-to-optionally-one", "One-to-many", "One-to-optionally-many"]
Join On Attributes
  • Field Name: join_on.[n]
  • Type: Array
Left Model Attribute
  • Field Name: join.[n].join_on.[n].left_attr
  • Type: String
  • Choices: [""]
Right Model Attribute
  • Field Name: join.[n].join_on.[n].right_attr
  • Type: String
  • Choices: [""]
Summary Attributes Write as "attribute", "alias.attribute" or "alias.alias.attribute" (depending on how its model is joined).
  • Field Name: summary_attrs.[n]
  • Type: Array
Workflows
  • Field Name: workflows.[n]
  • Type: Array
Workflow Operation For example, "add", "modify", "delete".
  • Field Name: workflows.[n].operation
  • Type: String
  • Choices: ["Add", "Update", "Remove"]
Provisioning Workflow
  • Field Name: workflows.[n].workflow
  • Type: String
  • Target: data/ProvisioningWorkflow
  • Target attr: name
  • Format: uri
Operations
  • Field Name: operations.[n]
  • Type: Array
API reference for data/Relation