Skip to content

Latest commit

 

History

History
174 lines (164 loc) · 5.57 KB

content-type.md

File metadata and controls

174 lines (164 loc) · 5.57 KB
description
A content type resource can be retrieved from the Delivery API to understand the schema of an entry.

Content type

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 Type Format Description
id string A unique content type identifier
projectId string The project identifier, e.g. "movieDb". Found in the project overview screen of the management console
name object Localized value The friendly name given to a content type
description object 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
enabled boolean
defaultLanguage string Language code
supportedLanguages string [...] Language code
workflowId string The workflow that derived entries will use. Options are contensisEntryBasic or contensisEntryApproval. Default is contensisEntryBasic
dataFormat string Either entry or asset
previewUrl string The URL where an example of an entry based on the content type can be viewed
version object Version Version information about the content type

Field

The field object is the definition of a field within an entry. The field also contains the validations and editor configuration that is used within the Contensis UI and services.

Properties

Name Type Format Description
id string A unique field identifier
name object Localized value A friendly name for the field
description object Localized value The description for the field's purpose
dataType string Data type The field data type
dataFormat string Data type The field data format
default object Localized value The default value for the field if no value is provided by an editor
validations object The validations that will be performed on the field when the entry is either created or updated
editor object Editor Configuration for the Contensis entry editor

Localized value

A localized value is an object that has values keyed by language codes. This allows multilingual variations of a specific property.

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"
          }
        }
      }
    },
    {
      "id": "tagline",
      "name": {
        "en-GB": "Tagline"
      },
      "dataType": "String",
      "dataFormat": null,
      "description": {},
      "default": {},
      "validations": null,
      "editor": null
    },
    {
      "id": "overview",
      "name": {
        "en-GB": "Overview"
      },
      "dataType": "String",
      "dataFormat": "html",
      "description": {},
      "default": {},
      "validations": null,
      "editor": null
    },
    {
      "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": {}
      }
    },
    {
      "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"
          }
        }
      }
    }
  ],
  "enabled": true,
  "defaultLanguage": "en-GB",
  "supportedLanguages": [
    "en-GB",
    "fr-FR",
    "de-DE",
    "es"
  ],
  "workflowId": "ContensisMultilingual",
  "dataFormat": "entry",
  "previewUrl": "http://www.mymoviewebsite.com/movies/terminator",
  "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"
    }
}