Related Documents
●
●
●
●
●
●
●
●
●
●
●
●
●
●
Reference - CMS REST API 1.0.0
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
Document Properties
Kbid
2956B7
Last Modified
18-Jan-2023
Added to KB
20-Jul-2020
Public Access
Everyone
Status
Online
Doc Type
References
Product
  • ICM 7.10
  • ICM 11
Home ⋮ Knowledge Base
Reference - CMS REST API 1.0.0
https://support.intershop.com/kb/2956B7
Share this document


Product Version

7.10

Product To Version


Status

New Labels

This API specification is available for download as an Open API 3.0 YAML file: 

References

The following page lists available REST APIs for ICM 7.10 and their version dependencies:

API Specification

Introduction
OpenAPI Version: 3.0.1
CMS Version: 1.0.0

Content Management System API

The Intershop Content Management System REST API contains resources that reflect the main aspects of the content management system. These include pagelets, pages, includes and more.
You can use the API to retrieve information about individual CMS objects and their composition.

Adaptables

Some of the RestResourceObjects in this API refer to other objects. A pagelet for example contains slots, which need to be returned or referred to.

Since the Intershop Content Management System REST API has a hierarchical structure which can be manipulated by depth regulation,
these elements can either be links to specific resources or the complete resolved resource as is.
This will be expressed through specific adaptables, in which for example a SlotAdaptable can be a SlotRO (for the element) or a SlotLinkRO (for the link to the resource).

class PageletRO{
  Map<String, SlotAdaptable> slots // This can either be SlotROs or SlotLinkROs
}

// JSON with SlotLinkROs:
{
  slots:{
    foo: { uri : '.../s1'},
    bar: { uri : '.../s1'}
  }
}

// JSON with SlotROs:
{
  slots:{
    foo: {
      pagelets:[ ... ],
      ...
    },
    bar: {
      pagelets:[ ... ],
      ...
    }
  }
}

Depth Regulation

All item resources in this API, like includes, pages, pagelets and viewcontexts are described in hierarchical render structures.
As these can grow very large, the response can be limited with the optional depth query parameter. As soon as the requested depth is reached, a deeper element in the hierarchy will not be resolved anymore - instead a link to this resource will be provided.

Paging

All list resources in this API are pageable, so you can provide an offset and an amount as query parameters to select the range of results. You can also provide a pageable-ID (which will be returned from these resources) to your next call, to use the cached data from the server.

Personalized Content

All operations in this API can serve personalized data.
If you request any data without further authentication, you will be treated as anonymous.

To get personalized data, you must provide a basic authentication header, together with a personalization group ID (pgid).
This ID must be applied as a matrix parameter at the /cms -path segment.

Anonymous Request for page my.page:

curl -X GET -i /cms/pages/my.page

Personalized Request for page my.page:

curl -X GET -H 'Authorization: Basic <auth>' -i /cms;pgid=<pgid>/pages/my.page

As a result of a personalized request, all links in the response will contain the pgid to simplify navigation.

Notes:

  • Use the /personalization endpoint to retrieve the pgid of a specific user.
  • If you provide a basic authentication header without a pgid, you will get a bad request.
General API

This section covers retrieving a list of available CMS sub-resources.

{loc}/cms{pgid}
GET: Returns a list of CMS sub resources

Description

This operation returns a list of CMS sub resources.
This includes view contexts, includes, pagelets, pages and pagetree.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.pmc.capi.resource.CmsParentResource.getCMSResources()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathlocstringen_USThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the priority is as follows (from high to low): Locale ID parameter, user's default locale, site's default locale. The available locales depend on your individual Intershop Commerce Management installation. Use IANA language definitions for languages and regions and combine them using a underscore, e. g. en_US.
in pathpgidstringFUOGrzQ_VjORpGaN8DRGmLLE0000The personalization group identifier, submitted as matrix parameter ;pgid=<PGID>. Required if you want to work with customer-specific content.

Response

200 - OK

ResourceCollectionROLinkRO application/json
Include API

This section covers retrieving includes.

An include can be conceived as a specific storefront "entry point" for individual content components. There are specific include types which specify the structure and parameters required for rendering. Includes can have multiple content components assigned. There should be at least one component assigned.

{loc}/cms{pgid}/includes
GET: Returns a list of all includes

Description

This operation returns a list of all includes. Includes are PageletEntryPoint objects with page-flag set to false.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.pmc.capi.resource.pep.IncludeListResource.getIncludes(java.lang.Integer,java.lang.Integer,java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathlocstringen_USThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the priority is as follows (from high to low): Locale ID parameter, user's default locale, site's default locale. The available locales depend on your individual Intershop Commerce Management installation. Use IANA language definitions for languages and regions and combine them using a underscore, e. g. en_US.
in pathpgidstringFUOGrzQ_VjORpGaN8DRGmLLE0000The personalization group identifier, submitted as matrix parameter ;pgid=<PGID>. Required if you want to work with customer-specific content.
in queryoffsetinteger int640The pageable offset | Min Value: 0
in queryamountinteger int6450The pageable amount | Min Value: 1
in querypageablestringThe ID of the respective pageable

Response

200 - OK

ResourceCollectionROLinkRO application/json
ResourceCollectionROLinkRO -> elements -> [..] -> itemId can be used as {includesKey} in subsequent requests. Links to item of type PageletEntryPointRO.

400 - Bad Request

{loc}/cms{pgid}/includes/{includesKey}
GET: Returns a specific include

Description

This operation returns a specific include. The include must be published at the time of the request.

Java Method

public com.intershop.sellside.rest.pmc.capi.resourceobject.PageletEntryPointRO com.intershop.sellside.rest.pmc.capi.resource.pep.IncludeResource.getInclude(java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathlocstringen_USThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the priority is as follows (from high to low): Locale ID parameter, user's default locale, site's default locale. The available locales depend on your individual Intershop Commerce Management installation. Use IANA language definitions for languages and regions and combine them using a underscore, e. g. en_US.
in pathpgidstringFUOGrzQ_VjORpGaN8DRGmLLE0000The personalization group identifier, submitted as matrix parameter ;pgid=<PGID>. Required if you want to work with customer-specific content.
in pathincludesKeystringExampleKeyRequired | The key or UUID to resolve a single item
in querydepthinteger int642147483647The depth limit of how far a given include composition should be resolved.
Further on from this depth links are used instead of resource objects. | Min Value: 0

Response

200 - OK

PageletEntryPointRO application/json

400 - Bad Request

404 - Not Found

Page API

This section covers retrieving pages and page trees.

A page can be conceived as an "entry point" to the storefront used to collect page variants. There are specific page types (defined by a pagelet) which specify parameters required for rendering the web page. Pages can have multiple page variants assigned. When a page is rendered, one of its page variants is chosen based on various conditions.

{loc}/cms{pgid}/pages
GET: Returns a list of all pages

Description

This operation returns a list of all pages. Pages are PageletEntryPoint objects with page-flag set to true.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.pmc.capi.resource.pep.PageListResource.getPages(java.lang.Integer,java.lang.Integer,java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathlocstringen_USThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the priority is as follows (from high to low): Locale ID parameter, user's default locale, site's default locale. The available locales depend on your individual Intershop Commerce Management installation. Use IANA language definitions for languages and regions and combine them using a underscore, e. g. en_US.
in pathpgidstringFUOGrzQ_VjORpGaN8DRGmLLE0000The personalization group identifier, submitted as matrix parameter ;pgid=<PGID>. Required if you want to work with customer-specific content.
in queryoffsetinteger int640The pageable offset | Min Value: 0
in queryamountinteger int6450The pageable amount | Min Value: 1
in querypageablestringThe ID of the respective pageable

Response

200 - OK

ResourceCollectionROLinkRO application/json
ResourceCollectionROLinkRO -> elements -> [..] -> itemId can be used as {pagesKey} in subsequent requests. Links to item of type PageletEntryPointRO.

400 - Bad Request

{loc}/cms{pgid}/pages/{pagesKey}
GET: Returns a specific page

Description

This operation returns a specific page. The page must be published at the time of the request.

Java Method

public com.intershop.sellside.rest.pmc.capi.resourceobject.PageletEntryPointRO com.intershop.sellside.rest.pmc.capi.resource.pep.PageResource.getPage(java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathlocstringen_USThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the priority is as follows (from high to low): Locale ID parameter, user's default locale, site's default locale. The available locales depend on your individual Intershop Commerce Management installation. Use IANA language definitions for languages and regions and combine them using a underscore, e. g. en_US.
in pathpgidstringFUOGrzQ_VjORpGaN8DRGmLLE0000The personalization group identifier, submitted as matrix parameter ;pgid=<PGID>. Required if you want to work with customer-specific content.
in pathpagesKeystringExampleKeyRequired | The key or UUID to resolve a single item
in querydepthinteger int642147483647The depth limit of how far a given page composition should be resolved.
Further on from this depth links are used instead of resource objects. | Min Value: 0

Response

200 - OK

PageletEntryPointRO application/json

400 - Bad Request

404 - Not Found

{loc}/cms{pgid}/pagetree
GET: Returns all pages with their tree hierarchy

Description

This operation returns a list of all pages that are included in the domain.
Each element can have a hierarchy of subpages.
The recursion depth can be limited by providing a depth value.

Java Method

public com.intershop.sellside.rest.pmc.capi.resourceobject.PageTreeRO com.intershop.sellside.rest.pmc.capi.resource.pep.PageTreeResource.getPageTree(java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathlocstringen_USThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the priority is as follows (from high to low): Locale ID parameter, user's default locale, site's default locale. The available locales depend on your individual Intershop Commerce Management installation. Use IANA language definitions for languages and regions and combine them using a underscore, e. g. en_US.
in pathpgidstringFUOGrzQ_VjORpGaN8DRGmLLE0000The personalization group identifier, submitted as matrix parameter ;pgid=<PGID>. Required if you want to work with customer-specific content.
in querydepthinteger int642147483647The limit of how far a given page tree should be resolved.
Further on from this depth, links are used instead of resource objects. | Min Value: 0

Response

200 - OK

PageTreeRO application/json

400 - Bad Request

{loc}/cms{pgid}/pagetree/{pagesKey}
GET: Returns a specific page hierarchy

Description

This operation returns a page found in the domain with the given identifier.
It can contain a hierarchy of subpages.
The recursion depth can be limited by providing a depth value.

Java Method

public com.intershop.sellside.rest.pmc.capi.resourceobject.PageTreeRO com.intershop.sellside.rest.pmc.capi.resource.pep.PageTreeResource.getPageTree(java.lang.String,java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathlocstringen_USThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the priority is as follows (from high to low): Locale ID parameter, user's default locale, site's default locale. The available locales depend on your individual Intershop Commerce Management installation. Use IANA language definitions for languages and regions and combine them using a underscore, e. g. en_US.
in pathpgidstringFUOGrzQ_VjORpGaN8DRGmLLE0000The personalization group identifier, submitted as matrix parameter ;pgid=<PGID>. Required if you want to work with customer-specific content.
in pathpagesKeystringpage.contentRequired | The unique identifier of the requested page or a path of page identifier
in querydepthinteger int642147483647The limit of how far a given page tree should be resolved.
Further on from this depth, links are used instead of resource objects. | Min Value: 0

Response

200 - OK

PageTreeRO application/json

400 - Bad Request

404 - Not Found - No page has been found for the given page Id.

Pagelet API

This section covers retrieving pagelets and pagelet slots.

Pagelets are development artifacts that constitute the meta model for pages, page variants, content components, page templates, component templates, includes and view contexts. They are managed via Intershop Commerce Management to compose storefronts (or other front ends).

{loc}/cms{pgid}/pagelets
GET: Returns a list of all published pagelets of the domain

Description

This operation returns a list of all published pagelets of the domain. Pagelets which are shared to this domain will be shown as well.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.pmc.capi.resource.PageletListResource.getPagelets(java.lang.Integer,java.lang.Integer,java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathlocstringen_USThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the priority is as follows (from high to low): Locale ID parameter, user's default locale, site's default locale. The available locales depend on your individual Intershop Commerce Management installation. Use IANA language definitions for languages and regions and combine them using a underscore, e. g. en_US.
in pathpgidstringFUOGrzQ_VjORpGaN8DRGmLLE0000The personalization group identifier, submitted as matrix parameter ;pgid=<PGID>. Required if you want to work with customer-specific content.
in queryoffsetinteger int640The pageable offset | Min Value: 0
in queryamountinteger int6450The pageable amount | Min Value: 1
in querypageablestringThe ID of the respective pageable

Response

200 - OK

ResourceCollectionROPageletLinkRO application/json

400 - Bad Request

{loc}/cms{pgid}/pagelets/{pageletsKey}
GET: Returns a specific pagelet of the domain

Description

This operation returns a specific pagelet of the domain. The pagelet must be published at the time of the request.

Java Method

public com.intershop.sellside.rest.pmc.capi.resourceobject.PageletRO com.intershop.sellside.rest.pmc.capi.resource.PageletResource.getPagelet(java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathlocstringen_USThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the priority is as follows (from high to low): Locale ID parameter, user's default locale, site's default locale. The available locales depend on your individual Intershop Commerce Management installation. Use IANA language definitions for languages and regions and combine them using a underscore, e. g. en_US.
in pathpgidstringFUOGrzQ_VjORpGaN8DRGmLLE0000The personalization group identifier, submitted as matrix parameter ;pgid=<PGID>. Required if you want to work with customer-specific content.
in pathpageletsKeystringExampleKeyRequired | The key or UUID to resolve a single item
in querydepthinteger int642147483647The depth of how far the slot/pagelet relations should be resolved.
Further on from this depth links are used instead of resource objects. | Min Value: 0

Response

200 - OK

PageletRO application/json

400 - Bad Request

404 - Not Found

{loc}/cms{pgid}/pagelets/{pageletsKey}/{slotsKey}
GET: Returns a specific slot of a pagelet

Description

This operation returns a specific slot of a pagelet.
The pagelet must be published at the time of the request and the slot must exist.

Java Method

public com.intershop.sellside.rest.pmc.capi.resourceobject.slot.SlotRO com.intershop.sellside.rest.pmc.capi.resource.SlotResource.getSlot(java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathlocstringen_USThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the priority is as follows (from high to low): Locale ID parameter, user's default locale, site's default locale. The available locales depend on your individual Intershop Commerce Management installation. Use IANA language definitions for languages and regions and combine them using a underscore, e. g. en_US.
in pathpgidstringFUOGrzQ_VjORpGaN8DRGmLLE0000The personalization group identifier, submitted as matrix parameter ;pgid=<PGID>. Required if you want to work with customer-specific content.
in pathpageletsKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathslotsKeystringExampleKeyRequired | The key or UUID to resolve a single item
in querydepthinteger int642147483647The depth of how far the slot/pagelet relations should be resolved.
Further on from this depth links are used instead of resource objects. | Min Value: 0

Response

200 - OK

SlotRO application/json

400 - Bad Request

404 - Not Found

View Context API

This section covers retrieving view contexts and pages for view contexts.

View contexts relate business objects like products or categories with pages or includes for a given context like category browsing or checkout. That is, they represent an environment where given objects are to be displayed in a certain way.

{loc}/cms{pgid}/viewcontexts
GET: Returns all view contexts of the domain

Description

This operation returns all view contexts of the domain.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.pmc.capi.resource.ViewContextResource.getViewContexts(java.lang.Integer,java.lang.Integer,java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathlocstringen_USThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the priority is as follows (from high to low): Locale ID parameter, user's default locale, site's default locale. The available locales depend on your individual Intershop Commerce Management installation. Use IANA language definitions for languages and regions and combine them using a underscore, e. g. en_US.
in pathpgidstringFUOGrzQ_VjORpGaN8DRGmLLE0000The personalization group identifier, submitted as matrix parameter ;pgid=<PGID>. Required if you want to work with customer-specific content.
in queryoffsetinteger int640The pageable offset | Min Value: 0
in queryamountinteger int6450The pageable amount | Min Value: 1
in querypageablestringThe ID of the respective pageable

Response

200 - OK

ResourceCollectionROLinkRO application/json
ResourceCollectionROLinkRO -> elements -> [..] -> itemId can be used as {viewContextID} in subsequent requests. Links to item of type ViewContextRO.

400 - Bad Request

{loc}/cms{pgid}/viewcontexts/{viewContextID}
GET: Returns a specific view context of the domain

Description

This operation returns a specific view context of the domain. By calling a specific view context, a field called callParameters is returned in the response.
This is a list of objects that contains name, description and information on whether this specific parameter is optional or not.

Java Method

public com.intershop.sellside.rest.pmc.capi.resourceobject.viewcontext.ViewContextRO com.intershop.sellside.rest.pmc.capi.resource.ViewContextResource.getViewContext(java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathlocstringen_USThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the priority is as follows (from high to low): Locale ID parameter, user's default locale, site's default locale. The available locales depend on your individual Intershop Commerce Management installation. Use IANA language definitions for languages and regions and combine them using a underscore, e. g. en_US.
in pathpgidstringFUOGrzQ_VjORpGaN8DRGmLLE0000The personalization group identifier, submitted as matrix parameter ;pgid=<PGID>. Required if you want to work with customer-specific content.
in pathviewContextIDstringvc_productListRequired | The view context Id. Can be qualified with the resource-set Id.

Response

200 - OK

ViewContextRO application/json

400 - Bad Request

404 - Not Found

{loc}/cms{pgid}/viewcontexts/{viewContextID}/entrypoint
GET: Resolves a page for a view context

Description

This operation resolves a page for a view context. Depending on the type of view context query-parameters have to be specified.
To resolve this call, you need all required call parameters.

Example: How to get a view context for the catalog Cameras-Camcorder and
the category Cameras-Camcorders@inSPIRED-inTRONICS-Cameras-Camcorders

Step 1: Find out which parameters are required to resolve the view context:

curl /cms/viewcontexts/viewcontext.page.category.pagelet2-ViewContext
---
  Response:
    {
      ...
      callParameter: [
        { name: "CatalogBO", optional: false },
        { name: "CategoryBO", optional: false },
        ...
      ]
    }

Step 2: Call this resource with at least the required parameters to receive the pagelet entry point for this view context.

curl /cms/viewcontexts/viewcontext.page.category.pagelet2-ViewContext/entrypoint?CatalogBO=Cameras-Camcorders&CategoryBO=Cameras-Camcorders@inSPIRED-inTRONICS-Cameras-Camcorders
---
  Response:
    see PageletEntryPointRO

Java Method

public com.intershop.sellside.rest.pmc.capi.resourceobject.PageletEntryPointRO com.intershop.sellside.rest.pmc.capi.resource.ViewContextResource.resolvePageletEntryPoint(javax.ws.rs.core.UriInfo,java.lang.String,java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathlocstringen_USThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the priority is as follows (from high to low): Locale ID parameter, user's default locale, site's default locale. The available locales depend on your individual Intershop Commerce Management installation. Use IANA language definitions for languages and regions and combine them using a underscore, e. g. en_US.
in pathpgidstringFUOGrzQ_VjORpGaN8DRGmLLE0000The personalization group identifier, submitted as matrix parameter ;pgid=<PGID>. Required if you want to work with customer-specific content.
in pathviewContextIDstringvc_productListRequired | The view context Id. Can be qualified with the resource-set Id.
in querydepthinteger int642147483647The depth of how far the slot/pagelet relations should be resolved.
Further on from this depth links are used instead of resource objects. | Min Value: 0

Response

200 - OK

PageletEntryPointRO application/json

400 - Bad Request

404 - Not Found

Request and Response Object Schemata
PageTreeRO application/json{
  • "name":
    string
    The name of an element
  • "type":
    string
    Readonly | The type of the element. This is normally a constant that can be used to differentiate elements by their type.
  • "attributes":
    array
    An array of ResourceAttribute objects. The list of attributes
    [
    ResourceAttribute: An attribute
    {
    • "name":
      string
      The attribute's name
    • "type":
      string
      This is a constant: ResourceAttribute | Example: ResourceAttribute
    • "value":
      object
      The attribute's value.
    }
    ]
  • "parent":
    object
    A PageTreeLinkRO object.
    {
    • "name":
      string
      The name of an element
    • "type":
      string
      Readonly | The type of the element. This is normally a constant that can be used to differentiate elements by their type.
    • "attributes":
      array
      An array of ResourceAttribute objects. The list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "uri":
      string
    • "relation":
      string
      Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
    • "title":
      string
    • "description":
      string
    • "itemId":
      string
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
  • "path":
    array
    An array of PageTreeLinkRO objects.
    [
    PageTreeLinkRO
    {
    • "name":
      string
      The name of an element
    • "type":
      string
      Readonly | The type of the element. This is normally a constant that can be used to differentiate elements by their type.
    • "attributes":
      array
      An array of ResourceAttribute objects. The list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "uri":
      string
    • "relation":
      string
      Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
    • "title":
      string
    • "description":
      string
    • "itemId":
      string
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
    ]
  • "page":
    object
    A PageletEntryPointLinkRO object.
    {
    • "name":
      string
      The name of an element
    • "type":
      string
      Readonly | The type of the element. This is normally a constant that can be used to differentiate elements by their type.
    • "attributes":
      array
      An array of ResourceAttribute objects. The list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "uri":
      string
    • "relation":
      string
      Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
    • "title":
      string
    • "description":
      string
    • "itemId":
      string
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
  • "link":
    object
    A PageTreeLinkRO object.
    {
    • "name":
      string
      The name of an element
    • "type":
      string
      Readonly | The type of the element. This is normally a constant that can be used to differentiate elements by their type.
    • "attributes":
      array
      An array of ResourceAttribute objects. The list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "uri":
      string
    • "relation":
      string
      Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
    • "title":
      string
    • "description":
      string
    • "itemId":
      string
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
  • "elements":
    array
    An array of PageTreeAdaptable objects. The list of elements
    [
    PageTreeAdaptable
    {}
    ]
  • "attribute":
    object
    A ResourceAttribute object. An attribute
    {
    • "name":
      string
      The attribute's name
    • "type":
      string
      This is a constant: ResourceAttribute | Example: ResourceAttribute
    • "value":
      object
      The attribute's value.
    }
}
PageletEntryPointRO application/json{
  • "name":
    string
    The name of an element
  • "type":
    string
    Readonly | The type of the element. This is normally a constant that can be used to differentiate elements by their type.
  • "definitionQualifiedName":
    string
    Required | The definition qualified name of the returned element
  • "link":
    object
    A LinkRO object. A Link pointing to a resource
    {
    • "name":
      string
      The name of the returned element
    • "type":
      string
      Readonly | This is a constant: Link | Example: Link
    • "attributes":
      array
      An array of ResourceAttribute objects. The list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "uri":
      string
      The URI
    • "relation":
      string
      The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
    • "title":
      string
      The title of the link
    • "description":
      string
      The description of the link
    • "itemId":
      string
      The ID of the linked item
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
  • "pagelets":
    array
    An array of PageletAdaptable objects. The collection of pagelets refered by the requested PageletEntryPoint
    [
    PageletAdaptable: The collection of pagelets refered by the requested PageletEntryPoint
    {}
    ]
  • "displayName":
    string
    The (localized) display name of the returned element
  • "id":
    string
  • "domain":
    string
  • "resourceSetID":
    string
  • "configurationParameters":
    object
    The map of ConfigurationParameterROs with their names as keys
  • "customAttributes":
    object
    The map of custom attributes with their names as keys
  • "attribute":
    object
    A ResourceAttribute object. An attribute
    {
    • "name":
      string
      The attribute's name
    • "type":
      string
      This is a constant: ResourceAttribute | Example: ResourceAttribute
    • "value":
      object
      The attribute's value.
    }
}
PageletRO application/json{
  • "name":
    string
    The name of an element
  • "type":
    string
    Readonly | The type of the element. This is normally a constant that can be used to differentiate elements by their type.
  • "definitionQualifiedName":
    string
    Required | The definition qualified name of the returned element
  • "link":
    object
    A LinkRO object. A Link pointing to a resource
    {
    • "name":
      string
      The name of the returned element
    • "type":
      string
      Readonly | This is a constant: Link | Example: Link
    • "attributes":
      array
      An array of ResourceAttribute objects. The list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "uri":
      string
      The URI
    • "relation":
      string
      The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
    • "title":
      string
      The title of the link
    • "description":
      string
      The description of the link
    • "itemId":
      string
      The ID of the linked item
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
  • "displayName":
    string
  • "slots":
    object
    The map of SlotROs (or links to them) defined by the pagelet, with their names as keys
  • "id":
    string
  • "domain":
    string
  • "configurationParameters":
    object
    The map of ConfigurationParameterROs with their names as keys
  • "customAttributes":
    object
    The map of custom attributes with their names as keys
  • "attribute":
    object
    A ResourceAttribute object. An attribute
    {
    • "name":
      string
      The attribute's name
    • "type":
      string
      This is a constant: ResourceAttribute | Example: ResourceAttribute
    • "value":
      object
      The attribute's value.
    }
}
ResourceCollectionROLinkRO application/json{
  • "pageable":
    string
    The pageable ID.
  • "total":
    integer
    The pageable amount total | Format: int32
  • "offset":
    integer
    The pageable offset | Format: int32
  • "amount":
    integer
    The pageable amount | Format: int32
  • "elements":
    array
    An array of LinkRO objects. The list of elements
    [
    LinkRO: A Link pointing to a resource
    {
    • "name":
      string
      The name of the returned element
    • "type":
      string
      Readonly | This is a constant: Link | Example: Link
    • "attributes":
      array
      An array of ResourceAttribute objects. The list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "uri":
      string
      The URI
    • "relation":
      string
      The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
    • "title":
      string
      The title of the link
    • "description":
      string
      The description of the link
    • "itemId":
      string
      The ID of the linked item
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
    ]
  • "type":
    string
    This is a constant: ResourceCollection | Example: ResourceCollection
  • "sortKeys":
    array
    An array of string literals. The keys to sort for
  • "name":
    string
    The name of the returned element
}
ResourceCollectionROPageletLinkRO application/json{
  • "pageable":
    string
    The pageable ID
  • "total":
    integer
    The pageable amount total | Format: int32
  • "offset":
    integer
    The pageable offset | Format: int32
  • "amount":
    integer
    The pageable amount | Format: int32
  • "elements":
    array
    An array of PageletLinkRO objects. The list of elements
    [
    PageletLinkRO: The list of elements
    {
    • "name":
      string
      The name of an element
    • "type":
      string
      Readonly | The type of the element. This is normally a constant that can be used to differentiate elements by their type.
    • "attributes":
      array
      An array of ResourceAttribute objects. The list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "uri":
      string
    • "relation":
      string
      Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
    • "title":
      string
    • "description":
      string
    • "itemId":
      string
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
    ]
  • "type":
    string
    The type of the element. This is normally a constant that can be used to differentiate elements by their type.
  • "sortKeys":
    array
    An array of string literals. The keys to sort for
  • "name":
    string
    The name of an element
}
SlotRO application/json{
  • "name":
    string
    The name of an element
  • "type":
    string
    Readonly | The type of the element. This is normally a constant that can be used to differentiate elements by their type.
  • "definitionQualifiedName":
    string
    Required | The definition qualified name of the returned element
  • "link":
    object
    A LinkRO object. A Link pointing to a resource
    {
    • "name":
      string
      The name of the returned element
    • "type":
      string
      Readonly | This is a constant: Link | Example: Link
    • "attributes":
      array
      An array of ResourceAttribute objects. The list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "uri":
      string
      The URI
    • "relation":
      string
      The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
    • "title":
      string
      The title of the link
    • "description":
      string
      The description of the link
    • "itemId":
      string
      The ID of the linked item
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
  • "displayName":
    string
  • "pagelets":
    array
    An array of PageletAdaptable objects. The collection of PageletROs (or links to them) assigned to this slot
    [
    PageletAdaptable: The collection of pagelets refered by the requested PageletEntryPoint
    {}
    ]
  • "configurationParameters":
    object
    The map of ConfigurationParameterROs with their names as keys
  • "customAttributes":
    object
    The map of custom attributes with their names as keys
  • "attribute":
    object
    A ResourceAttribute object. An attribute
    {
    • "name":
      string
      The attribute's name
    • "type":
      string
      This is a constant: ResourceAttribute | Example: ResourceAttribute
    • "value":
      object
      The attribute's value.
    }
}
ViewContextRO application/json{
  • "name":
    string
    The name of an element
  • "type":
    string
    Readonly | The type of the element. This is normally a constant that can be used to differentiate elements by their type.
  • "definitionQualifiedName":
    string
    Required | The definition qualified name of the returned element
  • "link":
    object
    A LinkRO object. A Link pointing to a resource
    {
    • "name":
      string
      The name of the returned element
    • "type":
      string
      Readonly | This is a constant: Link | Example: Link
    • "attributes":
      array
      An array of ResourceAttribute objects. The list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "uri":
      string
      The URI
    • "relation":
      string
      The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
    • "title":
      string
      The title of the link
    • "description":
      string
      The description of the link
    • "itemId":
      string
      The ID of the linked item
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
  • "displayName":
    string
    The display name of the view context
  • "id":
    string
    The unique internal Id
  • "resolveLink":
    object
    A LinkRO object. A Link pointing to a resource
    {
    • "name":
      string
      The name of the returned element
    • "type":
      string
      Readonly | This is a constant: Link | Example: Link
    • "attributes":
      array
      An array of ResourceAttribute objects. The list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "uri":
      string
      The URI
    • "relation":
      string
      The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
    • "title":
      string
      The title of the link
    • "description":
      string
      The description of the link
    • "itemId":
      string
      The ID of the linked item
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
  • "callParameters":
    array
    An array of CallParameterDefinitionRO objects. The parameters that have to be used to denote the objects this context belongs to
    [
    CallParameterDefinitionRO: A call parameter used to define particular view context objects
    {
    • "name":
      string
      The name of an element
    • "description":
      string
      A description of the parameter
    • "optional":
      boolean
      True, if the parameter is optional
    }
    ]
  • "systemManaged":
    boolean
    The system managed flag indicates whether the view contexts are instantiated by the system or created by the user.
  • "page":
    boolean
    The page flag indicates whether the view contexts ContextObjectRelation points to a page or an include.
  • "configurationParameters":
    object
    The map of ConfigurationParameterROs with their names as keys
  • "customAttributes":
    object
    The map of custom attributes with their names as keys
  • "attribute":
    object
    A ResourceAttribute object. An attribute
    {
    • "name":
      string
      The attribute's name
    • "type":
      string
      This is a constant: ResourceAttribute | Example: ResourceAttribute
    • "value":
      object
      The attribute's value.
    }
}
Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.

The Intershop Customer Portal uses only technically necessary cookies. We do not track visitors or have visitors tracked by 3rd parties. Please find further information on privacy in the Intershop Privacy Policy and Legal Notice.
Customer Support
Home Page
How To Contact Us
ISO 9001 Certified
Additional Services
Product Support Matrix
Contract Datasheet
Feedback Form
Support News Archive
Knowledge Base
Home Page
Search
Personal Library
Product Resources
Home Page
Search
Difference Report
Product Support Matrix
Service Connector Matrix