Skip to main content
Browse Documentation
HTTP - Management

Field

Created by Contensis product team, last modified by r.turner on 16 Jul 2020

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

NameData typeData formatDescription
idstringA unique field identifier
nameobjectlocalized valueA friendly name for the field
descriptionobjectlocalized valueThe description for the field's purpose
dataTypestringdataTypeThe field data type
dataFormatstringdataFormatThe field data format
defaultobjectlocalized valueThe default value for the field if no value is provided by an author
validationsobjectThe validations that will be performed on the field when the entry is either created or updated
editorobjecteditorConfiguration for the Contensis entry field editor
groupIdstringThe identifier of the group (defined in the content type groups property) that the field belongs to. Enables related fields to be grouped together in the UI

Example

{
      "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"
      }
    }