Import manifest

1 min

POST

/_cms/v1/manifest

Import a CMS content manifest.

Header Parameters

cms-ignore-data-loss-warningsboolean
Description
Indicates if manifest resources should be updated even though the changes might result in data loss.
Default
false

Body Parameters

bodyManifestrequired
Description
The manifest that should be imported.
- 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<user | role | application>
      Description
      The type of the security entity that this identifier references. Will default to 'role' if not specified.
      Allowed
      userroleapplication
  - 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.
- 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 PropertyGroup.
    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 to when sorting PropertyGroup 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 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
- 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
    Description
    The optional base type this display template is valid for.
  - 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

Responses

200OK

ManifestImportResult
Description
The result of a manifest import operation.
- outcomesManifestImportMessage[]
  Description
  List of messages describing the outcome from the manifest import.
  - sectionstring
    Description
    The section where the message originated from.
  - messagestring
    Description
    The message describing an outcome or error.
  - resourcestring
    Description
    The identifier of the resource that was the reason for this message to be created.
- errorsManifestImportMessage[]
  Description
  List of error messages from the manifest import.
  - sectionstring
    Description
    The section where the message originated from.
  - messagestring
    Description
    The message describing an outcome or error.
  - resourcestring
    Description
    The identifier of the resource that was the reason for this message to be created.

202Accepted

400Bad Request

401Unauthorized

403Forbidden

409Conflict

500Internal Server Error

curl

curl --request POST \
     --url /_cms/v1/manifest \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "locales": [
     {
     "key": "",
     "displayName": "",
     "routeSegment": "",
     "accessRights": [
     {
     "name": ""
     }
     ]
     }
     ],
     "propertyGroups": [
     {
     "key": "",
     "displayName": ""
     }
     ],
     "contentTypes": [
     {
     "displayName": "",
     "accessRights": [
     {
     "name": ""
     }
     ]
     }
     ],
     "displayTemplates": [
     {
     "displayName": ""
     }
     ]
     }'

javascript

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

var raw = JSON.stringify({
   "locales": [
      {
         "key": "",
         "displayName": "",
         "routeSegment": "",
         "accessRights": [
            {
               "name": ""
            }
         ]
      }
   ],
   "propertyGroups": [
      {
         "key": "",
         "displayName": ""
      }
   ],
   "contentTypes": [
      {
         "displayName": "",
         "accessRights": [
            {
               "name": ""
            }
         ]
      }
   ],
   "displayTemplates": [
      {
         "displayName": ""
      }
   ]
});

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

fetch("/_cms/v1/manifest", 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/manifest")

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({
   "locales": [
      {
         "key": "",
         "displayName": "",
         "routeSegment": "",
         "accessRights": [
            {
               "name": ""
            }
         ]
      }
   ],
   "propertyGroups": [
      {
         "key": "",
         "displayName": ""
      }
   ],
   "contentTypes": [
      {
         "displayName": "",
         "accessRights": [
            {
               "name": ""
            }
         ]
      }
   ],
   "displayTemplates": [
      {
         "displayName": ""
      }
   ]
})

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

python

import requests
import json

url = "/_cms/v1/manifest"

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

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

print(response.text)

200

// OK
{
  "outcomes": [
    {
      "section": "",
      "message": "",
      "resource": ""
    }
  ],
  "errors": [
    {
      "section": "",
      "message": "",
      "resource": ""
    }
  ]
}

202

// Accepted

400

// Bad Request

401

// Unauthorized

403

// Forbidden

409

// Conflict

500

// Internal Server Error