Skip to main content
Browse Documentation
HTTP - Management

Entry

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

An entry definition in the Delivery API contains a mixture of standard properties and properties that have been defined by the content type that an entry is based on.

Properties

NameData typeData formatDescriptionExample
[fieldId]anyField data that is defined in the associated content type. The data is keyed by a unique field id.
entryTitlestringThe value of the field determined by the content type to always be the title.
entryDescriptionstringThe value of the field determined by the content type to always be the description.
sysobjectThe container of the entry system data.
sys.idstringuuidThe entry identifier as a 128 bit GUID.
sys.projectIdstringThe project identifier found in the project overview screen of the management console.movieDb
sys.contentTypeIdstringThe API identifier of the content type that the entry is based on.
sys.dataFormatstringEither entry or asset.
sys.languagestringlanguageThe language code of the entry variation.en-GB
sys.availableLanguagesstring[...]languageA list languages which have available translations.
sys.unavailableLanguagesstring[...]languageA list languages which the entry can be translated to but have yet to be completed.
sys.uristringURIThe entry URI.
sys.metadataobjectThe container for the metadata associated with the entry
sys.workflowobjectThe container for the workflow data associated with the entry
sys.workflow.idstringThe API identifier of the workflow that the entry is using.contensisEntryBasic
sys.workflow.statestringThe API identifier of the current workflow state of the entry.draft
sys.workflow.allowedEventsstring[...]A list of workflow events which can be carried out from the current state.
sys.workflow.transitionobjectTransition data associated with the last workflow transition.
sys.workflow.transition.fromstringThe state the entry transitioned from.
sys.workflow.transition.eventstringThe event which tiggered the transition into the current statepublish
sys.workflow.transition.dataobjectData which has been supplied for the current transition.Declined reason when failing an entry approval
sys.workflow.transition.invokedBystringThe username of the user who invoked the transition
sys.workflow.transition.invokeddatetimeThe date and time the transition took place
sys.isPublishedboolean If the entry is currently pubished then the value will be true. If the entry has yet to be published or has been unpublished it will be false.
sys.translationStatestringThe API identifier of the translation status of the entry.Possible values are None, NeverTranslated, Translated, TranslationOutOfDate, NoDefaultLanguage, AvailableForTranslation, NotAvailableForTranslation
sys.versionobjectversionVersion info specific to the entry variation.

Example

{
    "title": "Back to the future",
    "tagline": "He's the only kid ever to get into trouble before he was born.",
    "overview": "Marty McFly, a typical American teenager of the Eighties, is accidentally sent back to 1955 in a plutonium-powered DeLorean \"time machine\" invented by slightly mad scientist. During his often hysterical, always amazing trip back in time, Marty must make certain his teenage parents-to-be meet and fall in love - so he can get back to the future.",
    "trailer": "https://www.youtube.com/watch?v=qvsgGtivCgs",
    "releaseDate": "1985-07-02T23:00:00Z",
    "actors": [
        {
            "sys": {
                "id": "a1c983d6-4aaf-4456-9f3d-a6eac3139f1c",
                "language": "en-GB",
                "dataFormat": "entry"
            }
        },
        {
            "sys": {
                "id": "16f6f2de-e901-4bda-bf3f-092b93ae62a9",
                "language": "en-GB",
                "dataFormat": "entry"
            }
        },
        {
            "sys": {
                "id": "09b87c0b-67b2-4028-9358-e29ff16f11da",
                "language": "en-GB",
                "dataFormat": "entry"
            }
        }
    ],

    "sys": {
        "id": "71f73a9b-2a13-4d63-bcc1-e8ee5047b01c",
        "contentTypeId": "movie",
        "projectId": "movieDb",
        "language": "en-GB",
        "availableLanguages": [
            "en-GB",
            "fr"
        ],
        "unavailableLanguages": [
            "de"
        ],
        "dataFormat": "entry",
        "metadata": {},
        "workflow": {
            "id": "contensisEntryBasic",
            "state": "versionComplete",
            "allowedEvents": [
                "versionComplete.sysUpdate",
                "versionComplete.sysDelete",
                "sysUnpublish"
            ],
            "transition": {
                "data": null,
                "invoked": "2020-03-24T14:51:35.8923327Z",
                "from": "draft",
                "invokedBy": "zengenti",
                "event": "publish"
            }
        },
        "isPublished": true,
        "translationState": "Translated",
        "version": {
            "createdBy": "s.derrickson",
            "created": "2016-10-12T09:29:18.5144641+01:00",
            "modifiedBy": "b.cumberbatch",
            "modified": "2020-03-24T14:51:35.7048498Z",
            "publishedBy": "b.cumberbatch",
            "published": "2020-03-24T14:51:35.8610917Z",
            "versionNo": "2.0"
        }
    }
}