Skip to main content
Browse Documentation
HTTP - Management

Entry usage info

Created by Contensis product team, last modified by zengenti on 23 Sep 2020

The entry usage info object contains a subset of entry data to describe an entry. This is used when retrieving a list of entries which link to an entry.

Properties

NameData typeData formatDescription
idstringuuidThe entry identifier as a 128 bit GUID.
titlestringThe title of the linked entry.
descriptionstringThe description of the linked entry.
fieldIdstringThe API identifier of the field where the entry is linked from.
contentTypeIdstringThe API identifier of the content type that the linked entry is based on.
dataFormatstringEither entry or asset.
languagestringlanguageThe language code of the entry variation.

Example

This JSON example shows an entry usage info object based on a linked actor entry.

{
    "id": "3995f92c-2b3c-45bb-b2a6-1f1b6314be7a",
    "title": "Brad Pitt",
    "description": "William Bradley \"Brad\" Pitt (born December 18, 1963) is an American actor and film producer.",
    "fieldId": "actor",
    "contentTypeId": "actor",
    "dataFormat": "entry",
    "language": "en-GB"
}