Skip to main content

Properties

NameTypeFormatDescriptionExample
uuidstringuuidThe renderer identifier as a 128 bit GUID
idstringA unique renderer identifiermovie-listing
projectIdstringThe project identifier found in the project overview screen of the management consolemovieDb
namestringThe friendly name given to a renderer
descriptionstringThe description text given to a renderer
assignedContentTypesstring[...]An array of content type Id's associated with the renderermovie, actor, studio
rulesobject[...]Currently we support a single rule with a specified blockId. In the future we will extend rules to support multiple block and endpoint combinations based on different criteria.
versionobjectversionVersion information about the renderer

Example

HTTP
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
{ "uuid": "f8e9989a-3db7-45d3-8b11-b447afe2d401", "id": "top-movie-listing", "projectId": "movieDb", "name": "Latest top 10 movies", "description": "Renders the latest top 10 movies ordered by release date", "assignedContentTypes": ["landingPage"], "rules": [ { "return": { "blockId": "movie-listing", "endpointId": null } } ], "version": { "createdBy": "CI block push", "created": "2023-01-12T15:41:07.88043Z", "modifiedBy": null, "modified": null, "publishedBy": "CI block push", "published": "2023-01-12T15:41:07.88043Z", "versionNo": "1.0" } }
HTTP
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
{ "uuid": "f8e9989a-3db7-45d3-8b11-b447afe2d401", "id": "top-movie-listing", "projectId": "movieDb", "name": "Latest top 10 movies", "description": "Renders the latest top 10 movies ordered by release date", "assignedContentTypes": ["landingPage"], "rules": [ { "return": { "blockId": "movie-listing", "endpointId": null } } ], "version": { "createdBy": "CI block push", "created": "2023-01-12T15:41:07.88043Z", "modifiedBy": null, "modified": null, "publishedBy": "CI block push", "published": "2023-01-12T15:41:07.88043Z", "versionNo": "1.0" } }

Still need help?

New support request