Skip to main content

Properties

NameTypeFormatDescription
idstring-A 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
validationsobject-The validations that will be performed on the field when the entry is either created or updated
editorobjecteditorConfiguration for the Contensis entry field editor
groupIdstring-The 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

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

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