Skip to main content

Cookie control banner

Necessary Cookies
These cookies are necessary for this website to function correctly. They are set when you perform certain actions on the site, such as creating an account, logging in, changing your privacy preferences or submitting a form. You can block these cookies in your browser, but this will stop parts of the site from working properly.
Functional Cookies
These cookies allow the website to provide extra functionality and more personalised experiences. They may be set by us or by third party providers whose services we have added to our pages. If you choose not to allow these cookies, these services may not work correctly.
Analytical Cookies
These cookies record anonymous data on how visitors use our website to help us monitor how well our website works. This data includes how many people have looked at specific pages, how long visitors stay on the site, and what devices they use. We use this data to identify changes that we could make to improve your experience and make our website more efficient.
Marketing Cookies
We set some cookies so you are shown more relevant marketing content. These include cookies from third-party advertising networks to show you different adverts on their services if you have previously visited our site. If you choose not to allow these cookies, you may experience less relevant advertising on other sites.
Browse Documentation

Linked content

Created by r.turner, last modified by zengenti on 25 Jan 2021

An entry can link to other entries or assets as entry, asset or image field types. They can be defined as standard entry fields or as a composed field type in the content type. These link objects can be singular or arrays of links of the same content type e.g. Actors.

Linked content can be unresolved or resolved depending on whether a linkDepth value has been provided.

Unresolved entries

An unresolved entry or asset is essentially a subset of the entry structure with enough information to get the correct entry language variation. A subsequent HTTP call is required to obtain the linked content. Unresolved entries and assets is the default behaviour for linked content.

Properties

Name Type Format Description
id string GUID The entry identifier as a 128 bit GUID
dataFormat string   Either entry or asset
language string Language code [Optional] The language code of the linked entry variation

Example

This example shows an unresolved entry.

JSON
{ "id": "0a48e187-43e0-4df0-ae62-8eba4d478036", "dataFormat": "entry", "language": "en-GB" }

Resolved entries

Entries can be resolved automatically to a maximum depth of 10 using the linkDepth parameter in any retrieval operation. Being able to resolve entries in a single HTTP call can significantly improve the render performance of your webpage or application. Whilst fewer network requests can be beneficial, it can also be detrimental if the linkDepth is too deep, or if there are many link fields.

Resolution rules

When a linkDepth is provided to an entry retrieval operation, then the following rules apply:

  • If a language is specified, then the specific language variation will be returned
  • If a language is specified but the specific language variation does not exist, then null will be returned or will not be included in the array
  • If a language is not specified, then the defaultLanguage value defined in the content type will be used to select the appropriate entry variation to return.
  • If a language is not specified and there is no default variation, then null is returned.