HomeDev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideGitHubNuGetDev CommunitySubmit a ticketLog In
GitHubNuGetDev CommunitySubmit a ticket

Export and import packages

Describes how to export and import content and content definitions.

πŸ‘

Beta

Optimizely CMS (SaaS) is in beta. Apply on Join the waitlist for CMS (SaaS) or contact your Customer Success Manager.

The following packages have different use cases but also some overlapping functionality. Each moves content and content definitions between environments and can contain content definitions, but Episerver Data can include content and assets.

  • Episerver Data – application/vnd.optimizely.cms.episerverdata – Optimizely Content Management System (CMS) uses the traditional import and export format. An Episerver Data file can contain content, definitions, and assets in a compressed file. The Episerver Data package format moves content and content definitions between environments and other versions of Optimizely CMS.
  • Manifest – application/vnd.optimizely.cms.manifest – A format composed of other definition resources into a single file. The Manifest package format can also move content definitions between environments. Still, more importantly, it maintains the content definitions and the client application's version-controlled source code, which ensures the necessary content definitions are available to run the client application.

Export Episerver Data package

You can export an Episerver Data package only from the user interface. Go to Settings > Export Data and select the content and content definitions to export.

Export Episerver Data package.

Import Episerver Data package

Import an Episerver Data package by calling the packages API.

POST https://example.com/_cms/v1/packages
Content-Type: application/vnd.optimizely.cms.episerverdata

<!-- .episerverdata file -->

You can also import Episerver Data packages from the user interface. Go to Settings > Import Data, select the package and choose where to import the content.

Import Episerver Data package.

Export Manifest package

Export a Manifest package by calling the packages API:

GET https://example.com/_cms/v1/packages
Accept: application/vnd.optimizely.cms.manifest
{
  "contentTypes": [
    {
      "key": "news",
      "baseType": "page",
      "displayName": "News"
    },
    {
      "key": "story",
      "baseType": "component",
      "displayName": "Story"
    }
  ],
  "propertyGroups": [
    {
      "key": "info",
      "displayName": "Information",
      "sortOrder": 10,
      "source": ""
    },
    {
      "key": "settings",
      "displayName": "Setting",
      "sortOrder": 20,
      "source": "system"
    }
  ]
}

Import Manifest package

Import a Manifest package by calling the packages API:

POST https://example.com/_cms/v1/packages
Content-Type: application/vnd.optimizely.cms.manifest

{
    "contentTypes": [
        {
            "key": "news",
            "baseType": "page",
            "displayName": "News"
        },
        {
            "key": "story",
            "baseType": "component",
            "displayName": "Story"
        }
    ],
    "propertyGroups": [
        {
            "key": "info",
            "displayName": "Information",
            "sortOrder": 10,
            "source": ""
        },
        {
            "key": "settings",
            "displayName": "Setting",
            "sortOrder": 20,
            "source": "system"
        }
    ]
}