Create content type

1 min

POST

/_cms/v1/contenttypes

Create a new content type.

Header Parameters

Preferstring[]
Example
```
[
  "return=representation"
]
```
Description
Indicates client preference for the response content as per IETF RFC7240. Currently only supports 'return=representation' which can be used to indicate a preference to receive a representation of the resource that has been altered in the response.

Body Parameters

bodyContentTyperequired
Description
The content type that should be created.
- keystring
  Description
  The unique identifier (key) of the resource.
  Min Length
  2
  Max Length
  255
  Pattern
  ^[A-Za-z][_0-9A-Za-z]+$
- displayNamestringrequired
  Description
  The display name of this ContentType.
  Min Length
  1
  Max Length
  255
- descriptionstring
  Description
  A description of this ContentType.
  Max Length
  255
- baseTypestring
  Description
  The base type of this ContentType. Ignored for contracts; required for all other content types.
- isContractboolean
  Description
  Specifies if the ContentType is a contract type.
- sortOrderinteger<int32>
  Description
  A value that is used to when sorting ContentType instances.
  Format
  int32
- mayContainTypesstring[]
  Description
  Provides a set of content types that can be created in containers of this type
- mediaFileExtensionsstring[]
  Description
  Provides a set of media file extensions that this content type can handle.
- compositionBehaviorsstring[]
  Description
  Provides a set of composition behaviors specifying how this content type can be used within compositions. Currently this can only be assigned when baseType is 'component'.
- contractsstring[]
  Description
  Provides a set of contract content types that this content type is bound to.
- propertiesmap<string, ContentTypeProperty>
  Description
  Dictionary with all custom properties of this ContentType.
- accessRightsSecurityIdentity[]
  Description
  The access rights assigned to this content type that defines who can create content of this type. If no access rights are assigned, everyone will be able to create content of this type. An empty array means that no new content of this type can be created.
  - namestringrequired
    Description
    The unique name of the user, role or application that this identifier references.
    Min Length
    1
    Max Length
    255
  - typestring<user | role | application>
    Description
    The type of the security entity that this identifier references. Will default to 'role' if not specified.
    Allowed
    userroleapplication

Responses

201Created

ContentType
Description
Represents a content type definition.
- keystring
  Description
  The unique identifier (key) of the resource.
  Min Length
  2
  Max Length
  255
  Pattern
  ^[A-Za-z][_0-9A-Za-z]+$
- displayNamestringrequired
  Description
  The display name of this ContentType.
  Min Length
  1
  Max Length
  255
- descriptionstring
  Description
  A description of this ContentType.
  Max Length
  255
- baseTypestring
  Description
  The base type of this ContentType. Ignored for contracts; required for all other content types.
- isContractboolean
  Description
  Specifies if the ContentType is a contract type.
- sourcestring
  Description
  A string that indicates the source of this content type. Can be used to distinguish content types created by the system from types coming from model classes in the CMS solution.
- sortOrderinteger<int32>
  Description
  A value that is used to when sorting ContentType instances.
  Format
  int32
- mayContainTypesstring[]
  Description
  Provides a set of content types that can be created in containers of this type
- mediaFileExtensionsstring[]
  Description
  Provides a set of media file extensions that this content type can handle.
- compositionBehaviorsstring[]
  Description
  Provides a set of composition behaviors specifying how this content type can be used within compositions. Currently this can only be assigned when baseType is 'component'.
- contractsstring[]
  Description
  Provides a set of contract content types that this content type is bound to.
- createdstring<date-time>
  Description
  A timestamp indicating when this resource was first created.
  Format
  date-time
- createdBystring
  Description
  The name of the user or application that created this resource.
- lastModifiedstring<date-time>
  Description
  Indicates the last time this resource was modified.
  Format
  date-time
- lastModifiedBystring
  Description
  The name of the user or application that last modified this resource.
- propertiesmap<string, ContentTypeProperty>
  Description
  Dictionary with all custom properties of this ContentType.
- accessRightsSecurityIdentity[]
  Description
  The access rights assigned to this content type that defines who can create content of this type. If no access rights are assigned, everyone will be able to create content of this type. An empty array means that no new content of this type can be created.
  - namestringrequired
    Description
    The unique name of the user, role or application that this identifier references.
    Min Length
    1
    Max Length
    255
  - typestring<user | role | application>
    Description
    The type of the security entity that this identifier references. Will default to 'role' if not specified.
    Allowed
    userroleapplication

Response Headers

ETagstring
Description
The RFC7232 ETag header field in a response provides the current entity-tag for the resource. An entity-tag is an opaque identifier for different versions of a resource over time, regardless whether multiple versions are valid at the same time.
Last-Modifiedstring<http-date>
Description
The date and time at which the resource was last modified.
Format
http-date
Locationstring
Description
Indicates the URL of the newly-created resource.
Preference-Applied

400Bad Request

401Unauthorized

403Forbidden

409Conflict

500Internal Server Error

curl

curl --request POST \
     --url /_cms/v1/contenttypes \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "displayName": "",
     "accessRights": [
     {
     "name": ""
     }
     ]
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "displayName": "",
   "accessRights": [
      {
         "name": ""
      }
   ]
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("/_cms/v1/contenttypes", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("/_cms/v1/contenttypes")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "displayName": "",
   "accessRights": [
      {
         "name": ""
      }
   ]
})

response = http.request(request)
puts response.read_body

python

import requests
import json

url = "/_cms/v1/contenttypes"

payload = json.dumps({
   "displayName": "",
   "accessRights": [
      {
         "name": ""
      }
   ]
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

201

// Created
{
  "key": "",
  "displayName": "",
  "description": "",
  "baseType": "",
  "isContract": false,
  "source": "",
  "sortOrder": "",
  "mayContainTypes": [
    ""
  ],
  "mediaFileExtensions": [
    ""
  ],
  "compositionBehaviors": [
    ""
  ],
  "contracts": [
    ""
  ],
  "created": "",
  "createdBy": "",
  "lastModified": "",
  "lastModifiedBy": "",
  "properties": "",
  "accessRights": [
    {
      "name": "",
      "type": ""
    }
  ]
}

400

// Bad Request

401

// Unauthorized

403

// Forbidden

409

// Conflict

500

// Internal Server Error