HTTP - Management

Component

Created by Contensis product team, last modified by r.bromley on 20 Jul 2021

A component determines a reusable schema added to content types which entries are then created from. Components contain a list of fields just like content types, and allow for a standardised schema for modelling content. Find out more about components.

Properties

Name	Data type	Data format	Description	Example
id	string	uuid	A unique component 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 component
description	string	localized value	The description text given to a component
fields	object[...]	field	A collection of fields that form the schema for an entry
dataFormat	string		This will always be component
version	object	version	Version information about the content type

Example

{
    "id": "movieRole",
    "projectId": "website",
    "name": {
        "en-GB": "Movie Role"
    },
    "description": {
        "en-GB": "A Persons role within a movie"
    },
    "fields": [
        {
            "id": "person",
            "name": {
                "en-GB": "Person"
            },
            "dataType": "object",
            "dataFormat": "entry",
            "description": {
                "en-GB": "The actor or crew member"
            },
            "default": {},
            "validations": {
                "allowedContentTypes": {
                    "contentTypes": [
                        "person"
                    ]
                }
            },
            "editor": {
                "id": "entry",
                "instructions": {
                    "en-GB": ""
                },
                "properties": {
                    "placeholderText": {
                        "en-GB": ""
                    }
                }
            }
        },
        {
            "id": "role",
            "name": {
                "en-GB": "Role"
            },
            "dataType": "String",
            "dataFormat": null,
            "description": {},
            "default": {},
            "validations": null,
            "editor": null
        }
    ],
    "dataFormat": "component",
    "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"
    }
}