HTTP - Delivery

Content type

Created by Contensis product team, last updated 17 Jul 2020

A content type resource can be retrieved from the Delivery API to understand the schema of an entry. Entries are constructed and validated using the information defined in the fields collection.

Properties

Name	Data type	Data format	Description	Example
id	string	uuid	A unique content type identifier
projectId	string		The project identifier found in the project overview screen of the management console	movieDb
name	string	localized value	The friendly name given to a content type
description	string	localized value	The description text given to a content type
entryTitleField	string		The id of the field which should be used as the title in entry listings
entryDescriptionField	string		The id of the field which should be used as the description in entry listings
fields	object[...]	field	A collection of fields that form the schema for an entry
groups	object[...]	content type group	A collection of groups that enable related fields to be grouped together in the UI
enabled	boolean		If enabled then entries can be created from the content type
defaultLanguage	string	language	The default language of entries created using the content type
supportedLanguages	string[...]	language	A list languages which the content type supports
workflowId	string		The workflow that derived entries will follow
dataFormat	string		Either entry or asset
previewUrl	string		The URL where an example of an entry based on the content type can be viewed
defaultRendererId	string	uuid	The ID for the default renderer for the content type. Null if there is no default renderer
defaultParentNodeId	string	uuid	The ID for the default parent node for the content type. Null if there is no default parent node. All entries created using the content type will be created in the following node.
version	object	version	Version information about the content type

Example

{
  "id": "movie",
  "projectId": "website",
  "name": {
    "en-GB": "Movie"
  },
  "description": {
    "en-GB": "A movie type"
  },
  "entryTitleField": "title",
  "entryDescriptionField": "overview",
  "fields": [
    {
      "id": "title",
      "name": {
        "en-GB": "Title"
      },
      "dataType": "String",
      "dataFormat": null,
      "description": {},
      "default": {},
      "validations": null,
      "editor": {
        "id": "text",
        "instructions": {
          "en-GB": "The title of the movie"
        },
        "properties": {
          "placeholderText": {
            "en-GB": "Enter the full title of the movie appropriate to the region"
          }
        },
        "groupId": "summary"
      }
    },
    {
      "id": "tagline",
      "name": {
        "en-GB": "Tagline"
      },
      "dataType": "String",
      "dataFormat": null,
      "description": {},
      "default": {},
      "validations": null,
      "editor": null,
      "groupId": null
    },
    {
      "id": "overview",
      "name": {
        "en-GB": "Overview"
      },
      "dataType": "String",
      "dataFormat": "html",
      "description": {},
      "default": {},
      "validations": null,
      "editor": null,
      "groupId": "additionalInfo"
    },
    {
      "id": "releaseDate",
      "name": {
        "en-GB": "Release Date"
      },
      "dataType": "dateTime",
      "dataFormat": null,
      "description": {},
      "default": {},
      "validations": null,
      "editor": {
        "id": "date",
        "instructions": {
          "en-GB": "The release date of the movie"
        },
        "properties": {}
      },
      "groupId": "summary"
    },
    {
      "id": "actors",
      "name": {
        "en-GB": "Actors"
      },
      "dataType": "ObjectArray",
      "dataFormat": "entry",
      "description": {},
      "default": {},
      "validations": {
        "contentType": {
          "contentType": "dan"
        }
      },
      "editor": {
        "id": "entry",
        "instructions": {
          "en-GB": ""
        },
        "properties": {
          "placeholderText": {
            "en-GB": "Add the main actors"
          }
        }
      },
      "groupId": "additionalInfo"
    }
  ],
  "groups": [
      {
          "id": "summary",
          "name": {
              "en-GB": "Main summary fields"
          }
      },
      {
          "id": "additionalInfo",
          "name": {
              "en-GB": "Additional Information"
      }
    }
  ], 
  "enabled": true,
  "defaultLanguage": "en-GB",
  "supportedLanguages": [
    "en-GB",
    "fr-FR",
    "de-DE",
    "es"
  ],
  "workflowId": "ContensisMultilingual",
  "dataFormat": "entry",
  "previewUrl": "http://www.mymoviewebsite.com/movies/terminator",
  "defaultRendererId": "F1A7ABD5-9241-4FBD-AD1C-E1F46B6F6D44",
  "defaultParentNodeId": "3C7361CD-58A0-46CD-A414-F6D105BD8454",
  "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"
    }
}