Export manifest

1 min

GET

https://api.cms.optimizely.com/v1/manifest

Export a CMS content manifest.

Query Parameters

sectionsstring[]
Description
The sections that should be included in the manifest export. If not provided, all sections will be included.
includeReadOnlyboolean
Description
Indicates if read-only resources should be included in the manifest export.
Default
false

Responses

200OK

Manifest
Description
A set of content model definitions (content types, property groups, display templates, and locales).
- localesLocale[]
  Description
  List of locales that are part of this manifest.
  - keystringrequired
    Description
    The unique identifier (key) of the resource. This is the IETF BCP-47 language tag (e.g., "en", "en-US", "sv-SE").
    Min Length
    1
  - displayNamestringrequired
    Description
    The display name of this locale.
    Min Length
    1
    Max Length
    255
  - isEnabledboolean
    Description
    Indicates whether this locale is enabled and can be used to create content.
  - routeSegmentstringrequired
    Description
    A string that represents the segment that should be used when routing or generate routes to the current locale
    Min Length
    1
    Max Length
    255
  - sortOrderinteger<int32>
    Description
    A value that is used when sorting locales.
    Format
    int32
  - accessRightsSecurityIdentity[]
    Description
    The access rights assigned to this locale that defines who can create content in this locale. If no access rights are assigned, everyone will be able to create content in this locale. An empty array means that no user will be allowed to create or change content in this locale.
    - namestringrequired
      Description
      The unique name of the user, role or application that this identifier references.
      Min Length
      1
      Max Length
      255
    - typestring
      Examples
      user
      role
      application
      Description
      The type of the security entity that this identifier references. Will default to 'role' if not specified.
      Max Length
      50
  - createdstring<date-time>
    Description
    A timestamp indicating when this locale was first created.
    Format
    date-time
  - createdBystring
    Description
    The username of the user that created this locale.
  - lastModifiedstring<date-time>
    Format
    date-time
  - lastModifiedBystring
    Description
    The username of the user that last modified this locale.
  - fallbackstring
    Description
    A fallback locale that should be used if content is not available in the current locale.
- propertyGroupsPropertyGroup[]
  Description
  List of content type property groups that are part of this manifest.
  - keystringrequired
    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 property group.
    Min Length
    1
    Max Length
    255
  - sourcestring
    Description
    A string that indicates the source of this property group. Can be used to distinguish property groups created by the system from types coming from model classes deployed to the CMS server.
  - sortOrderinteger<int32>
    Description
    A value that is used when sorting property group instances.
    Format
    int32
  - createdstring<date-time>
    Description
    A timestamp indicating when this property group was first created.
    Format
    date-time
  - createdBystring
    Description
    The username of the user that created this property group.
  - lastModifiedstring<date-time>
    Format
    date-time
  - lastModifiedBystring
    Description
    The username of the user that last modified this property group.
- contentTypesContentType[]
  Description
  List of content types that are part of this manifest.
  - 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 content type.
    Min Length
    1
    Max Length
    255
  - descriptionstring
    Description
    A description of this content type.
    Max Length
    255
  - baseTypestring
    Examples
    _page
    _component
    _media
    _image
    _video
    _folder
    _experience
    _section
    _element
    Description
    The base type of this content type. Ignored for contracts; required for all other content types.
    Max Length
    50
  - isContractboolean
    Description
    Specifies if the content type 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 when sorting content type 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'.
  - compositionCompositionConfiguration
    Description
    Configures the built-in composition (the "canvas") for experience and section content types. Only applicable when BaseType is _experience or _section.
    - formatstring
      Description
      The layout type to use for the built-in composition (e.g. outline or grid). When empty, the default layout for the base type is used.
    - allowedTypesstring[]
      Description
      Content types and base types that the built-in composition is permitted to contain.
    - restrictedTypesstring[]
      Description
      Content types and base types that the built-in composition is forbidden from containing.
  - 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 content type.
  - 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
      Examples
      user
      role
      application
      Description
      The type of the security entity that this identifier references. Will default to 'role' if not specified.
      Max Length
      50
- displayTemplatesDisplayTemplate[]
  Description
  List of display templates that are part of this manifest.
  - 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 display template.
    Min Length
    1
    Max Length
    255
  - nodeTypestring
    Description
    The optional node type this display template is valid for.
    Min Length
    2
    Max Length
    50
    Pattern
    ^[A-Za-z][_0-9A-Za-z]+$
  - baseTypestring
    Examples
    _page
    _component
    _media
    _image
    _video
    _folder
    _experience
    _section
    _element
    Description
    The optional base type this display template is valid for.
    Max Length
    50
  - contentTypestring
    Description
    The optional key of the content type this display template is valid for.
  - isDefaultboolean
    Description
    If this is the default display template for the associated base type, node type or content type.
  - createdstring<date-time>
    Description
    A timestamp indicating when this display template was first created.
    Format
    date-time
  - createdBystring
    Description
    The username of the user that created this display template.
  - lastModifiedstring<date-time>
    Description
    A timestamp indicating when this display template was last modified.
    Format
    date-time
  - lastModifiedBystring
    Description
    The username of the user that last modified this display template.
  - settingsmap<string, DisplaySetting>
    Description
    The available settings for this display template.
- lastModifiedstring<date-time>
  Description
  A timestamp indicating the last time an item included in this manifest was modified.
  Format
  date-time

401Unauthorized

403Forbidden

429Too Many Requests

ProblemDetails
- typestring<uri>
  Description
  A URI reference that identifies the problem type.
  Format
  uri
- titlestring
  Description
  A short, human-readable summary of the problem type.
- statusinteger<int32>
  Description
  The HTTP status code generated by the origin server for this occurrence of the problem.
  Format
  int32
  Minimum
  100
  Maximum
  599
- detailstring
  Description
  A human-readable explanation specific to this occurrence of the problem.
- instancestring<uri>
  Description
  A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
  Format
  uri
- codestring
  Description
  Error code that identifies the problem type.
- errorsobject[]
  Description
  An array of error details with more detailed information about the problem.
  - detailstring
    Description
    A granular explanation of one specific error related to a field, header or query parameter.
  - fieldstring
    Example
    properties.header.displayName
    Description
    A string that may provide a hint to which field that was the source of the error.

Response Headers

Retry-Afternumber
Description
Indicates how long the client should wait before making a new request.

500Internal Server Error

curl

curl --request GET \
     --url 'https://api.cms.optimizely.com/v1/manifest?includeReadOnly=boolean' \
     --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.cms.optimizely.com/v1/manifest?includeReadOnly=boolean", 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.cms.optimizely.com/v1/manifest?includeReadOnly=boolean")

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.cms.optimizely.com/v1/manifest?includeReadOnly=boolean"

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

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

print(response.text)

200

// OK
{
  "locales": [
    {
      "key": "",
      "displayName": "",
      "isEnabled": false,
      "routeSegment": "",
      "sortOrder": "",
      "accessRights": [
        {
          "name": "",
          "type": "user"
        }
      ],
      "created": "",
      "createdBy": "",
      "lastModified": "",
      "lastModifiedBy": "",
      "fallback": ""
    }
  ],
  "propertyGroups": [
    {
      "key": "",
      "displayName": "",
      "source": "",
      "sortOrder": "",
      "created": "",
      "createdBy": "",
      "lastModified": "",
      "lastModifiedBy": ""
    }
  ],
  "contentTypes": [
    {
      "key": "",
      "displayName": "",
      "description": "",
      "baseType": "_page",
      "isContract": false,
      "source": "",
      "sortOrder": "",
      "mayContainTypes": [
        ""
      ],
      "mediaFileExtensions": [
        ""
      ],
      "compositionBehaviors": [
        ""
      ],
      "composition": {
        "format": "",
        "allowedTypes": [
          ""
        ],
        "restrictedTypes": [
          ""
        ]
      },
      "contracts": [
        ""
      ],
      "created": "",
      "createdBy": "",
      "lastModified": "",
      "lastModifiedBy": "",
      "properties": "",
      "accessRights": [
        {
          "name": "",
          "type": "user"
        }
      ]
    }
  ],
  "displayTemplates": [
    {
      "key": "",
      "displayName": "",
      "nodeType": "",
      "baseType": "_page",
      "contentType": "",
      "isDefault": false,
      "created": "",
      "createdBy": "",
      "lastModified": "",
      "lastModifiedBy": "",
      "settings": ""
    }
  ],
  "lastModified": ""
}

401

// Unauthorized

403

// Forbidden

429

// Too Many Requests
{
  "type": "",
  "title": "",
  "status": "",
  "detail": "",
  "instance": "",
  "code": "",
  "errors": [
    {
      "detail": "",
      "field": "properties.header.displayName"
    }
  ]
}

500

// Internal Server Error