Skip to main content
Browse Documentation
HTTP - Management

Component

Created by Contensis product team, last modified by zengenti on 29 Sep 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

NameData typeData formatDescriptionExample
idstringuuidA unique component identifier
projectIdstringThe project identifier found in the project overview screen of the management consolemovieDb
namestringlocalized valueThe friendly name given to a component
descriptionstringlocalized valueThe description text given to a component
fieldsobject[...]fieldA collection of fields that form the schema for an entry
dataFormatstringThis will always be component
versionobjectversionVersion information about the content type

Example

{
    "isChild": false,
    "hasChildren": false,
    "canAddChildComponents": true,
    "canBeAddedAsChildComponent": true,
    "version": {
        "createdBy": "s.derrickson",
        "created": "2021-09-29T09:08:35.5627633Z",
        "modifiedBy": "c.chamberlain",
        "modified": "2021-09-29T09:15:01.8108527Z",
        "publishedBy": "c.chamberlain",
        "published": "2021-09-29T09:15:03.4046546Z",
        "versionNo": "2.0"
    },
    "uuid": "10617c57-85f5-4149-9131-08ed4cd97488",
    "id": "movieRole",
    "projectId": "movieDb",
    "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": {},
            "default": null,
            "validations": {
                "allowedContentTypes": {
                    "contentTypes": [
                        "person"
                    ],
                    "message": null
                }
            },
            "editor": null
        },
        {
            "id": "role",
            "name": {
                "en-GB": "Role"
            },
            "dataType": "string",
            "dataFormat": null,
            "description": {},
            "default": null,
            "validations": {},
            "editor": null
        }
    ],
    "dataFormat": "component"
}
Necessary Cookies
These cookies are necessary for this website to function correctly. They are set when you perform certain actions on the site, such as creating an account, logging in, changing your privacy preferences or submitting a form. You can block these cookies in your browser, but this will stop parts of the site from working properly.
Functional Cookies
These cookies allow the website to provide extra functionality and more personalised experiences. They may be set by us or by third party providers whose services we have added to our pages. If you choose not to allow these cookies, these services may not work correctly.
Analytical Cookies
These cookies record anonymous data on how visitors use our website to help us monitor how well our website works. This data includes how many people have looked at specific pages, how long visitors stay on the site, and what devices they use. We use this data to identify changes that we could make to improve your experience and make our website more efficient.
Marketing Cookies
We set some cookies so you are shown more relevant marketing content. These include cookies from third-party advertising networks to show you different adverts on their services if you have previously visited our site. If you choose not to allow these cookies, you may experience less relevant advertising on other sites.