Content definition

Schema

Content definitions have the following structure:

Name			Type	Optional	Unique
id			string	true	true
name			string		true
contentFields		array
	name		string
	contentFieldDefinitionName		string
	options
		isRequired	boolean
		isUnique	boolean
		isIndexed	boolean

contentFields.name

It needs to be unique within a content definition.

contentFields.contentFieldDefinitionName

It needs to match the name of an existing content field definition.

Operations

Read

By name

Request: GET <host>/content-definition/name/<content definition name>

It will return a single content definition by name.

List

Request: GET <host>/content-definition

It will return all content definitions.

Create

Request: POST <host>/content-definition

It will create a new content definition. The body should contain the content definition data without the id field.

Warning

Before creating a content definition you should ensure that all content field definitions exist.

Update

Request: PATCH <host>/content-definition

It will update an existing content definition. The body should contain the content definition data including the id field. The content should include all properties, delta update is not supported.

Warning

Before updating a content definition you should ensure that all content field definitions exist.

Delete

By name

Request: DELETE <host>/content-definition/name/<content definition name>

It will delete an existing content definition by name.