Content Fragments and Content Fragment Models Management OpenAPIs content-fragments-and-content-fragment-models-management-openapis

The modernized OpenAPI implementation of the Content Fragment Management API allows developers to programmatically perform Create, Read, Update, and Delete operations on AEM Author to manage Content Fragment Models and Content Fragments that are stored in AEM. These APIs support a number of use-cases.

For full documentation see Content Fragment Management API.

NOTE
The existing usage of Assets HTTP API for Content Fragments should be migrated to the new Content Fragment Management OpenAPI.
NOTE
Authorization is required to access the OpenAPI when you are not logged into AEM; for example when the OpenAPI is used from another product as part of an integration.
See OpenAPI-Based APIs for details of authorizing your access to the OpenAPI.
CAUTION
By default the Content Fragment Management OpenAPI is disabled on publish. Instead of this, for delivery-oriented use-cases, we recommend using the Content Fragment Delivery OpenAPI.
NOTE
See AEM APIs for Structured Content Delivery and Management for an overview of the various APIs available and comparison of some of the concepts involved.

Deliver a Composite item deliver-a-composite-item

You can deliver your Composite items with the Management OpenAPI (Content Fragments Management API).

The composite data type is fully covered across the main Management OpenAPI operations:

  • GET /adobe/sites/cf/fragments/{uuid\} returns composite values as nested field structures.

  • GET /adobe/sites/cf/fragments/{uuid\}?partial={fieldPath\} resolves a single composite subtree, used by the editor to expand a composite on demand.

  • POST / PATCH / PUT accept composite payloads, single and bulk.

  • For models, GET and POST model operations support defining composite fields with allowed modelIds.

  • For Variations:

    • GET model and UI schema endpoints support a variation query parameter
    • the variation GET fragment endpoint supports partial
    • PATCH on variations: Support partial parameter on variation PATCH endpoint
recommendation-more-help
experience-manager-cloud-service-help-main-toc