Skip to main content

Properties

NameTypeFormatDescriptionExample
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

JSON
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
{ "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" }
JSON
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
{ "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" }
JSON
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
{ "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" }

Still need help?

New support request