Resources

There is a WADL document available that describes the resources API.

You may also enjoy the interactive interface provided for this API by Swagger.

Try it out!

name path methods description
Authentication API
  • /content-management/authentication/verify
  • POST
Authentications to the content management system requires an extra header, X-Content-Management-Token.
Category API
  • /content-management/category/categories
  • /content-management/category/trees
  • GET
  • GET
Categories and their hierarchical tree is an easy way to design the web shop in a way that it is easy to navigate and find interesting articles. Methods of this API is used to retrieve the raw data of the categories and their trees.
Draft API
  • /content-management/draft/drafts
  • /content-management/draft/drafts/{draftId}
  • /content-management/draft/drafts/{draftId}/categories
  • /content-management/draft/drafts/{draftId}/publishments
  • /content-management/draft/drafts/{draftId}/categories/{categoryDraftId}
  • /content-management/draft/drafts/{draftId}/settings/{settingKey}
  • /content-management/draft/drafts/{draftId}/categories/{categoryDraftId}/periods/{periodId}
  • GET POST
  • DELETE GET PATCH
  • POST
  • POST
  • DELETE GET PATCH
  • DELETE PATCH
  • DELETE PATCH
A draft contains ongoing changes of the category tree. New categories can be added, deleted or just changed, directly or for a specific period in time. Drafts can either be disregarded and just deleted, or published to overwrite the current data. Drafts can be sent to other persons for review before actually publishing them, to make sure the quality of the content is good enough.
Experiments API
  • /content-management/experiment/experiments
  • /content-management/experiment/experiments/{experimentId}
  • GET POST
  • DELETE GET PATCH
Experiments can be added to enabled A/B testing on category design, functionality etc.
Media API
  • /content-management/media/latest
  • /content-management/media/search
  • /content-management/media/upload
  • GET
  • POST
  • POST
Media is various types of visuals (typically images and short clips) that can be uploaded and used through the content management system.
Period API
  • /content-management/period/periods
  • /content-management/period/periods/{periodId}
  • GET POST
  • DELETE GET PATCH
A period is a section in time from one moment to another. Periods can be used to alter the ways the site looks for those specific times. They are commonly used for holidays where you might want a different theme of the site, or different kinds of contents.
Store API
  • /content-management/store/settings
  • /content-management/store/settings/{settingKey}
  • GET
  • GET
In the scope of content management, stores are focused on the web store type. The REST methods related to this are working with the current store.

Data Types

type description
ApplicationError Represents an application error object that contains information about a specific error thrown by the system.
ApplicationErrors Defines a list of errors.
AuthenticationResponse The result of verifying the authentication token.
CategoryDraftCreateData Contains data that are used when drafting a category. Drafting a category can be one of the following:
  • Creating a new category in the tree
  • Editing contents or moving an existing category

When creating new categories, some fields are mandatory, such as:

  • categoryId
  • categoryName
  • categoryNameInternal
  • linkFriendlyName

CategoryDraftResponse Domain for a category draft response such as creation etc.
CategoryDraftUpdateData Contains data that are used when updating a drafted category. Fields that can be updated include various content related information, various flags (for example whether or not a category should be hidden) and location in the category tree.

Absent fields will not be updated.

CategoryHead Domain of a content category draft
CategoryHeadDraft Domain of a content category draft
CategoryPeriod Domain for a category period draft
CategoryPeriodDraft Domain for a category period draft
CategoryPeriodDraftData Domain of category period draft data. Used when creating and updating category period drafts
ContentTree Domain representing a tree node
Draft Domain for a draft
DraftCategory Domain of a draft category contained under a draft
DraftData Domain of draft data. Used when creating and updating drafts
DraftParent Domain of a draft parent contained under a draft
DraftResponse Domain for a draft response such as creation etc.
Experiment Domain of an experiment
ExperimentData Domain of experiment data. Used when creating and updating experiments
ExperimentResponse Domain for a experiment response such as creation etc.
ExperimentVariant Domain of an experiment variant
ExperimentVariantData
Language Defines the languages that can be used in ETM.

The values of languages are from the ISO 639-1 standard.

Media Domain of CMS media
MediaSearchRequest Controls how a search for media is performed, including information about pagination.
MediaUploadRequest Contains information about an image that is to be uploaded to the content management system.
MediaUploadResponse Provides information about the uploaded media.
Period Domain of a content management period
PeriodCategory Domain of a category contained under a period
PeriodCategoryDraft Domain of a category draft contained under a period
PeriodData Contains information necessary when creating or updating periods.
PeriodResponse Domain for a draft response such as creation etc.
Publishment Defines data that is used when publishing a draft to the production data.
StoreSetting Holds a single setting for a web store. A setting can be anything from external tokens (such as the Google Analytics token) to simple styling settings (such as font names or colors).
StoreSettingData Contains necessary information for updating or creating settings. Values not passed in indicate that they should not be affecting the live data when the changes are published.