Localess
Schemas

Reference (One)

Stores a reference to a single content document in the space. Resolved to the full document when fetched with resolveReference enabled.

Stores a reference to a single content document in the space. Use it to link a piece of content to another document — for example, a related article or an author profile. For multiple references use References.

Value shape

{
  "kind": "REFERENCE",
  "uri": "019df317-9ad5-7228-a070-afc8f94a07d2"
}

When fetching content with resolveReference: true, the URI is replaced with the full document object. See @localess/client for fetch options.

Options

OptionDescription
PathRestricts the document picker to documents under a specific content path (e.g. blog shows only documents inside the blog folder)
NameUnique field name in the Schema. Appears in the generated model and in the API response.
Display NameLabel shown to editors in the Content Editor.
RequiredWhen set, editors cannot save the document without a value.
TranslatableNot available for this field type.
DescriptionHelp text shown to editors under the field.
Default ValueValue applied when a document is first created.

On this page