DocumentationAEM 6.5User Guide

JSON Exporter for Content Services

Last update: April 17, 2024
  • Applies to:
  • Experience Manager 6.5
  • Topics:
  • Developing

CREATED FOR:

  • Developer

AEM Content Services are designed to generalize the description and delivery of content in/from AEM beyond a focus on web pages.

They provide the delivery of content to channels that are not traditional AEM web pages, using standardized methods that can be consumed by any client. These channels can include:

  • Single Page Applications
  • Native Mobile Applications
  • other channels and touch-points external to AEM

With content fragments that use structured content, you can provide content services by using the JSON exporter to deliver the contents of any AEM page in JSON data model format. This method can then be consumed by your own applications.

NOTE
The functionality described here is available for all Core Components since release 1.1.0 of the Core Components.

JSON Exporter with Content Fragment Core Components

Using the AEM JSON exporter, you can deliver the contents of any AEM page in JSON data model format. This method can then be consumed by your own applications.

Within AEM, the delivery is achieved using the selector model and .json extension.

.model.json

  1. For example, a URL such as:

    http://localhost:4502/content/we-retail/language-masters/en.model.json

  2. Delivers content such as:

    chlimage_1-192

You can alternatively deliver the contents of a structured content fragment by targeting it specifically.

Use the entire path to the fragment (by way of the jcr:content); for example, with a suffix such as.

.../jcr:content/root/responsivegrid/contentfragment.model.json

Your page can contain either a single content fragment or multiple components of various types. You can also use mechanisms such as list components to automatically search for relevant content.

  • For example, a URL such as:

    http://localhost:4502/content/we-retail/language-masters/en/manchester-airport/jcr:content/root/responsivegrid/contentfragment.model.json

  • Delivers content such as:

    chlimage_1-193

    NOTE
    You can adapt your own components to access and use this data.
    NOTE
    Although not a standard implementation, multiple selectors are supported, but model must be the first.

Further Information

See also:

  • Assets HTTP API

    • Assets HTTP API

  • Sling Models:

    • Sling Models - Associating a model class with a resource type since 130

  • AEM with JSON:

    • Obtaining Page Information in JSON Format

Related Documentation

For further details, see:

  • The Content Fragments topic in the Assets user guide

  • Content Fragment Models

  • Authoring with Content Fragments

  • Enabling JSON Export for a Component

  • Core Components and the Content Fragment component

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2