Gets the content type at the current location.

1 min

GET

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

Path Parameters

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

Header Parameters

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

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.
- supportedMediaExtensionsstring
  Example
  gif,bmp
  Description
  A comma-separated list of supported media types for media content types.
- 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.
  - requiredboolean
    Description
    Indicates if the property is required.
  - 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
  - imageDescriptorpropertyImageDescriptor
    Description
    Defines a thumbnail image format.
    - heightinteger<int32>
      Description
      Thumbnail image height
      Format
      int32
      Minimum
      0
      Maximum
      2147483647
    - widthinteger<int32>
      Description
      Thumbnail image width
      Format
      int32
      Minimum
      0
      Maximum
      2147483647
    - pregeneratedboolean
      Description
      If the thumbnail should be pregenerated when a new image is uploaded rather than when first requested
  - 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

404Not Found

curl

curl --request GET \
     --url /api/episerver/v3.0/contenttypes/{id} \
     --header 'accept: application/json'

javascript

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

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("/api/episerver/v3.0/contenttypes/{id}", 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}")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

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

python

import requests
import json

url = "/api/episerver/v3.0/contenttypes/{id}"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

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

print(response.text)

200

// OK
{
  "id": "",
  "name": "",
  "baseType": "",
  "version": "2.1.0",
  "supportedMediaExtensions": "gif,bmp",
  "editSettings": {
    "displayName": "",
    "description": "",
    "available": false,
    "sortOrder": ""
  },
  "properties": [
    {
      "name": "",
      "dataType": "",
      "branchSpecific": false,
      "required": false,
      "editSettings": {
        "visibility": "",
        "displayName": "",
        "groupName": "",
        "sortOrder": "",
        "helpText": "",
        "hint": ""
      },
      "imageDescriptor": {
        "height": "",
        "width": "",
        "pregenerated": false
      },
      "validation": [
        {
          "name": "",
          "severity": "",
          "errorMessage": ""
        }
      ],
      "itemType": ""
    }
  ]
}

400

// Bad Request

403

// Forbidden

404

// Not Found