Imports a manifest containing definitions from the application.

1 min

PUT

/api/episerver/v3.0/contentmanifest

Query Parameters

allowedUpgradesversionComponent
Description
Defines which types of semantic upgrades are allowed.
continueOnErrorboolean
Description
Defines whether import of the next manifest section should continue if the previous fails.
Default
true
forceboolean
Description
Defines whether the import should proceed even though there are warnings or changes that are not allowed.
Default
false

Header Parameters

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

Body Parameters

bodymanifestrequired
Description
The manifest to import.
- contentTypescontentType[]
  Description
  Defines content types to be imported.
  - 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?),\.]*
- propertyGroupspropertyGroup[]
  Description
  Defines property groups to be imported.
  - namestringrequired
    Description
    The name of the group.
    Max Length
    100
    Pattern
    [a-zA-Z0-9][\w]*
  - displayNamestring
    Description
    The display name of the group.
    Max Length
    100
  - sortOrderinteger<int32>
    Description
    The sort order.
    Format
    int32
    Minimum
    0
    Maximum
    10000
  - systemGroupboolean
    Description
    Indicates if the group is managed by the system or not.
- editorDefinitionseditorDefinition[]
  Description
  Defines editor definitions to be imported.
  - dataTypestringrequired
    Description
    The type for the editor definition
  - uiHintstring
    Description
    The UIHint for the editor definition
  - editorstring
    Description
    The editor for the editor definition

Responses

200Ok

importResult
Description
Defines the result of an import.
- hasErrorsboolean
  Description
  Returns true if any of the messages indicates an error.
- messagesimportLogMessage[]
  Description
  Gets or sets the messages describing the import result.
  - messagestring
    Description
    Gets the message.
  - severityimportLogMessageSeverity
    Description
    Represent the severity level of an import log message.

400Bad request

403Forbidden

curl

curl --request PUT \
     --url '/api/episerver/v3.0/contentmanifest?allowedUpgrades=object&continueOnError=true&force=boolean' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "contentTypes": [
     {
     "name": "",
     "baseType": "",
     "properties": [
     {
     "name": "",
     "dataType": "",
     "validation": [
     {
     "name": ""
     }
     ]
     }
     ]
     }
     ],
     "propertyGroups": [
     {
     "name": ""
     }
     ],
     "editorDefinitions": [
     {
     "dataType": ""
     }
     ]
     }'

javascript

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

var raw = JSON.stringify({
   "contentTypes": [
      {
         "name": "",
         "baseType": "",
         "properties": [
            {
               "name": "",
               "dataType": "",
               "validation": [
                  {
                     "name": ""
                  }
               ]
            }
         ]
      }
   ],
   "propertyGroups": [
      {
         "name": ""
      }
   ],
   "editorDefinitions": [
      {
         "dataType": ""
      }
   ]
});

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

fetch("/api/episerver/v3.0/contentmanifest?allowedUpgrades=object&continueOnError=true&force=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("/api/episerver/v3.0/contentmanifest?allowedUpgrades=object&continueOnError=true&force=boolean")

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({
   "contentTypes": [
      {
         "name": "",
         "baseType": "",
         "properties": [
            {
               "name": "",
               "dataType": "",
               "validation": [
                  {
                     "name": ""
                  }
               ]
            }
         ]
      }
   ],
   "propertyGroups": [
      {
         "name": ""
      }
   ],
   "editorDefinitions": [
      {
         "dataType": ""
      }
   ]
})

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

python

import requests
import json

url = "/api/episerver/v3.0/contentmanifest?allowedUpgrades=object&continueOnError=true&force=boolean"

payload = json.dumps({
   "contentTypes": [
      {
         "name": "",
         "baseType": "",
         "properties": [
            {
               "name": "",
               "dataType": "",
               "validation": [
                  {
                     "name": ""
                  }
               ]
            }
         ]
      }
   ],
   "propertyGroups": [
      {
         "name": ""
      }
   ],
   "editorDefinitions": [
      {
         "dataType": ""
      }
   ]
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

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

print(response.text)

200

// Ok
{
  "hasErrors": false,
  "messages": [
    {
      "message": "",
      "severity": ""
    }
  ]
}

400

// Bad request

403

// Forbidden