description |
---|
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. |
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.
Data properties are items defined by the fields collection set in a content type.
These are the standard properties that all entries have. The language property is the indexer for the entry data as an entry can have multiple language variations which can be edited and versioned independently. In the Delivery API context only a single language variation is available for an entry.
Name | Type | Format | Description |
---|---|---|---|
field id | Any | Any | Field data that is defined in the associated content type. The data is keyed by a unique field id. |
sys | object | Sys | The container of the entry system data |
Name | Type | Format | Description |
---|---|---|---|
id | string | GUID | The entry identifier as a 128 bit GUID |
projectId | string | The project identifier, e.g. "movieDb". Found in the project overview screen of the management console | |
contentTypeId | string | The API identifier of the content type that the entry is based on | |
dataFormat | string | Either entry or asset | |
language | string | Language code | The language code of the entry variation |
availableLanguages | string[] | Language code | A list languages which have available translations. |
uri | string | URI | The entry uri |
allUris | string[] | URI | All uris associated with the entry |
metadata | object | Metadata associated with the entry instance | |
workflow | object | Workflow associated with the entry instance. | |
workflow.id | string | The API identifier of the workflow that the entry is using. | |
workflow.state | string | The API identifier of the current workflow state of the entry. | |
isPublished | boolean | 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. | |
version | object | Version | Version info specific to the entry variation |
This JSON example shows an entry based on a movie content type.
{
"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",
"contentTypeId": "actor",
"uri": "actors/mjfox"
}
},
{
"sys": {
"id": "16f6f2de-e901-4bda-bf3f-092b93ae62a9",
"language": "en-GB",
"dataFormat": "entry",
"contentTypeId": "actor",
"uri": "actors/clloyd"
}
},
{
"sys": {
"id": "09b87c0b-67b2-4028-9358-e29ff16f11da",
"language": "en-GB",
"dataFormat": "entry",
"contentTypeId": "actor",
"uri": "actors/lthompson"
}
}
],
"sys": {
"id": "71f73a9b-2a13-4d63-bcc1-e8ee5047b01c",
"projectId": "movieDb",
"contentTypeId": "movie",
"dataFormat": "entry",
"language": "en-GB",
"availableLanguages": [
"en-GB",
"fr"
],
"uri" : "/movies/bttf",
"allUris" : [
"/movies/bttf"
"/mjfox/movies/bttf"
],
"metadata": {},
"workflow": {
"id": "contensisEntryBasic",
"state": "versionComplete",
},
"isPublished": true,
"version": {
"createdBy": "s.derrickson",
"created": "2016-10-12T09:29:18.5144641+01:00",
"modifiedBy": "b.cumberbatch",
"modified": "2016-10-13T10:15:12.1973648+01:00",
"publishedBy": "b.cumberbatch",
"published": "2016-10-13T10:15:12.1973648+01:00",
"versionNo": "2.0"
}
}
}