GET /structured-content/content-types/{content_type_id}

1 min

GET

https://api.cmp.optimizely.com/v3/structured-content/content-types/{content_type_id}

Experimental Get content type.

Path Parameters

content_type_idstringrequired
Description
Unique identifier of the content type

Responses

200Successful response

SCContentType
- objectBaseContentTypeModel
  - namestringrequired
    Description
    Name of the content type
  - descriptionstring
    Description
    Description of the content type
  - componentbooleanrequired
    Description
    Status determining whether the content type is a component
  - disabledboolean
    Description
    Disabled status of the content type
  - sourcestring
    Description
    Source of the content type
  - thumbnail_guidstring
    Description
    Thumbnail GUID of the content type
  - content_type_guidstringrequired
    Description
    Unique identifier of the content type
  - created_bystringrequired
    Description
    Unique identifier of the user who created the content type
  - updated_bystringrequired
    Description
    Unique identifier of the user who last updated the content type
  - created_atstring<date-time>required
    Description
    Date and time on which the content type was created, in ISO 8601 UTC format
    Format
    date-time
  - updated_atstring<date-time>required
    Description
    Date and time on which the content type was last updated, in ISO 8601 UTC format
    Format
    date-time
  - source_idstring
    Description
    Source of the content type
  - source_metadatastring
    Description
    Source metadata of the content type
  - linksobjectrequired
    Description
    Meta Links
    - selfstring
      Example
      https://api.cmp.optimizely.com/v3/structured-content/content-types/9fda53cf66a14fd487251480ca695c7b
      Description
      URL of the content type
    - versionsstring
      Example
      https://api.cmp.optimizely.com/v3/structured-content/content-types/9fda53cf66a14fd487251480ca695c7b/versions
      Description
      URL of the content type versions
- object
  - latest_versionSCContentTypeVersionrequired
    - BaseContentTypeVersionModel
      - latestbooleanrequired
        Description
        Indicates whether the version is the latest
      - version_guidstringrequired
        Description
        Unique identifier of the version
      - created_bystringrequired
        Description
        Unique identifier of the user who created the version
      - created_atstring<date-time>required
        Description
        Date and time on which the version was created, in ISO 8601 UTC format
        Format
        date-time
      - expected_localesstring[]required
        Description
        Expected locales of the version
      - linksobjectrequired
        Description
        Meta links
        selfstring
        Example
        https://api.cmp.optimizely.com/v3/structured-content/content-types/555876bf63e94ea4b3ec4da318736414/versions/31a6d15b09c54a04935203eb958ae058
        Description
        URL of the content type version
        content_typestring
        Example
        https://api.cmp.optimizely.com/v3/structured-content/content-types/555876bf63e94ea4b3ec4da318736414
        Description
        URL of the content type
    - object
      - field_definitionsNumberFieldDefinition[]required
        coreCoreFieldDefrequired
        keystringrequired
        Description
        Key of the field
        namestringrequired
        Description
        Name of the field
        is_listbooleanrequired
        Description
        Indicates whether the field is a list
        is_requiredbooleanrequired
        Description
        Required status of the field
        need_internationalizationbooleanrequired
        Description
        Indicates whether the field needs internationalization
        min_list_lengthinteger
        Description
        Minimum length of the list
        max_list_lengthinteger
        Description
        Maximum length of the list
        field_typeFieldType
        Description
        An enumeration.
        source_idstring
        Description
        Source ID of the field
        source_metadatastring
        Description
        Source metadata of the field
        order_indexinteger
        Description
        Order index of the field
        help_textstring
        Description
        Helptext of the field
        editor_metadataobject
        Description
        Editor metadata of the field
        min_valuenumber
        Description
        Minimum value of the field
        max_valuenumber
        Description
        Maximum value of the field
        default_valuesnumber[]
        Description
        Default values of the field

422Validation error

HTTPValidationError
- detailValidationError[]
  Description
  Details of the error
  - locstring[]required
    Description
    Locations where the error occurred
  - msgstringrequired
    Description
    Message describing the error
  - typestringrequired
    Description
    Type of the error

curl

curl --request GET \
     --url https://api.cmp.optimizely.com/v3/structured-content/content-types/{content_type_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("https://api.cmp.optimizely.com/v3/structured-content/content-types/{content_type_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("https://api.cmp.optimizely.com/v3/structured-content/content-types/{content_type_id}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

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

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

python

import requests
import json

url = "https://api.cmp.optimizely.com/v3/structured-content/content-types/{content_type_id}"

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

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

print(response.text)

200

// Successful response
{
  "name": "",
  "description": "",
  "component": false,
  "disabled": false,
  "source": "",
  "thumbnail_guid": "",
  "content_type_guid": "",
  "created_by": "",
  "updated_by": "",
  "created_at": "",
  "updated_at": "",
  "source_id": "",
  "source_metadata": "",
  "links": {
    "self": "https://api.cmp.optimizely.com/v3/structured-content/content-types/9fda53cf66a14fd487251480ca695c7b",
    "versions": "https://api.cmp.optimizely.com/v3/structured-content/content-types/9fda53cf66a14fd487251480ca695c7b/versions"
  },
  "latest_version": {}
}

422

// Validation error
{
  "detail": [
    {
      "loc": [
        ""
      ],
      "msg": "",
      "type": ""
    }
  ]
}