--- title: Imports a manifest containing definitions from the application. slug: cms-12/api/imports-a-manifest-containing-definitions-from-the-application docTags: createdAt: 2026-08-28T13:16:06.833Z --- { "id": "tsq-OZUaqUu8t0kWFllW1", "type": "api-oas-v2", "data": { "method": "PUT", "url": "/api/episerver/v3.0/contentmanifest", "servers": [], "name": "Imports a manifest containing definitions from the application.", "description": "", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "application/problem+json" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "allowedUpgrades", "type": "object", "description": "Defines which types of semantic upgrades are allowed.", "customType": "versionComponent", "schema": [], "modelRef": "#/components/schemas/versionComponent" }, { "kind": "optional", "name": "continueOnError", "type": "boolean", "description": "Defines whether import of the next manifest section should continue if the previous fails.", "default": true }, { "kind": "optional", "name": "force", "type": "boolean", "description": "Defines whether the import should proceed even though there are warnings or changes that are not allowed.", "default": false } ], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "The manifest to import.", "customType": "manifest", "schema": [ { "name": "contentTypes", "kind": "optional", "type": "array", "description": "Defines content types to be imported.", "modelRef": "#/components/schemas/contentType", "customType": "contentType[]", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "The unique identifier of the content type.", "format": "uuid" }, { "name": "name", "kind": "required", "type": "string", "description": "The name of the content type.", "maxLength": 50, "pattern": "[a-zA-Z][\\w]*" }, { "name": "baseType", "kind": "required", "type": "string", "description": "The base type for this content type." }, { "name": "version", "kind": "optional", "type": "string", "nullable": true, "description": "The version of the content type.", "example": "2.1.0" }, { "name": "supportedMediaExtensions", "kind": "optional", "type": "string", "nullable": true, "description": "

A comma-separated list of supported media types for media content types.

", "example": "gif,bmp" }, { "name": "editSettings", "kind": "optional", "type": "object", "description": "Defines settings for content type that affects how it is displayed when edited.", "modelRef": "#/components/schemas/contentTypeEditSettings", "customType": "contentTypeEditSettings", "schema": [ { "name": "displayName", "kind": "optional", "type": "string", "nullable": true, "description": "The name that should be used when editing the content type.", "maxLength": 50 }, { "name": "description", "kind": "optional", "type": "string", "nullable": true, "description": "The description that should be used when editing the content type.", "maxLength": 255 }, { "name": "available", "kind": "optional", "type": "boolean", "description": "Determines if the content type is available when editing." }, { "name": "sortOrder", "kind": "optional", "type": "integer", "description": "The field order used for ordering the content types when editing.", "format": "int32", "minimum": 0, "maximum": 2147483647 } ] }, { "name": "properties", "kind": "optional", "type": "array", "readOnly": true, "nullable": true, "description": "A list with the properties of this content type.", "modelRef": "#/components/schemas/contentTypeProperty", "customType": "contentTypeProperty[]", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "The name of the property.", "maxLength": 100, "pattern": "[a-zA-Z][\\w]*" }, { "name": "dataType", "kind": "required", "type": "string", "description": "The main data type name.", "maxLength": 255, "pattern": "[a-zA-Z][(\\w\\s*\\w?),\\.]*" }, { "name": "branchSpecific", "kind": "optional", "type": "boolean", "description": "Indicates if the property has specific values for each content branch or if values are shared between all branches." }, { "name": "required", "kind": "optional", "type": "boolean", "description": "Indicates if the property is required." }, { "name": "editSettings", "kind": "optional", "type": "object", "description": "Defines settings for content type properties that affects how the property is displayed when edited.", "modelRef": "#/components/schemas/propertyEditSettings", "customType": "propertyEditSettings", "schema": [ { "name": "visibility", "kind": "optional", "type": "string", "description": "Specifies the visibility status of a property in edit view.", "modelRef": "#/components/schemas/visibilityStatus", "customType": "visibilityStatus", "schema": [] }, { "name": "displayName", "kind": "optional", "type": "string", "nullable": true, "description": "The name that should be used when editing the property.", "maxLength": 255 }, { "name": "groupName", "kind": "optional", "type": "string", "nullable": true, "description": "Name of the property group that this property should be displayed in.", "maxLength": 100, "pattern": "[a-zA-Z][\\w]*" }, { "name": "sortOrder", "kind": "optional", "type": "integer", "description": "The field order used for ordering the properties when editing.", "format": "int32", "minimum": 0, "maximum": 2147483647 }, { "name": "helpText", "kind": "optional", "type": "string", "nullable": true, "description": "The text that should be used as help when editing the property.", "maxLength": 2000 }, { "name": "hint", "kind": "optional", "type": "string", "nullable": true, "description": "A hint that will be used when resolving which editor that should be used when editing this property.", "maxLength": 255 } ] }, { "name": "imageDescriptor", "kind": "optional", "type": "object", "description": "Defines a thumbnail image format.", "modelRef": "#/components/schemas/propertyImageDescriptor", "customType": "propertyImageDescriptor", "schema": [ { "name": "height", "kind": "optional", "type": "integer", "description": "Thumbnail image height", "format": "int32", "minimum": 0, "maximum": 2147483647 }, { "name": "width", "kind": "optional", "type": "integer", "description": "Thumbnail image width", "format": "int32", "minimum": 0, "maximum": 2147483647 }, { "name": "pregenerated", "kind": "optional", "type": "boolean", "description": "If the thumbnail should be pregenerated when a new image is uploaded rather than when first requested" } ] }, { "name": "validation", "kind": "optional", "type": "array", "readOnly": true, "nullable": true, "description": "The validation settings of the property.", "modelRef": "#/components/schemas/propertyValidationSettings", "customType": "propertyValidationSettings[]", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "The name of the validation type that should be performed." }, { "name": "severity", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/validationErrorSeverity", "customType": "validationErrorSeverity", "schema": [] }, { "name": "errorMessage", "kind": "optional", "type": "string", "nullable": true, "description": "The error message to use for any validation error." } ] }, { "name": "itemType", "kind": "optional", "type": "string", "nullable": true, "description": "The item type for cases when the 'dataType' is 'PropertyBlock'.", "maxLength": 255, "pattern": "[a-zA-Z][(\\w\\s*\\w?),\\.]*" } ] } ] }, { "name": "propertyGroups", "kind": "optional", "type": "array", "description": "Defines property groups to be imported.", "modelRef": "#/components/schemas/propertyGroup", "customType": "propertyGroup[]", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "The name of the group.", "maxLength": 100, "pattern": "[a-zA-Z0-9][\\w]*" }, { "name": "displayName", "kind": "optional", "type": "string", "nullable": true, "description": "The display name of the group.", "maxLength": 100 }, { "name": "sortOrder", "kind": "optional", "type": "integer", "description": "The sort order.", "format": "int32", "minimum": 0, "maximum": 10000 }, { "name": "systemGroup", "kind": "optional", "type": "boolean", "readOnly": true, "nullable": true, "description": "Indicates if the group is managed by the system or not." } ] }, { "name": "editorDefinitions", "kind": "optional", "type": "array", "description": "Defines editor definitions to be imported.", "modelRef": "#/components/schemas/editorDefinition", "customType": "editorDefinition[]", "schema": [ { "name": "dataType", "kind": "required", "type": "string", "description": "The type for the editor definition" }, { "name": "uiHint", "kind": "optional", "type": "string", "nullable": true, "description": "The UIHint for the editor definition" }, { "name": "editor", "kind": "optional", "type": "string", "nullable": true, "description": "The editor for the editor definition" } ] } ], "modelRef": "#/components/schemas/manifest", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Ok", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Defines the result of an import.", "customType": "importResult", "schema": [ { "name": "hasErrors", "kind": "optional", "type": "boolean", "readOnly": true, "description": "Returns true if any of the messages indicates an error." }, { "name": "messages", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the messages describing the import result.", "modelRef": "#/components/schemas/importLogMessage", "customType": "importLogMessage[]", "schema": [ { "name": "message", "kind": "optional", "type": "string", "nullable": true, "description": "Gets the message." }, { "name": "severity", "kind": "optional", "type": "string", "description": "Represent the severity level of an import log message.", "modelRef": "#/components/schemas/importLogMessageSeverity", "customType": "importLogMessageSeverity", "schema": [] } ] } ], "modelRef": "#/components/schemas/importResult", "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad request", "jsonExample": "", "isExpanded": true }, { "statusCode": "403", "description": "Forbidden", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "i4V7QX8L_xZ1qTBx8iaX1", "language": "curl", "label": "cURL", "code": "curl --request PUT \\\n --url '/api/episerver/v3.0/contentmanifest?allowedUpgrades=object&continueOnError=true&force=boolean' \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"contentTypes\": [\n {\n \"name\": \"\",\n \"baseType\": \"\",\n \"properties\": [\n {\n \"name\": \"\",\n \"dataType\": \"\",\n \"validation\": [\n {\n \"name\": \"\"\n }\n ]\n }\n ]\n }\n ],\n \"propertyGroups\": [\n {\n \"name\": \"\"\n }\n ],\n \"editorDefinitions\": [\n {\n \"dataType\": \"\"\n }\n ]\n }'" }, { "id": "JxProyzx3kb48J_OHcMWW", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"contentTypes\": [\n {\n \"name\": \"\",\n \"baseType\": \"\",\n \"properties\": [\n {\n \"name\": \"\",\n \"dataType\": \"\",\n \"validation\": [\n {\n \"name\": \"\"\n }\n ]\n }\n ]\n }\n ],\n \"propertyGroups\": [\n {\n \"name\": \"\"\n }\n ],\n \"editorDefinitions\": [\n {\n \"dataType\": \"\"\n }\n ]\n});\n\nvar requestOptions = {\n method: 'PUT',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"/api/episerver/v3.0/contentmanifest?allowedUpgrades=object&continueOnError=true&force=boolean\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "w2L-FOa-1HYqxT7gZMYjz", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"/api/episerver/v3.0/contentmanifest?allowedUpgrades=object&continueOnError=true&force=boolean\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Put.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"contentTypes\": [\n {\n \"name\": \"\",\n \"baseType\": \"\",\n \"properties\": [\n {\n \"name\": \"\",\n \"dataType\": \"\",\n \"validation\": [\n {\n \"name\": \"\"\n }\n ]\n }\n ]\n }\n ],\n \"propertyGroups\": [\n {\n \"name\": \"\"\n }\n ],\n \"editorDefinitions\": [\n {\n \"dataType\": \"\"\n }\n ]\n})\n\nresponse = http.request(request)\nputs response.read_body\n" }, { "id": "97V0oWVuqgZNmcBm9EhaP", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"/api/episerver/v3.0/contentmanifest?allowedUpgrades=object&continueOnError=true&force=boolean\"\n\npayload = json.dumps({\n \"contentTypes\": [\n {\n \"name\": \"\",\n \"baseType\": \"\",\n \"properties\": [\n {\n \"name\": \"\",\n \"dataType\": \"\",\n \"validation\": [\n {\n \"name\": \"\"\n }\n ]\n }\n ]\n }\n ],\n \"propertyGroups\": [\n {\n \"name\": \"\"\n }\n ],\n \"editorDefinitions\": [\n {\n \"dataType\": \"\"\n }\n ]\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"PUT\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "i4V7QX8L_xZ1qTBx8iaX1" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// Ok\n{\n \"hasErrors\": false,\n \"messages\": [\n {\n \"message\": \"\",\n \"severity\": \"\"\n }\n ]\n}" }, { "id": "response-1-400", "language": "400", "code": "// Bad request\n" }, { "id": "response-2-403", "language": "403", "code": "// Forbidden\n" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }