Introduction

The Media Assets Management REST API has been extended to to return shared content in addition to local content. Local content refers to content related to the REST call's URL (the Application, Channel, or Organization). The REST API now also returns content made available from its parents, such as sales channel, partner, partner channel, and organization. See Concept - Sharing in Media Assets Management REST API for more details.

There are two toggles to limit the sharing of content from parent levels. With the one toggle, you can globally disable content sharing. The other toggle allows you to prevent content sharing for each domain individually (for each channel, partner, organization in the hierarchy).

The two toggles are:

• intershop.backoffice.rest.media.assets.share.enabled

  • Can be stored in a global properties file

• intershop.backoffice.rest.media.assets.share.from.domain.enabled

  • Can be placed in a domain-specific properties file or stored as a domain-specific preference in the database

  • For more details on the use of a preference, refer to Cookbook - Media Asset REST API Shared Domain Filter | Recipe: Limit Access to Shared Content.

The configuration framework provides these configurations (properties or the preference) as global or domain-specific values.

Configuration

Setting the feature toggles to enabled=false disables content sharing, i.e., the shared content not included in the REST call response.

# the global toggle to disable the sharing of content from all parents
intershop.backoffice.rest.media.assets.share.enabled=false
# the domain-specific toggle to individually prevent content from being shared, by parent Channels, Partners, and Organization
intershop.backoffice.rest.media.assets.share.from.domain.enabled=false

By default, the introduced feature toggle property keys intershop.backoffice.rest.media.assets.share.enabled and intershop.backoffice.rest.media.assets.share.from.domain.enabled are set to true. If the parameter shared=true is used in Media Assets Management REST API calls, the shared content is included in the REST response body in JSON format. It can be identified by the shared=true attribute in the info section of the JSON response.

Migration

With DBPrepare, a preference definition with the default value true and the key intershop.backoffice.rest.media.assets.share.from.domain.enabled is created. This is required when the domain-specific configuration is supposed to be stored as a preference in the database.