Asset

Properties

Name	Type	Format	Description	Example
title	string	-	The title of the asset
entryTitle	string	-	The title of the asset, all entries have a field called entryTitle.
description	string	-	The description of the asset
entryDescription	string	-	The description of the asset, all entries have a field called entryDescription.
thumbnail	string	link	The thumbail image specified for the asset
keywords	string	-	Keywords associated with the asset
altText	string	-	In the case of an image this will be populated with the image default ALT text
properties	object	-	The container of the asset properties
properties.filename	string	-	The filename of the asset
properties.filesize	number	-	The filesize of the asset in kb
properties.width	number	-	Only available for an image. This is the width of the image in px
properties.height	number	-	Only available for an image. This is the height of the image in px
sys	object	-	The container of the asset system data.
id	string	uuid	The asset identifier as a 128 bit GUID.
projectId	string	-	The project identifier found in the project overview screen of the management console.	movieDb
contentTypeId	string	-	The API identifier of the content type that the entry is based on.
dataFormat	string	-	Either entry or asset.
language	string	language	The language code of the entry variation.	en-GB
availableLanguages	string[...]	language	A list languages which have available translations.
unavailableLanguages	string[...]	language	A list languages which the entry can be translated to but have yet to be completed.
uri	string	URI	The entry URI.
metadata	object	-	The container for the metadata associated with the entry
workflow	object	-	The container for the workflow data associated with the entry
workflow.id	string	-	The API identifier of the workflow that the entry is using.	contensisEntryBasic
workflow.state	string	-	The API identifier of the current workflow state of the entry.	draft
workflow.allowedEvents	string[...]	-	A list of workflow events which can be carried out from the current state.
workflow.transition	object	-	Transition data associated with the last workflow transition.
workflow.transition.from	string	-	The state the entry transitioned from.
workflow.transition.event	string	-	The event which tiggered the transition into the current state	publish
workflow.transition.data	string	-	Data which has been supplied for the current transition.	Declined reason when failing an entry approval
workflow.transition.invokedBy	string	-	The username of the user who invoked the transition
workflow.transition.invoked	datetime	-	The date and time the transition took place
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.
translationState	string	-	The API identifier of the translation status of the entry.	Possible values are None, NeverTranslated, Translated, TranslationOutOfDate, NoDefaultLanguage, AvailableForTranslation, NotAvailableForTranslation
Version	object	version	Version info specific to the entry variation.

Example

JSON

{
    "title": "Al Pacino",
    "description": "Photo of Al Pacino in Scarface",
    "keywords": "Al Pacino, Alfredo Pacino, Scarface, Godfather",
    "altText": "Al Pacino wearing a white suit",
    "thumbnail": {
        "sys": {
            "id": "639f00f2-800f-41e6-9713-c57d925fface",
            "dataFormat": "asset",
            "language": "en-GB"
        }
    },
    "entryTitle": "Al Pacino",
    "entryDescription": null,
    "sys": {
        "projectId": "website",
        "metadata": {
            "includeInSearch": true,
            "includeInAToZ": false,
            "includeInMenu": false,
            "includeInSiteMap": false,
            "nodeId": "e33d1064-d1ff-4dab-937d-252596b75dde"
        },
        "properties": {
            "filename": "al-pacino.jpg",
            "fileSize": 65031,
            "fileId": "e33d1064-d1ff-4dab-937d-252596b75dde",
            "width": 600,
            "height": 900
        },
        "version": {
            "createdBy": "ServicesUser",
            "created": "2020-03-24T11:30:19.0084202Z",
            "modifiedBy": "ServicesUser",
            "modified": "2020-04-21T08:58:45.7037069Z",
            "publishedBy": "ServicesUser",
            "published": "2020-04-21T08:59:15.9296679Z",
            "versionNo": "2.0"
        },
        "owner": "zengenti",
        "isPublished": false,
        "availableLanguages": [
            "en-GB"
        ],
        "unavailableLanguages": [],
        "translationState": "None",
        "id": "e33d1064-d1ff-4dab-937d-252596b75dde",
        "dataFormat": "asset",
        "language": "en-GB",
        "uri": "/image-library/people-images/al-pacino.jpg",
        "contentTypeId": "image"
    }
}

JSON

{
    "title": "Al Pacino",
    "description": "Photo of Al Pacino in Scarface",
    "keywords": "Al Pacino, Alfredo Pacino, Scarface, Godfather",
    "altText": "Al Pacino wearing a white suit",
    "thumbnail": {
        "sys": {
            "id": "639f00f2-800f-41e6-9713-c57d925fface",
            "dataFormat": "asset",
            "language": "en-GB"
        }
    },
    "entryTitle": "Al Pacino",
    "entryDescription": null,
    "sys": {
        "projectId": "website",
        "metadata": {
            "includeInSearch": true,
            "includeInAToZ": false,
            "includeInMenu": false,
            "includeInSiteMap": false,
            "nodeId": "e33d1064-d1ff-4dab-937d-252596b75dde"
        },
        "properties": {
            "filename": "al-pacino.jpg",
            "fileSize": 65031,
            "fileId": "e33d1064-d1ff-4dab-937d-252596b75dde",
            "width": 600,
            "height": 900
        },
        "version": {
            "createdBy": "ServicesUser",
            "created": "2020-03-24T11:30:19.0084202Z",
            "modifiedBy": "ServicesUser",
            "modified": "2020-04-21T08:58:45.7037069Z",
            "publishedBy": "ServicesUser",
            "published": "2020-04-21T08:59:15.9296679Z",
            "versionNo": "2.0"
        },
        "owner": "zengenti",
        "isPublished": false,
        "availableLanguages": [
            "en-GB"
        ],
        "unavailableLanguages": [],
        "translationState": "None",
        "id": "e33d1064-d1ff-4dab-937d-252596b75dde",
        "dataFormat": "asset",
        "language": "en-GB",
        "uri": "/image-library/people-images/al-pacino.jpg",
        "contentTypeId": "image"
    }
}

JSON

{
    "title": "Al Pacino",
    "description": "Photo of Al Pacino in Scarface",
    "keywords": "Al Pacino, Alfredo Pacino, Scarface, Godfather",
    "altText": "Al Pacino wearing a white suit",
    "thumbnail": {
        "sys": {
            "id": "639f00f2-800f-41e6-9713-c57d925fface",
            "dataFormat": "asset",
            "language": "en-GB",
            "contentTypeId": "image",
            "uri": "/image-library/people-images/al-pacino-thumbnail.x30cc3dd3.jpg"
        }
    },
    "entryTitle": "Al Pacino",
    "entryDescription": null,
    "sys": {
        "projectId": "website",
        "metadata": {
            "includeInSearch": true,
            "includeInAToZ": false,
            "includeInMenu": false,
            "includeInSiteMap": false,
            "nodeId": "e33d1064-d1ff-4dab-937d-252596b75dde"
        },
        "properties": {
            "filename": "al-pacino.jpg",
            "fileSize": 65031,
            "fileId": "e33d1064-d1ff-4dab-937d-252596b75dde",
            "width": 600,
            "height": 900
        },
        "version": {
            "createdBy": "ServicesUser",
            "created": "2020-03-24T11:30:19.0084202Z",
            "modifiedBy": "ServicesUser",
            "modified": "2020-04-21T08:58:45.7037069Z",
            "publishedBy": "ServicesUser",
            "published": "2020-04-21T08:59:15.9296679Z",
            "versionNo": "2.0"
        },
        "owner": "zengenti",
        "isPublished": false,
        "availableLanguages": [
            "en-GB"
        ],
        "id": "e33d1064-d1ff-4dab-937d-252596b75dde",
        "dataFormat": "asset",
        "language": "en-GB",
        "uri": "/image-library/people-images/al-pacino.jpg",
        "contentTypeId": "image"
    }
}

Still need help?

If you still need help after reading this article, don't hesitate to reach out to the Contensis community on Slack or raise a support ticket to get help from our team.

New support request