Updates the content type at the current location or create a new one if it doesn't already exist.

1 min

PUT

/api/episerver/v3.0/contenttypes/{id}

Path Parameters

idstring<uuid>required
Description
The identifier of the content type.
Format
uuid

Query Parameters

allowedDowngradesversionComponent
Description
Defines which types of downgrades that are allowed.
allowedUpgradesversionComponent
Description
Defines which types of upgrades that are allowed.

Header Parameters

acceptstring
Description
Generated from available response content types
Default
application/json
Allowed
application/jsonapplication/problem+json

Body Parameters

bodycontentTyperequired
Description
The content type that should be created or updated.
- idstring<uuid>
  Description
  The unique identifier of the content type.
  Format
  uuid
- namestringrequired
  Description
  The name of the content type.
  Max Length
  50
  Pattern
  [a-zA-Z][\w]*
- baseTypestringrequired
  Description
  The base type for this content type.
- versionstring
  Example
  2.1.0
  Description
  The version of the content type.
- editSettingscontentTypeEditSettings
  Description
  Defines settings for content type that affects how it is displayed when edited.
  - displayNamestring
    Description
    The name that should be used when editing the content type.
    Max Length
    50
  - descriptionstring
    Description
    The description that should be used when editing the content type.
    Max Length
    255
  - availableboolean
    Description
    Determines if the content type is available when editing.
  - sortOrderinteger<int32>
    Description
    The field order used for ordering the content types when editing.
    Format
    int32
    Minimum
    0
    Maximum
    2147483647

Responses

200OK

contentType
Description
A content type definition describes the format of content items.
- idstring<uuid>
  Description
  The unique identifier of the content type.
  Format
  uuid
- namestringrequired
  Description
  The name of the content type.
  Max Length
  50
  Pattern
  [a-zA-Z][\w]*
- baseTypestringrequired
  Description
  The base type for this content type.
- versionstring
  Example
  2.1.0
  Description
  The version of the content type.
- editSettingscontentTypeEditSettings
  Description
  Defines settings for content type that affects how it is displayed when edited.
  - displayNamestring
    Description
    The name that should be used when editing the content type.
    Max Length
    50
  - descriptionstring
    Description
    The description that should be used when editing the content type.
    Max Length
    255
  - availableboolean
    Description
    Determines if the content type is available when editing.
  - sortOrderinteger<int32>
    Description
    The field order used for ordering the content types when editing.
    Format
    int32
    Minimum
    0
    Maximum
    2147483647
- propertiescontentTypeProperty[]
  Description
  A list with the properties of this content type.
  - namestringrequired
    Description
    The name of the property.
    Max Length
    100
    Pattern
    [a-zA-Z][\w]*
  - dataTypestringrequired
    Description
    The main data type name.
    Max Length
    255
    Pattern
    [a-zA-Z][(\w\s*\w?),\.]*
  - branchSpecificboolean
    Description
    Indicates if the property has specific values for each content branch or if values are shared between all branches.
  - editSettingspropertyEditSettings
    Description
    Defines settings for content type properties that affects how the property is displayed when edited.
    - visibilityvisibilityStatus
      Description
      Specifies the visibility status of a property in edit view.
    - displayNamestring
      Description
      The name that should be used when editing the property.
      Max Length
      255
    - groupNamestring
      Description
      Name of the property group that this property should be displayed in.
      Max Length
      100
      Pattern
      [a-zA-Z][\w]*
    - sortOrderinteger<int32>
      Description
      The field order used for ordering the properties when editing.
      Format
      int32
      Minimum
      0
      Maximum
      2147483647
    - helpTextstring
      Description
      The text that should be used as help when editing the property.
      Max Length
      2000
    - hintstring
      Description
      A hint that will be used when resolving which editor that should be used when editing this property.
      Max Length
      255
  - validationpropertyValidationSettings[]
    Description
    The validation settings of the property.
    - namestringrequired
      Description
      The name of the validation type that should be performed.
    - severityvalidationErrorSeverity
    - errorMessagestring
      Description
      The error message to use for any validation error.
  - itemTypestring
    Description
    The item type for cases when the 'dataType' is 'PropertyBlock'.
    Max Length
    255
    Pattern
    [a-zA-Z][(\w\s*\w?),\.]*

201Created

contentType
Description
A content type definition describes the format of content items.
- idstring<uuid>
  Description
  The unique identifier of the content type.
  Format
  uuid
- namestringrequired
  Description
  The name of the content type.
  Max Length
  50
  Pattern
  [a-zA-Z][\w]*
- baseTypestringrequired
  Description
  The base type for this content type.
- versionstring
  Example
  2.1.0
  Description
  The version of the content type.
- editSettingscontentTypeEditSettings
  Description
  Defines settings for content type that affects how it is displayed when edited.
  - displayNamestring
    Description
    The name that should be used when editing the content type.
    Max Length
    50
  - descriptionstring
    Description
    The description that should be used when editing the content type.
    Max Length
    255
  - availableboolean
    Description
    Determines if the content type is available when editing.
  - sortOrderinteger<int32>
    Description
    The field order used for ordering the content types when editing.
    Format
    int32
    Minimum
    0
    Maximum
    2147483647
- propertiescontentTypeProperty[]
  Description
  A list with the properties of this content type.
  - namestringrequired
    Description
    The name of the property.
    Max Length
    100
    Pattern
    [a-zA-Z][\w]*
  - dataTypestringrequired
    Description
    The main data type name.
    Max Length
    255
    Pattern
    [a-zA-Z][(\w\s*\w?),\.]*
  - branchSpecificboolean
    Description
    Indicates if the property has specific values for each content branch or if values are shared between all branches.
  - editSettingspropertyEditSettings
    Description
    Defines settings for content type properties that affects how the property is displayed when edited.
    - visibilityvisibilityStatus
      Description
      Specifies the visibility status of a property in edit view.
    - displayNamestring
      Description
      The name that should be used when editing the property.
      Max Length
      255
    - groupNamestring
      Description
      Name of the property group that this property should be displayed in.
      Max Length
      100
      Pattern
      [a-zA-Z][\w]*
    - sortOrderinteger<int32>
      Description
      The field order used for ordering the properties when editing.
      Format
      int32
      Minimum
      0
      Maximum
      2147483647
    - helpTextstring
      Description
      The text that should be used as help when editing the property.
      Max Length
      2000
    - hintstring
      Description
      A hint that will be used when resolving which editor that should be used when editing this property.
      Max Length
      255
  - validationpropertyValidationSettings[]
    Description
    The validation settings of the property.
    - namestringrequired
      Description
      The name of the validation type that should be performed.
    - severityvalidationErrorSeverity
    - errorMessagestring
      Description
      The error message to use for any validation error.
  - itemTypestring
    Description
    The item type for cases when the 'dataType' is 'PropertyBlock'.
    Max Length
    255
    Pattern
    [a-zA-Z][(\w\s*\w?),\.]*

400Bad Request

403Forbidden

409Conflict

curl

curl --request PUT \
     --url '/api/episerver/v3.0/contenttypes/{id}?allowedDowngrades=object&allowedUpgrades=object' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "name": "",
     "baseType": ""
     }'

javascript

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

var raw = JSON.stringify({
   "name": "",
   "baseType": ""
});

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

fetch("/api/episerver/v3.0/contenttypes/{id}?allowedDowngrades=object&allowedUpgrades=object", 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("/api/episerver/v3.0/contenttypes/{id}?allowedDowngrades=object&allowedUpgrades=object")

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

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

python

import requests
import json

url = "/api/episerver/v3.0/contenttypes/{id}?allowedDowngrades=object&allowedUpgrades=object"

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

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

print(response.text)

200

// OK
{
  "id": "",
  "name": "",
  "baseType": "",
  "version": "2.1.0",
  "editSettings": {
    "displayName": "",
    "description": "",
    "available": false,
    "sortOrder": ""
  },
  "properties": [
    {
      "name": "",
      "dataType": "",
      "branchSpecific": false,
      "editSettings": {
        "visibility": "",
        "displayName": "",
        "groupName": "",
        "sortOrder": "",
        "helpText": "",
        "hint": ""
      },
      "validation": [
        {
          "name": "",
          "severity": "",
          "errorMessage": ""
        }
      ],
      "itemType": ""
    }
  ]
}

201

// Created
{
  "id": "",
  "name": "",
  "baseType": "",
  "version": "2.1.0",
  "editSettings": {
    "displayName": "",
    "description": "",
    "available": false,
    "sortOrder": ""
  },
  "properties": [
    {
      "name": "",
      "dataType": "",
      "branchSpecific": false,
      "editSettings": {
        "visibility": "",
        "displayName": "",
        "groupName": "",
        "sortOrder": "",
        "helpText": "",
        "hint": ""
      },
      "validation": [
        {
          "name": "",
          "severity": "",
          "errorMessage": ""
        }
      ],
      "itemType": ""
    }
  ]
}

400

// Bad Request

403

// Forbidden

409

// Conflict