Creating new Content Types 1¶
A new Content Type
can be created either by sending a properly formatted POST request to the /api/v1/internal/contenttype
endpoint or through the Content Modeler tool provided with the platform.
Note
You will need to use your Application Read and write API KEY to perform this action.
Read more about API keys and scoped API keys.
Creating new Content Types via API¶
Creating a new
Content Type is simply a POST call with a payload similar to:
{
"name": "blogposts",
"label": "Blog Posts",
"schemaDefinition": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AbstractContentTypeSchemaDefinition"
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1
},
"postContent": {
"type": "string",
"minLength": 1
}
}
}
],
"required": [
"title",
"postContent"
],
"additionalProperties": false
},
"metaDefinition": {
"propertiesConfig": {
"title": {
"label": "Title",
"inputType": "text",
"unique": true
},
"postContent": {
"label": "Post content",
"inputType": "richtext",
"unique": false
}
},
"order": [
"title",
"postContent"
]
}
}
Let's quickly look at the properties of this object. On the top level, there are the following properties:
- name - is an API-friendly name of the
Content Type and name of the endpoints that will be generated to handle requests with
Content Objects of that type. Can only have
a-zcharacters and_. - label - is a human-friendly label used to refer to this Content Type in the UI
- schemaDefinition - contains an OpenAPI-compliant schema of the Content Type (more about this below)
- metaDefinition - contains additional properties of the fields (more about this below)
For simplicity - this example uses a straightforward Content Type, which only has two attributes:
- title
- postContent
and you can see those listed under the schemaDefinition property.
The schema definition property¶
The schemaDefinition part of the JSON payload is based on the bare JSON OpenAPI 3.0 Schema and is fully compatible.
It holds information about the properties of the
CT
(in the properties key), its types and which properties are required (required key).
Schema definition always should have "type": "object", as it is an object, and "additionalProperties": false
to ensure that API users will not post garbage to the objects of this CTD.
To ensure that all objects have a proper id property
CTD
also should have information about the connection with AbstractContentTypeSchemaDefinition using:
"allOf": [
{
"$ref": "#/components/schemas/AbstractContentTypeSchemaDefinition"
}
],
All property names should have only a-z, A-Z, 0-9 and _ characters. id and objectType property names are restricted.
The meta definition property¶
Finally - the metaDefinition attribute is used to store additional properties, which for example, tell us how to
render forms for the Content Object; it holds information about the order of the properties (order key, which
should contain all properties of the object), and about type and validation of the field. It also includes information
on relations of the object with other Content Types.
In this case, Blog Post will have title property which will be unique and will render as text input in the CMS panel
and postContent, which can be duplicated and presented as CKEditor input in the CMS panel.
The first input in the form in the CMS panel will be title input, and the second will be postContent.
Creating Content Type Definition examples¶
Example
curl --location --request POST "https://api.flotiq.com/api/v1/internal/contenttype" \
--header 'X-AUTH-TOKEN: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--data-raw '{
"name":"blogposts",
"label":"Blog Posts",
"schemaDefinition":{
"type":"object",
"allOf":[{
"$ref":"#/components/schemas/AbstractContentTypeSchemaDefinition"
},{
"type":"object",
"properties":{
"title":{"type":"string"},
"postContent":{"type":"string"}}}
],
"required":["title","postContent"],
"additionalProperties":false
},
"metaDefinition":{
"propertiesConfig":{
"title":{
"label":"Title",
"inputType":"text",
"unique":true},
"postContent":{
"label":"Post content",
"inputType":"richtext",
"unique":false}},
"order":["title","postContent"]}
}'
var client = new RestClient("https://api.flotiq.com/api/v1/internal/contenttype");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader("X-AUTH-TOKEN", "YOUR_API_KEY");
request.AddParameter("application/json", "{\"name\":\"blogposts\",\"label\":\"Blog Posts\",\"schemaDefinition\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/AbstractContentTypeSchemaDefinition\"},{\"type\":\"object\",\"properties\":{\"title\":{\"type\":\"string\"},\"postContent\":{\"type\":\"string\"}}}],\"required\":[\"title\",\"postContent\"],\"additionalProperties\":false},\"metaDefinition\":{\"propertiesConfig\":{\"title\":{\"label\":\"Title\",\"inputType\":\"text\",\"unique\":true},\"postContent\":{\"label\":\"Post content\",\"inputType\":\"richtext\",\"unique\":false}},\"order\":[\"title\",\"postContent\"]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https://api.flotiq.com/api/v1/internal/contenttype"
payload := strings.NewReader("{\"name\":\"blogposts\",\"label\":\"Blog Posts\",\"schemaDefinition\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/AbstractContentTypeSchemaDefinition\"},{\"type\":\"object\",\"properties\":{\"title\":{\"type\":\"string\"},\"postContent\":{\"type\":\"string\"}}}],\"required\":[\"title\",\"postContent\"],\"additionalProperties\":false},\"metaDefinition\":{\"propertiesConfig\":{\"title\":{\"label\":\"Title\",\"inputType\":\"text\",\"unique\":true},\"postContent\":{\"label\":\"Post content\",\"inputType\":\"richtext\",\"unique\":false}},\"order\":[\"title\",\"postContent\"]}}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
req.Header.Add("X-AUTH-TOKEN", "YOUR_API_KEY")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"name\":\"blogposts\",\"label\":\"Blog Posts\",\"schemaDefinition\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/AbstractContentTypeSchemaDefinition\"},{\"type\":\"object\",\"properties\":{\"title\":{\"type\":\"string\"},\"postContent\":{\"type\":\"string\"}}}],\"required\":[\"title\",\"postContent\"],\"additionalProperties\":false},\"metaDefinition\":{\"propertiesConfig\":{\"title\":{\"label\":\"Title\",\"inputType\":\"text\",\"unique\":true},\"postContent\":{\"label\":\"Post content\",\"inputType\":\"richtext\",\"unique\":false}},\"order\":[\"title\",\"postContent\"]}}");
Request request = new Request.Builder()
.url("https://api.flotiq.com/api/v1/internal/contenttype")
.post(body)
.addHeader("content-type", "application/json")
.addHeader("X-AUTH-TOKEN", "YOUR_API_KEY")
.build();
Response response = client.newCall(request).execute();
HttpResponse<String> response = Unirest.post("https://api.flotiq.com/api/v1/internal/contenttype")
.header("content-type", "application/json")
.header("X-AUTH-TOKEN", "YOUR_API_KEY")
.body("{\"name\":\"blogposts\",\"label\":\"Blog Posts\",\"schemaDefinition\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/AbstractContentTypeSchemaDefinition\"},{\"type\":\"object\",\"properties\":{\"title\":{\"type\":\"string\"},\"postContent\":{\"type\":\"string\"}}}],\"required\":[\"title\",\"postContent\"],\"additionalProperties\":false},\"metaDefinition\":{\"propertiesConfig\":{\"title\":{\"label\":\"Title\",\"inputType\":\"text\",\"unique\":true},\"postContent\":{\"label\":\"Post content\",\"inputType\":\"richtext\",\"unique\":false}},\"order\":[\"title\",\"postContent\"]}}")
.asString();
const request = require('request');
const options = {
method: 'POST',
url: 'https://api.flotiq.com/api/v1/internal/contenttype',
headers: {'content-type': 'application/json', 'X-AUTH-TOKEN': 'YOUR_API_KEY'},
body: {
"name": "blogposts",
"label": "Blog Posts",
"schemaDefinition": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AbstractContentTypeSchemaDefinition"
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1
},
"postContent": {
"type": "string",
"minLength": 1
}
}
}
],
"required": [
"title",
"postContent"
],
"additionalProperties": false
},
"metaDefinition": {
"propertiesConfig": {
"title": {
"label": "Title",
"inputType": "text",
"unique": true
},
"postContent": {
"label": "Post content",
"inputType": "richtext",
"unique": false
}
},
"order": [
"title",
"postContent"
]
}
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.flotiq.com/api/v1/internal/contenttype",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "{\"name\":\"blogposts\",\"label\":\"Blog Posts\",\"schemaDefinition\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/AbstractContentTypeSchemaDefinition\"},{\"type\":\"object\",\"properties\":{\"title\":{\"type\":\"string\"},\"postContent\":{\"type\":\"string\"}}}],\"required\":[\"title\",\"postContent\"],\"additionalProperties\":false},\"metaDefinition\":{\"propertiesConfig\":{\"title\":{\"label\":\"Title\",\"inputType\":\"text\",\"unique\":true},\"postContent\":{\"label\":\"Post content\",\"inputType\":\"richtext\",\"unique\":false}},\"order\":[\"title\",\"postContent\"]}}",
CURLOPT_HTTPHEADER => [
"X-AUTH-TOKEN: YOUR_API_KEY",
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
Responses
Returned when the schema has been correct and was saved
{
"name": "blogposts",
"label": "Blog Posts",
"schemaDefinition": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AbstractContentTypeSchemaDefinition"
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1
},
"postContent": {
"type": "string",
"minLength": 1
}
}
}
],
"required": [
"title",
"postContent"
],
"additionalProperties": false
},
"metaDefinition": {
"propertiesConfig": {
"title": {
"label": "Title",
"inputType": "text",
"unique": true
},
"postContent": {
"label": "Post content",
"inputType": "richtext",
"unique": false
}
},
"order": [
"title",
"postContent"
]
}
}
Returned when the schema has not been correct and wasn't saved
{
"name": [
"This value is already used."
],
"label": [
"Must be at least 1 characters long"
],
"schemaDefinition.allOf[1].properties.title.type": [
"Does not have a value in the enumeration [\"array\",\"boolean\",\"integer\",\"null\",\"number\",\"object\",\"string\"]"
],
"metaDefinition.propertiesConfig.price.label": [
"The property label is required"
],
"metaDefinition.propertiesConfig.price.inputType": [
"Does not have a value in the enumeration [\"text\",\"richtext\",\"textarea\",\"textMarkdown\",\"email\",\"number\",\"radio\",\"checkbox\",\"select\",\"datasource\",\"object\",\"geo\"]"
]
}
Returned when API key was missing or incorrect
{
"code": 401,
"massage": "Unauthorized"
}
Possible validation errors¶
| Property path | Possible errors | Description |
|---|---|---|
| name | This value is already used |
Send when Content Type with that name already exists |
The property name is required |
Send when property name is missing | |
Must be at least 1 characters long |
Send when property name has empty string value | |
This value is not valid. |
Send when property name have non-acceptable characters | |
| label | The property label is required |
Send when property label is missing |
Must be at least 1 characters long |
Send when property label has empty string value | |
| schemaDefinition.properties | You must specify at least one schema property |
Send when schemaDefinition does not have any properties specified |
Invalid value. Only a-z, A-Z, 0-9 and _ are allowed |
Send when property name in schemaDefinition has invalid characters |
|
Property name {propertyName} not allowed |
Send when property name is id or objectType |
|
| schemaDefinition.allOf | Invalid schema definition for content type. Schema definition should have 2 elements: reference to #/components/schemas/AbstractContentTypeSchemaDefinition and object with properties list. Check https://flotiq.com/docs/API/content-types/creating-ctd/ for details. |
Send when schemaDefinition property have more than 2 objects in allOf array |
| schemaDefinition.allOf.0.$ref | Invalid schema definition for content type. Schema definition should have reference to #/components/schemas/AbstractContentTypeSchemaDefinition. Check https://flotiq.com/docs/API/content-type/creating-ctd/ for details. |
Send when schemaDefinition property does not have reference to Abstract Content Type Schema Definition in the first object of allOf array |
| schemaDefinition.allOf.1.$ref | Invalid schema definition for content type. Schema definition should have object with properties list. Check https://flotiq.com/docs/API/content-types/creating-ctd/ for details. |
Send when schemaDefinition property does not have properties definitions in the first object of allOf array |
| schemaDefinition.allOf[1].properties.{name}.type | Does not have a value in the enumeration ["array", "boolean", "integer", "null", "number", "object", "string"] |
Send when property type is invalid, for valid properties type check properties table |
| metaDefinition.propertiesConfig.{name}.label | The property label is required |
Send when property label is missing |
| metaDefinition.propertiesConfig.{name}.inputType | Does not have a value in the enumeration ["text", "richtext", "textarea", "textMarkdown", "email", "number", "radio", "checkbox", "select", "datasource", "object", "geo"] |
Send when property inputType in metaDefinitionis invalid, for valid properties inputTYpe check meta definition properties table |
| metaDefinition.order | Property name {propertyName} not existing in the order |
Send when property is not included in the order array |
| metaDefinition.propertiesConfig | Property name {propertyName} not existing in meta definition |
Send when property existing in schemaDefinition is not included in the metaDefinition properties config |
Property name {propertyName} not existing in schema definition |
Send when property existing in metaDefinition is not included in the schemaDefinition properties config |
|
| metaDefinition.propertiesConfig.{name} | Wrong meta type for type of {propertyName} |
Send when property has incompatible inputType in metaDefinition properties config to its type in schemaDefinition |
You have to specify type of relation for {propertyName} |
Send when property is a relation to other type, but not specify in validation to which type it is restricted |
After such call is made the Content Type is created - the User API is immediately extended to support interaction with this new Content Type:
All Content Types have automatically added properties from AbstractContentTypeSchemaDefinition; they are:
- id - string identifier of Content Object, required in all requests, unique within the Content Type,
- internal - object necessary to proper work of CMS backend (information about dates of creation and update, the whole object is described in JSON below).
Schema of Abstract Content Type
"AbstractContentTypeSchemaDefinition": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"internal": {
"type":"object",
"description":"Immutable object containing system information, it will be automatically generated on object creation and regenerated on updates.",
"additionalProperties":false,
"required": [
"createdAt",
"updatedAt",
"deletedAt",
"contentType"
],
"properties": {
"contentType": {
"type":"string",
"description":"Name of Content Type Definition of object"
},
"createdAt": {
"type":"string",
"description":"Date and time of creation of Content Object, in ISO 8601 date format"
},
"updatedAt": {
"type":"string",
"description":"Date and time of last update of Content Object, in ISO 8601 date format"
},
"deletedAt": {
"type":"string",
"description":"Date and time of deletion of Content Object, in ISO 8601 date format"
},
"workflow_state": {
"type":"string",
"description":"Information about object's current state in workflow"
}
}
}
},
"required": [
"id"
]
},
Property types¶
Property types (as of schemaDefinition properties), recognized by CMS panel:
| type | Description | Additional keys in property | Description |
|---|---|---|---|
| string | Any string data that includes date and files | minLength | Minimal length of filed content |
| pattern | Regex pattern of filed content | ||
| default | Default value of the field | ||
| number | Any number, integer, float and double | minLength | Minimal length of filed content |
| default | Default value of the field | ||
| boolean | Represents two values, true and false. Note that truthy and falsy values such as "true", "", 0 or null are not considered boolean values. |
none allowed | |
| array | Used for lists or relations. | items | For relations: it has to be an object containing {"$ref": "#/components/schemas/DataSource"}, as the items of the array are objects described in DataSource schema.For list items: it should be a valid json schema following the same restrictions as wrapping schema |
| minItems | 0 for a not required property, and 1 for required property |
||
| object | Used for geo point and block types | properties | must be {"lat": {"type": "number"},"lon": {"type": "number"}} for geo object and {"time": {"type": "number"}, "blocks": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string"}, "type": {"type": "string"}, "data": {"type": "object", "properties": {"text": {"type": "string"}}, "additionalProperties": true}}}}, "version": {"type": "string"}} for block object |
| additionalProperties | must be false |
||
| type | must be object |
||
| required | if it is geo field and the field is required it must be ["lat","lon"] |
You can use every type of property multiple times across the Content Type Definition.
Meta definition properties types¶
Input types of properties in metaDefinition:
| inputType | Possible for schema type | Description | Additional keys in property | Type | Description | Additional keys | Description |
|---|---|---|---|---|---|---|---|
| text | string | Renders text input in form | unique* | bool | Information if the property's value should be unique in all object of the specified type. | none allowed | |
| isTitlePart | bool | Should this field be displayed when listing objects in relation select | none allowed | ||||
| helpText | string | Help text displayed in dashboard Content Object form and as description in Open API Schema | none allowed | ||||
| label* | string | People friendly name of the field | none allowed | ||||
| hidden | bool | Field will be hidden | none allowed | ||||
| readonly | bool | Field cannot be modified | none allowed | ||||
| textarea | string | Renders textarea in form | unique* | bool | Information if the property's value should be unique in all object of the specified type. | none allowed | |
| isTitlePart | bool | Should this field be displayed when listing objects in relation select | none allowed | ||||
| helpText | string | Help text displayed in dashboard Content Object form and as description in Open API Schema | none allowed | ||||
| label* | string | People friendly name of the field | none allowed | ||||
| hidden | bool | Field will be hidden | none allowed | ||||
| readonly | bool | Field cannot be modified | none allowed | ||||
| markdown | string | Renders Markdown in form | unique* | bool | Information if the property's value should be unique in all object of the specified type. | none allowed | |
| helpText | string | Help text displayed in dashboard Content Object form and as description in Open API Schema | none allowed | ||||
| label* | string | People friendly name of the field | none allowed | ||||
| hidden | bool | Field will be hidden | none allowed | ||||
| readonly | bool | Field cannot be modified | none allowed | ||||
| richtext | string | Renders CKEditor in form | unique* | bool | Information if the property's value should be unique in all object of the specified type. | none allowed | |
| helpText | string | Help text displayed in dashboard Content Object form and as description in Open API Schema | none allowed | ||||
| label* | string | People friendly name of the field | none allowed | ||||
| hidden | bool | Field will be hidden | none allowed | ||||
| readonly | bool | Field cannot be modified | none allowed | ||||
| string | Renders email input in form | unique* | bool | Information if the property's value should be unique in all object of the specified type. | none allowed | ||
| isTitlePart | bool | Should this field be displayed when listing objects in relation select | none allowed | ||||
| helpText | string | Help text displayed in dashboard Content Object form and as description in Open API Schema | none allowed | ||||
| label* | string | People friendly name of the field | none allowed | ||||
| hidden | bool | Field will be hidden | none allowed | ||||
| readonly | bool | Field cannot be modified | none allowed | ||||
| number | number | Renders number input in the form; min is 0, max is MAX INT | unique* | bool | Information if the property's value should be unique in all object of the specified type. | none allowed | |
| isTitlePart | bool | Should this field be displayed when listing objects in relation select | none allowed | ||||
| helpText | string | Help text displayed in dashboard Content Object form and as description in Open API Schema | none allowed | ||||
| label* | string | People friendly name of the field | none allowed | ||||
| hidden | bool | Field will be hidden | none allowed | ||||
| readonly | bool | Field cannot be modified | none allowed | ||||
| radio | string | Renders radio input, options are taken from options property |
unique* | bool | Information if the property's value should be unique in all object of the specified type, Can only be false |
none allowed | |
| options | array | Array of string options possible for the radio input | none allowed | ||||
| helpText | string | Help text displayed in dashboard Content Object form and as description in Open API Schema | none allowed | ||||
| label* | string | People friendly name of the field | none allowed | ||||
| hidden | bool | Field will be hidden | none allowed | ||||
| readonly | bool | Field cannot be modified | none allowed | ||||
| checkbox | boolean | Renders single checkbox input returning true/false value |
unique* | bool | Information if the property's value should be unique in all object of the specified type, Can only be false |
none allowed | |
| helpText | string | Help text displayed in dashboard Content Object form and as description in Open API Schema | none allowed | ||||
| label* | string | People friendly name of the field | none allowed | ||||
| hidden | bool | Field will be hidden | none allowed | ||||
| readonly | bool | Field cannot be modified | none allowed | ||||
| select | string | Renders single item select input, options are taken from options or optionsWithLabels property |
unique* | bool | Information if the property's value should be unique in all object of the specified type. | none allowed | |
| options | array | Array of string options possible for the select input | none allowed | ||||
| optionsWithLabels | array | Array of object options, that contain value and label properties, possible for the select input |
none allowed | ||||
| useOptionsWithLabels | bool | Bool value informing if select should use optionsWithLabels or options property, false by default |
none allowed | ||||
| isTitlePart | bool | Should this field be displayed when listing objects in relation select | none allowed | ||||
| helpText | string | Help text displayed in dashboard Content Object form and as description in Open API Schema | none allowed | ||||
| label* | string | People friendly name of the field | none allowed | ||||
| hidden | bool | Field will be hidden | none allowed | ||||
| readonly | bool | Field cannot be modified | none allowed | ||||
| object | array | Renders one or multiple forms for nested meta definition element |
items | object | Meta definition for single list item |
same as in wrapping meta definition (order and propertiesConfig) |
|
| helpText | string | Help text displayed in dashboard Content Object form and as description in Open API Schema | none allowed | ||||
| label* | string | People friendly name of the field | none allowed | ||||
| hidden | bool | Field will be hidden | none allowed | ||||
| readonly | bool | Field cannot be modified | none allowed | ||||
| datasource | array | Renders picker for choosing the objects of specified or any other Content Type, depending on validation property |
unique* | bool | Information if the property's value should be unique in all object of the specified type. | none allowed | |
| validation | array | Object contains restrictions for datasource | relationContenttype | Name of the Content Type to which relation should be restricted | |||
| relationMultiple | Boolean value informing if the array should have only one or can have more elements | ||||||
| helpText | string | Help text displayed in dashboard Content Object form and as description in Open API Schema | none allowed | ||||
| label* | string | People friendly name of the field | none allowed | ||||
| hidden | bool | Field will be hidden | none allowed | ||||
| readonly | bool | Field cannot be modified | none allowed | ||||
| geo | object | Renders two fields, one for the latitude, second for the longitude, saves it as an object | unique* | bool | Information if the property's value should be unique in all object of the specified type. | none allowed | |
| helpText | string | Help text displayed in dashboard Content Object form and as description in Open API Schema | none allowed | ||||
| label* | string | People friendly name of the field | none allowed | ||||
| hidden | bool | Field will be hidden | none allowed | ||||
| readonly | bool | Field cannot be modified | none allowed | ||||
| dateTime | string | Render date picker input, and time picker if option showTime is selected. | helpText | string | Help text displayed in dashboard Content Object form and as description in Open API Schema | none allowed | |
| isTitlePart | bool | Should this field be displayed when listing objects in relation select | none allowed | ||||
| label* | string | People friendly name of the field | none allowed | ||||
| showTime | bool | Whether to display a picker for hours | none allowed | ||||
| unique* | bool | Information if the property's value should be unique in all object of the specified type. | none allowed | ||||
| hidden | bool | Field will be hidden | none allowed | ||||
| readonly | bool | Field cannot be modified | none allowed | ||||
| block | object | Renders editor.js in form and contains json with description of html blocks instead of the html blocks | unique* | bool | Information if the property's value should be unique in all object of the specified type, Can only be false |
none allowed | |
| blockEditorTypes | array | Names of plugins used in editor, possible plugins: header, list, image, youtubeEmbed, quote, warning, delimiter. Paragraph is available always as it is default text block. |
none allowed | ||||
| helpText | string | Help text displayed in dashboard Content Object form and as description in Open API Schema | none allowed | ||||
| label* | string | People friendly name of the field | none allowed | ||||
| hidden | bool | Field will be hidden | none allowed | ||||
| readonly | bool | Field cannot be modified | none allowed |
*Required property
Example with every type of field¶
Example with every type of field
{
"name": "example",
"label": "Example",
"internal": false,
"schemaDefinition": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AbstractContentTypeSchemaDefinition"
},
{
"type": "object",
"properties": {
"geo": {
"type": "object",
"required": [
"lat",
"lon"
],
"properties": {
"lat": {
"type": "number"
},
"lon": {
"type": "number"
}
},
"additionalProperties": false
},
"date": {
"type": "string",
"default": "2021-12-12T12:00",
"pattern": "^([12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01]))T?(([0-1]?[0-9]|2[0-3]):[0-5][0-9])?$",
"minLength": 1
},
"list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"geo_in_subobject": {
"type": "object",
"properties": {
"lat": {
"type": "number"
},
"lon": {
"type": "number"
}
},
"additionalProperties": false
},
"date_in_subobject": {
"type": "string",
"default": "2021-12-12T12:00",
"pattern": "^([12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01]))T?(([0-1]?[0-9]|2[0-3]):[0-5][0-9])?$"
},
"text_in_subobject": {
"type": "string",
"default": "Lorem",
"pattern": "^[a-zA-Z ]*$"
},
"block_in_subobject": {
"type": "object",
"properties": {
"time": {
"type": "number"
},
"blocks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"text": {
"type": "string"
}
},
"additionalProperties": true
},
"type": {
"type": "string"
}
}
}
},
"version": {
"type": "string"
}
},
"additionalProperties": false
},
"emain_in_subobject": {
"type": "string"
},
"media_in_subobject": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataSource"
},
"minItems": 0
},
"radio_in_subobject": {
"type": "string"
},
"number_in_subobject": {
"type": "number",
"default": 1000
},
"select_in_subobject": {
"type": "string",
"default": "Option c"
},
"checkbox_in_subobject": {
"type": "boolean"
},
"markdown_in_subobject": {
"type": "string"
},
"relation_in_subobject": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataSource"
},
"minItems": 0
},
"textarea_in_subobject": {
"type": "string",
"default": "Lorem ipsum"
},
"rich_text_in_subobject": {
"type": "string"
}
}
},
"minLength": 1
},
"text": {
"type": "string",
"default": "01-01-2021",
"pattern": "^\\d{2}-\\d{2}-\\d{4}$",
"minLength": 1
},
"block": {
"type": "object",
"minLength": 1,
"properties": {
"time": {
"type": "number"
},
"blocks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"text": {
"type": "string"
}
},
"additionalProperties": true
},
"type": {
"type": "string"
}
}
}
},
"version": {
"type": "string"
}
},
"additionalProperties": false
},
"email": {
"type": "string",
"minLength": 1
},
"media": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataSource"
},
"minItems": 1
},
"radio": {
"type": "string",
"minLength": 1
},
"number": {
"type": "number",
"default": 0,
"minLength": 1
},
"select": {
"type": "string",
"default": "Option 1",
"minLength": 1
},
"checkbox": {
"type": "boolean"
},
"markdown": {
"type": "string",
"minLength": 1
},
"relation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataSource"
},
"minItems": 1
},
"textarea": {
"type": "string",
"default": "Lorem ipsum dolor sit amet.",
"minLength": 1
},
"rich_text": {
"type": "string",
"minLength": 1
}
}
}
],
"required": [
"text",
"textarea",
"markdown",
"rich_text",
"email",
"number",
"radio",
"select",
"relation",
"list",
"geo",
"media",
"date",
"block"
],
"additionalProperties": false
},
"metaDefinition": {
"order": [
"text",
"textarea",
"markdown",
"rich_text",
"email",
"number",
"radio",
"checkbox",
"select",
"relation",
"list",
"geo",
"media",
"date",
"block"
],
"propertiesConfig": {
"geo": {
"label": "Geo",
"unique": true,
"helpText": "Geo field, it has lat and lon property",
"inputType": "geo"
},
"date": {
"label": "Date",
"unique": true,
"helpText": "Date value following short ISO format (YYYY-MM-DDTHH:mm / YYYY-MM-DD), without timezone, can be with or without time",
"showTime": true,
"inputType": "dateTime",
"isTitlePart": true
},
"list": {
"items": {
"order": [
"text_in_subobject",
"textarea_in_subobject",
"markdown_in_subobject",
"rich_text_in_subobject",
"emain_in_subobject",
"number_in_subobject",
"radio_in_subobject",
"checkbox_in_subobject",
"select_in_subobject",
"relation_in_subobject",
"geo_in_subobject",
"media_in_subobject",
"date_in_subobject",
"block_in_subobject"
],
"propertiesConfig": {
"geo_in_subobject": {
"label": "Geo in subobject",
"unique": false,
"helpText": "Geo field in subobject, cantains lat and lon properties",
"inputType": "geo"
},
"date_in_subobject": {
"label": "Date in subobject",
"unique": false,
"helpText": "Date value following short ISO format (YYYY-MM-DDTHH:mm / YYYY-MM-DD), without timezone, can be with or without time",
"showTime": true,
"inputType": "dateTime"
},
"text_in_subobject": {
"label": "Text in subobject",
"unique": false,
"helpText": "Text in subobject with regex ensuring only letters and spaces",
"inputType": "text"
},
"block_in_subobject": {
"label": "Block in subobject",
"unique": false,
"helpText": "Block editor with all blocks possible",
"inputType": "block",
"blockEditorTypes": [
"header",
"list",
"image",
"youtubeEmbed",
"quote",
"warning",
"delimiter"
]
},
"emain_in_subobject": {
"label": "Emain in subobject",
"unique": false,
"helpText": "Email field in subobject",
"inputType": "email"
},
"media_in_subobject": {
"label": "Media in subobject",
"unique": false,
"helpText": "Multiple relation to media in subobject",
"inputType": "datasource",
"validation": {
"relationMultiple": true,
"relationContenttype": "_media"
}
},
"radio_in_subobject": {
"label": "Radio in subobject",
"unique": false,
"options": [
"Option a",
"Option b",
"Option c"
],
"helpText": "Radio in subobject with 3 options",
"inputType": "radio"
},
"number_in_subobject": {
"label": "Number in subobject",
"unique": false,
"helpText": "NUmber field in subobject with default value",
"inputType": "number"
},
"select_in_subobject": {
"label": "Select in subobject",
"unique": false,
"options": [
"Option a",
"Option b",
"Option c"
],
"helpText": "Select filed in subobject with 3 options and default value",
"inputType": "select"
},
"checkbox_in_subobject": {
"label": "Checkbox in subobject",
"unique": false,
"helpText": "Checkbox in subobject",
"inputType": "checkbox"
},
"markdown_in_subobject": {
"label": "Markdown in subobject",
"unique": false,
"helpText": "Markdown in subobject",
"inputType": "textMarkdown"
},
"relation_in_subobject": {
"label": "Relation in subobject",
"unique": false,
"helpText": "Multiple relation in subobject restricted to test type",
"inputType": "datasource",
"validation": {
"relationMultiple": true,
"relationContenttype": "test"
}
},
"textarea_in_subobject": {
"label": "Textarea in subobject",
"unique": false,
"helpText": "Textarea in subobject",
"inputType": "textarea"
},
"rich_text_in_subobject": {
"label": "Rich text in subobject",
"unique": false,
"helpText": "Rich text in subobject",
"inputType": "richtext"
}
}
},
"label": "List",
"unique": false,
"helpText": "List of subobjects",
"inputType": "object"
},
"text": {
"label": "text",
"unique": true,
"helpText": "Text with regex for date, e.g. 01-01-2021",
"inputType": "text",
"isTitlePart": true
},
"block": {
"label": "Block",
"unique": false,
"helpText": "Block editor with all blocks possible",
"inputType": "block",
"blockEditorTypes": [
"header",
"list",
"image",
"youtubeEmbed",
"quote",
"warning",
"delimiter"
]
},
"email": {
"label": "Email",
"unique": true,
"helpText": "Email field",
"inputType": "email",
"isTitlePart": true
},
"media": {
"label": "Media",
"unique": true,
"helpText": "Multiple relation to media type",
"inputType": "datasource",
"validation": {
"relationMultiple": true,
"relationContenttype": "_media"
}
},
"radio": {
"label": "Radio",
"unique": false,
"options": [
"Option 1",
"Option 2",
"Option 3"
],
"helpText": "Radio field with 3 options",
"inputType": "radio"
},
"number": {
"label": "Number",
"unique": true,
"helpText": "Number filed with default value",
"inputType": "number",
"isTitlePart": true
},
"select": {
"label": "Select",
"unique": true,
"options": [
"Option 1",
"Option 2",
"Option 3"
],
"helpText": "Select field, because it must be unique and has only 3 options, there will be maximum of 3 objects of this type",
"inputType": "select",
"isTitlePart": true
},
"checkbox": {
"label": "Checkbox",
"unique": false,
"helpText": "Checkbox field, if it would be required everybody would have to check it.",
"inputType": "checkbox"
},
"markdown": {
"label": "Markdown",
"unique": true,
"helpText": "Markdown long text",
"inputType": "textMarkdown"
},
"relation": {
"label": "Relation",
"unique": true,
"helpText": "Multiple relation restricted to test type",
"inputType": "datasource",
"validation": {
"relationMultiple": true,
"relationContenttype": "test"
}
},
"textarea": {
"label": "Textarea",
"unique": true,
"helpText": "Long text with default value",
"inputType": "textarea",
"isTitlePart": true
},
"rich_text": {
"label": "Rich text",
"unique": true,
"helpText": "Rich long text",
"inputType": "richtext"
}
}
}
}
Creating Content Types through the Content modeller¶
If you'd rather use our graphical interface to design your Content Types - read the Content modeller documentation
Register to send all requests with your own API today
-
Number of available Content Type Definitions depends on the chosen subscription plan. Check pricing and limits on the Flotiq Pricing page ↩