Learn about how models may reference, embed, and link to other models.

Model Links

To link from one model to another, specify the model name for the field type:

otherModel: TheOtherModelName

Fields of this type never return null or undefined. Keep in mind that links may be "broken" if the target of the link was deleted.

For more information on methods and properties available see Model Link Scripting.

For contained models, there is no need to add a link from the contained model back to the container. There is already a method provided for this back reference to the container.

Embedded

This is the field type corresponding to a complex value defined by an Embedded model type.

For more information on defining an embedded field, click here.

Model Lists

Multi-valued lists may be defined for either simple values or complex embedded models. To denote a list, add brackets "[]" after the field name. If requirements don't call for the maximum of 20 entries, then provision less entries by specifying a number (less than 20) between the brackets. Capped/rolling/LRU lists are also supported.

Whether defined globally or locally, embedded models can allow multiple values by adding "[]" after the field name:

items[]:
  type:
    price: double

address[5]: Address

For more information, see String List Scripting.