AEM Sites API Schemas - Content Fragments Delivery API (2024.11-experimental)

Download OpenAPI specification:Download

Fragment Delivery

List all Content Fragments

This operation provides support for retrieving all the Content Fragments.

When the request is authenticated, it will return the Content Fragments accessible to the current user, determined via the applied request authorization. This second set might be a superset of the one retrieved via an unauthenticated request.

By default this call will return a maximum of 50 items.

The caller can define other limits suited to their application (see the limit query parameter), but the limit cannot be higher than 50. To ask for the next set of items pass the value of the cursor provided in the response to the cursor query parameter.

SecuritybearerAuth
Request
query Parameters
cursor
string (Cursor) non-empty

For a paginated request, this parameter defines the cursor from which to retrieve the next set of items.

limit
integer <int32> (Limit) [ 1 .. 50 ]

For a paginated request, this parameter defines the maximum number of items to retrieve.

path
string

Optional UTF-8 encoded parameter to specify a path where to start looking for content fragments.

Examples:
Get exactly one '/ian-provo' content fragment.
path=/content/dam/wknd-shared/en/contributors/ian-provo
Get all child content fragments under '/contributors' folder.
path=/content/dam/wknd-shared/en/contributors
Responses
200

A response containing a potentially paginated list of content fragments.

400

Bad Request. The Problem Details object will provide more information about the exact cause.

406

Unacceptable. indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request.

500

The server encountered an unexpected error. Retrying the request after a certain time could help.

get/fragments
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "cursor": "string"
}
Get a Content Fragment
SecuritybearerAuth 
Request 
path Parameters
fragmentId
required
string <uuid>  (UUID)   >= 36 characters 
Content Fragment unique identifier


 
 Example:  49af775d-0e7a-46c3-913d-00f762528373
query Parameters
references
string
 Default:  "none"
This parameter defines how references will be retrieved for Content Fragments. The following options are available:


    

  • none - no references will be collected;
    • 

  • direct - only direct references will be collected; they will not be hydrated;
    • 

  • direct-hydrated - only direct references will be collected; they will be fully hydrated;
    • 

  • all - all references up to the maximum allowed depth will be collected; they will not be hydrated;
    • 

  • all-hydrated - all references up to the maximum allowed depth will be collected; they will be fully hydrated
    • 



Non-hydrated responses will only include the properties defined by the BaseReference type when embedding references. 
Hydrated responses are defined by each implementation of the BaseReference type. In particular, for
Content Fragment references the response will include the fragment's fields and description.


This parameter will affect the value of the ETag header returned with the response.


 Enum: "none" "direct" "direct-hydrated" "all" "all-hydrated"  
header Parameters
If-None-Match
string
The If-None-Match header field makes the request method conditional on a recipient cache or origin server either
not having any current representation of the target resource, when the field value is "*", or having a selected
representation with an entity tag that does not match any of those listed in the field value.


For more details, please head over to RFC9110.


 
Responses 
200
OK


304
Not Modified


400
Bad Request. The Problem Details object will provide more information about the exact cause.


404
Not Found


406
Unacceptable. indicates that the target resource does not have a current representation that would be acceptable to the user agent,
according to the proactive negotiation header fields received in the request.


500
The server encountered an unexpected error. Retrying the request after a certain time could help.


get/fragments/{fragmentId}
Request samples 
Response samples 
application/json
{
  • "id": "6d980e6a-c9e7-444b-af43-5503c46a061c",
  • "path": "/content/dam/wknd-shared/en/contributors/ian-provo",
  • "name": "ian-provo",
  • "title": "Ian Provo",
  • "description": "Watersports enthusiast and influencer.",
  • "model": {
    },
  • "fields": {
    },
  • "referencesTree": [ ],
  • "references": [ ]
}
Get the model details of a Content Fragment
This operation allows retrieving the model details of a Content Fragment.


This operation is an alias for /fragmentModels/{modelId}.


SecuritybearerAuth 
Request 
path Parameters
fragmentId
required
string <uuid>  (UUID)   >= 36 characters 
Content Fragment unique identifier


 
 Example:  49af775d-0e7a-46c3-913d-00f762528373
header Parameters
If-None-Match
string
The If-None-Match header field makes the request method conditional on a recipient cache or origin server either
not having any current representation of the target resource, when the field value is "*", or having a selected
representation with an entity tag that does not match any of those listed in the field value.


For more details, please head over to RFC9110.


 
Responses 
200
OK


304
Not Modified


400
Bad Request. The Problem Details object will provide more information about the exact cause.


404
Not Found


406
Unacceptable. indicates that the target resource does not have a current representation that would be acceptable to the user agent,
according to the proactive negotiation header fields received in the request.


500
The server encountered an unexpected error. Retrying the request after a certain time could help.


get/fragments/{fragmentId}/model
Request samples 
Response samples 
application/json
{
  • "id": "L2NvbmYvd2tuZC1zaGFyZWQvc2V0dGluZ3MvZGFtL2NmbS9tb2RlbHMvYWR2ZW50dXJl",
  • "path": "/conf/wknd-shared/settings/dam/cfm/models/adventure",
  • "name": "adventure",
  • "title": "Adventure",
  • "description": "An adventure that can be booked by users.",
  • "tags": [
    ]
}
Model Delivery
List all Content Fragment Models

This operation provides support for retrieving all the Content Fragment Models.


When the request is authenticated, it will return the Content Fragment Models accessible to the current user,
determined via the applied request authorization. This second set might be a superset of the one retrieved via an
unauthenticated request.


By default this call will return a maximum of 50 items.


The caller can define other limits suited to their application (see the limit query
parameter), but the limit cannot be higher than 50. To ask for the next set of items
pass the value of the cursor provided in the response to the cursor query parameter.


SecuritybearerAuth 
Request 
query Parameters
cursor
string (Cursor)   non-empty 
For a paginated request, this parameter defines the cursor from which to retrieve the next set of items.


 
limit
integer <int32>  (Limit)   [ 1 .. 50 ] 
For a paginated request, this parameter defines the maximum number of items to retrieve.


 
Responses 
200
A list of Content Fragment Models was successfully returned.


400
Bad Request. The Problem Details object will provide more information about the exact cause.


406
Unacceptable. indicates that the target resource does not have a current representation that would be acceptable to the user agent,
according to the proactive negotiation header fields received in the request.


500
The server encountered an unexpected error. Retrying the request after a certain time could help.


get/fragmentModels
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "cursor": "string"
}
Get a Content Fragment Model
SecuritybearerAuth 
Request 
path Parameters
modelId
required
string (Base64URLId)   non-empty 
The ID of the Content Fragment Model to retrieve.


 
header Parameters
If-None-Match
string
The If-None-Match header field makes the request method conditional on a recipient cache or origin server either
not having any current representation of the target resource, when the field value is "*", or having a selected
representation with an entity tag that does not match any of those listed in the field value.


For more details, please head over to RFC9110.


 
Responses 
200
OK


304
Not Modified


400
Bad Request. The Problem Details object will provide more information about the exact cause.


404
Not Found


406
Unacceptable. indicates that the target resource does not have a current representation that would be acceptable to the user agent,
according to the proactive negotiation header fields received in the request.


500
The server encountered an unexpected error. Retrying the request after a certain time could help.


get/fragmentModels/{modelId}
Request samples 
Response samples 
application/json
{
  • "id": "L2NvbmYvd2tuZC1zaGFyZWQvc2V0dGluZ3MvZGFtL2NmbS9tb2RlbHMvYWR2ZW50dXJl",
  • "path": "/conf/wknd-shared/settings/dam/cfm/models/adventure",
  • "name": "adventure",
  • "title": "Adventure",
  • "description": "An adventure that can be booked by users.",
  • "tags": [
    ]
}
Get the JSON Schema for Content Fragment Fields
The JSON schema can be used to describe and validate the fields of a Content Fragment based on a specific
Content Fragment Model.


SecuritybearerAuth 
Request 
path Parameters
modelId
required
string (Base64URLId)   non-empty 
The ID of the Content Fragment Model to retrieve.


 
header Parameters
If-None-Match
string
The If-None-Match header field makes the request method conditional on a recipient cache or origin server either
not having any current representation of the target resource, when the field value is "*", or having a selected
representation with an entity tag that does not match any of those listed in the field value.


For more details, please head over to RFC9110.


 
Responses 
200
OK


304
Not Modified


400
Bad Request. The Problem Details object will provide more information about the exact cause.


404
Not Found


406
Unacceptable. indicates that the target resource does not have a current representation that would be acceptable to the user agent,
according to the proactive negotiation header fields received in the request.


500
The server encountered an unexpected error. Retrying the request after a certain time could help.


get/fragmentModels/{modelId}/jsonSchema
Request samples 
Response samples 
application/json
{
  • "$schema": "https://json-schema.org/draft/2020-12/schema",
  • "$id": "/adobe/sites/cf/models/L2NvbmYvd2tuZC1zaGFyZWQvc2V0dGluZ3MvZGFtL2NmbS9tb2RlbHMvYWR2ZW50dXJl",
  • "title": "Adventure",
  • "description": "An adventure product",
  • "type": "object",
  • "properties": {
    }
}
List all Content Fragments created based on the model
This operation provides support for retrieving all the Content Fragments
accessible to the current user, determined via the applied request authorization.
By default this call will return a maximum of 50 items.


The caller can define other limits suited to their application (see the limit query
parameter), but the limit cannot be higher than 50. To ask for the next set of items
pass the value of the cursor provided in the response to the cursor query parameter.


SecuritybearerAuth 
Request 
path Parameters
modelId
required
string (Base64URLId)   non-empty 
The ID of the Content Fragment Model to retrieve.


 
query Parameters
cursor
string (Cursor)   non-empty 
For a paginated request, this parameter defines the cursor from which to retrieve the next set of items.


 
limit
integer <int32>  (Limit)   [ 1 .. 50 ] 
For a paginated request, this parameter defines the maximum number of items to retrieve.


 
Responses 
200
A response containing a potentially paginated list of content fragments.


400
Bad Request. The Problem Details object will provide more information about the exact cause.


404
Not Found


406
Unacceptable. indicates that the target resource does not have a current representation that would be acceptable to the user agent,
according to the proactive negotiation header fields received in the request.


500
The server encountered an unexpected error. Retrying the request after a certain time could help.


get/fragmentModels/{modelId}/fragments
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "cursor": "string"
}
Fragment Variations
List all Variations of a Content Fragment
This operation provides support for retrieving all the Variations of a Content Fragment.
By default this call will return a maximum of 50 items.


The caller can define other limits suited to their application (see the limit query parameter),
but the limit cannot be higher than 50. To ask for the next set of items pass the value of the cursor
provided in the response to the cursor query parameter.


SecuritybearerAuth 
Request 
path Parameters
fragmentId
required
string <uuid>  (UUID)   >= 36 characters 
Content Fragment unique identifier


 
 Example:  49af775d-0e7a-46c3-913d-00f762528373
query Parameters
limit
integer <int32>  (Limit)   [ 1 .. 50 ] 
For a paginated request, this parameter defines the maximum number of items to retrieve.


 
cursor
string (Cursor)   non-empty 
For a paginated request, this parameter defines the cursor from which to retrieve the next set of items.


 
Responses 
200
A response containing a potentially paginated list of content fragments variations.


400
Bad Request. The Problem Details object will provide more information about the exact cause.


404
Not Found


406
Unacceptable. indicates that the target resource does not have a current representation that would be acceptable to the user agent,
according to the proactive negotiation header fields received in the request.


500
The server encountered an unexpected error. Retrying the request after a certain time could help.


get/fragments/{fragmentId}/variations
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "cursor": "string"
}
Get a Content Fragment Variation
SecuritybearerAuth 
Request 
path Parameters
fragmentId
required
string <uuid>  (UUID)   >= 36 characters 
Content Fragment unique identifier


 
 Example:  49af775d-0e7a-46c3-913d-00f762528373
variationName
required
string
The name of the Content Fragment variation


 
query Parameters
references
string
 Default:  "none"
This parameter defines how references will be retrieved for Content Fragments. The following options are available:


    

  • none - no references will be collected;
    • 

  • direct - only direct references will be collected; they will not be hydrated;
    • 

  • direct-hydrated - only direct references will be collected; they will be fully hydrated;
    • 

  • all - all references up to the maximum allowed depth will be collected; they will not be hydrated;
    • 

  • all-hydrated - all references up to the maximum allowed depth will be collected; they will be fully hydrated
    • 



Non-hydrated responses will only include the properties defined by the BaseReference type when embedding references. 
Hydrated responses are defined by each implementation of the BaseReference type. In particular, for
Content Fragment references the response will include the fragment's fields and description.


This parameter will affect the value of the ETag header returned with the response.


 Enum: "none" "direct" "direct-hydrated" "all" "all-hydrated"  
header Parameters
If-None-Match
string
The If-None-Match header field makes the request method conditional on a recipient cache or origin server either
not having any current representation of the target resource, when the field value is "*", or having a selected
representation with an entity tag that does not match any of those listed in the field value.


For more details, please head over to RFC9110.


 
Responses 
200
OK


304
Not Modified


400
Bad Request. The Problem Details object will provide more information about the exact cause.


404
Not Found


406
Unacceptable. indicates that the target resource does not have a current representation that would be acceptable to the user agent,
according to the proactive negotiation header fields received in the request.


500
The server encountered an unexpected error. Retrying the request after a certain time could help.


get/fragments/{fragmentId}/variations/{variationName}
Request samples 
Response samples 
application/json
{
  • "name": "mobile-variation",
  • "title": "Ian Provo Mobile",
  • "description": "Watersports enthusiast and influencer - Mobile.",
  • "model": {
    },
  • "fields": {
    },
  • "referencesTree": [ ],
  • "references": [ ]
}
References
Get the references of a Content Fragment
SecuritybearerAuth 
Request 
path Parameters
fragmentId
required
string <uuid>  (UUID)   >= 36 characters 
Content Fragment unique identifier


 
 Example:  49af775d-0e7a-46c3-913d-00f762528373
query Parameters
references
string
 Default:  "direct-hydrated"
This parameter defines how references will be retrieved for Content Fragments. The following options are available:


    

  • direct - only direct references will be collected; they will not be hydrated;
    • 

  • direct-hydrated - only direct references will be collected; they will be fully hydrated;
    • 

  • all - all references up to the maximum allowed depth will be collected; they will not be hydrated;
    • 

  • all-hydrated - all references up to the maximum allowed depth will be collected; they will be fully hydrated
    • 



Non-hydrated responses will only include the properties defined by the BaseReference type when embedding references. 
Hydrated responses are defined by each implementation of the BaseReference type. In particular, for
Content Fragment references the response will include the fragment's fields and description.


This parameter will affect the value of the ETag header returned with the response.


 Enum: "direct" "direct-hydrated" "all" "all-hydrated"  
header Parameters
If-None-Match
string
The If-None-Match header field makes the request method conditional on a recipient cache or origin server either
not having any current representation of the target resource, when the field value is "*", or having a selected
representation with an entity tag that does not match any of those listed in the field value.


For more details, please head over to RFC9110.


 
Responses 
200
OK


304
Not Modified


400
Bad Request. The Problem Details object will provide more information about the exact cause.


404
Not Found


406
Unacceptable. indicates that the target resource does not have a current representation that would be acceptable to the user agent,
according to the proactive negotiation header fields received in the request.


500
The server encountered an unexpected error. Retrying the request after a certain time could help.


get/fragments/{fragmentId}/references
Request samples 
Response samples 
application/json
{
  • "referencesTree": [
    ],
  • "references": {
    }
}
Get the references for a Variation of a Content Fragment
SecuritybearerAuth 
Request 
path Parameters
fragmentId
required
string <uuid>  (UUID)   >= 36 characters 
Content Fragment unique identifier


 
 Example:  49af775d-0e7a-46c3-913d-00f762528373
variationName
required
string
The name of the Content Fragment variation


 
query Parameters
references
string
 Default:  "direct-hydrated"
This parameter defines how references will be retrieved for Content Fragments. The following options are available:


    

  • direct - only direct references will be collected; they will not be hydrated;
    • 

  • direct-hydrated - only direct references will be collected; they will be fully hydrated;
    • 

  • all - all references up to the maximum allowed depth will be collected; they will not be hydrated;
    • 

  • all-hydrated - all references up to the maximum allowed depth will be collected; they will be fully hydrated
    • 



Non-hydrated responses will only include the properties defined by the BaseReference type when embedding references. 
Hydrated responses are defined by each implementation of the BaseReference type. In particular, for
Content Fragment references the response will include the fragment's fields and description.


This parameter will affect the value of the ETag header returned with the response.


 Enum: "direct" "direct-hydrated" "all" "all-hydrated"  
header Parameters
If-None-Match
string
The If-None-Match header field makes the request method conditional on a recipient cache or origin server either
not having any current representation of the target resource, when the field value is "*", or having a selected
representation with an entity tag that does not match any of those listed in the field value.


For more details, please head over to RFC9110.


 
Responses 
200
OK


304
Not Modified


400
Bad Request. The Problem Details object will provide more information about the exact cause.


404
Not Found


406
Unacceptable. indicates that the target resource does not have a current representation that would be acceptable to the user agent,
according to the proactive negotiation header fields received in the request.


500
The server encountered an unexpected error. Retrying the request after a certain time could help.


get/fragments/{fragmentId}/variations/{variationName}/references
Request samples 
Response samples 
application/json
{
  • "referencesTree": [
    ],
  • "references": {
    }
}
Get the parent references of a Content Fragment
This operation returns the parent references of type Page, Experience Fragment and Content Fragments which are 
referencing the given Content Fragment.
By default this call will return a maximum of 50 items.


The caller can define other limits suited to their application (see the limit query
parameter), but the limit cannot be higher than 50. To ask for the next set of items
pass the value of the cursor provided in the response to the cursor query parameter.


SecuritybearerAuth 
Request 
path Parameters
fragmentId
required
string <uuid>  (UUID)   >= 36 characters 
Content Fragment unique identifier


 
 Example:  49af775d-0e7a-46c3-913d-00f762528373
query Parameters
cursor
string (Cursor)   non-empty 
For a paginated request, this parameter defines the cursor from which to retrieve the next set of items.


 
limit
integer <int32>  (Limit)   [ 1 .. 50 ] 
For a paginated request, this parameter defines the maximum number of items to retrieve.


 
Responses 
200
Ok


400
Bad Request. The Problem Details object will provide more information about the exact cause.


404
Not Found


406
Unacceptable. indicates that the target resource does not have a current representation that would be acceptable to the user agent,
according to the proactive negotiation header fields received in the request.


500
The server encountered an unexpected error. Retrying the request after a certain time could help.


get/fragments/{fragmentId}/referencedBy
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "cursor": "wqeaszrdxtgfcyguiohfgytdrsewq"
}