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 SaaS Core is in beta. Apply on Join the waitlist for SaaS Core or contact your Customer Success Manager.

Packages are used for moving content and content definitions between environments. There are two different package formats:

PackageMedia typeDescription
Episerver Dataapplication/vnd.optimizely.cms.episerverdataTraditional import and export format used by Optimizely Content Management System (CMS). An Episerver Data file can contain content, definitions and assets in a single compressed file.
Manifestapplication/vnd.optimizely.cms.manifestA format composed of other definition resources into a single file.

The package formats have different use cases, but also some overlapping functionality. For example, both formats can contain content definitions, but Episerver Data can also include content and assets.

  • The Episerver Data package format is used for moving content and content definitions between environments, but also from other versions of Optimizely CMS.
  • The Manifest package format can also be used for moving content definitions between environments, but more importantly can be used to maintain the content definitions together with the client application's version-controlled source code. This 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 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 Package 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 chose where to import the content.

Import Episerver Data package.

Export Manifest package

Export a Manifest package by calling the Package 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 Package 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"
        }
    ]
}