Model Management

List all Content Fragment Models

This operation provides support for retrieving all the Content Fragment Models 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

query Parameters

cursor	string (Cursor) non-empty When the number of results for a request exceeds the allowed limit, the response will include a `cursor`. That value can then be sent via this parameter on a subsequent request 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.
projection	string (Projection) Default: "full" This parameter is optional. If set to 'minimal', the response will include include only the resource identifiers of the Content Fragment Model: id, path, and name. If set to 'summary', the Content Fragment Model's fields will not be populated in the response. If set to 'full', the response will include all properties. By default, the value of this query parameter is 'full'. Enum: "minimal" "summary" "full"

Responses

200

A list of Content Fragment Models was successfully returned.

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

403

Forbidden. Indicates that the server understood the request but refuses to fulfil it.

406

Not Acceptable. 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

Internal Server Error. Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

get/cf/models

Request samples

curl
Java
Node.js
JavaScript

Response samples

200
400
403
406
500

application/json

{"items": [{"id": "L2NvbmYvd2tuZC1zaGFyZWQvc2V0dGluZ3MvZGFtL2NmbS9tb2RlbHMvYWR2ZW50dXJl",
"path": "/conf/wknd-shared/settings/dam/cfm/models/adventure",
"name": "Adventure"
}
]
}

Create a Content Fragment Model

This operation allows creating one or more Content Fragment Models. The server will check the content-fragment field types and validate if the passed models are present in the request's payload or already available on the server. A content-fragment field can also reference the model it belongs to by listing that model's short path (/conf/<configurationFolder>/<name>) in the field's items.

SecuritybearerAuth

Request

query Parameters

dryRun

boolean

Default: false

If set to true, this operation allows validating the payload for creating one or more Content Fragment Models before performing the actual creation request. It performs the same validations as the creation process but does not create the models.

Request Body schema: application/json

The request payload to create one or more Content Fragment Models.

configurationFolder	string The configuration folder where the models should be created. If both `configurationFolder` and `models.configurationFolder` are provided, the latter will take precedence.
locked	boolean Default: false If the models are locked, then no edits can be performed on them, except for unlocking them. If both `locked` and `models.locked` are provided, the latter will take precedence.
	Array of objects (CreateContentFragmentModel)

Responses

201

The Content Fragment Models were successfully created.

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

403

Forbidden. Indicates that the server understood the request but refuses to fulfil it.

406

Not Acceptable. 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.

409

Conflict. Indicates that the request could not be completed due to a conflict with the current state of the target resource.

415

Unsupported Media Type. Indicates that the origin server is refusing to service the request because the content is in a format not supported by this method on the target resource.

500

Internal Server Error. Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

post/cf/models

Request samples

Payload
curl
Java
Node.js
JavaScript

application/json

A content-fragment field references the model it belongs to by listing that model's short path (/conf/<configurationFolder>/<name>) in items. The short path can be combined with regular Content Fragment Model IDs in the same items array.

{"configurationFolder": "/conf/wknd",
"models": [{"name": "Article Model",
"technicalName": "article",
"fields": [{"type": "text",
"name": "title",
"label": "Title",
"required": true
},
{"type": "content-fragment",
"name": "relatedArticles",
"label": "Related Articles",
"multiple": true,
"root": "/content/dam/wknd",
"items": ["/conf/wknd/Article Model",
"L2NvbmYvZ2xvYmFsL3NldHRpbmdzL2RhbS9jZm0vbW9kZWxzL3NpbXBsZS1jZg"
]
}
]
}
]
}

Response samples

application/json

{"items": [{"id": "L2NvbmYvZ2xvYmFsL3NldHRpbmdzL2RhbS9jZm0vbW9kZWxzL2Etc2ltcGxlLWNmbQ",
"path": "/conf/global/settings/dam/cfm/models/a-simple-cfm",
"name": "A simple CFM"
}
]
}

Get a Content Fragment Model

SecuritybearerAuth

Request

path Parameters

id

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. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

403

Forbidden. Indicates that the server understood the request but refuses to fulfil it.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

406

Not Acceptable. 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

Internal Server Error. Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

get/cf/models/{id}

Request samples

curl
Java
Node.js
JavaScript

Response samples

application/json

{"id": "L2NvbmYvd2tuZC1zaGFyZWQvc2V0dGluZ3MvZGFtL2NmbS9tb2RlbHMvYWR2ZW50dXJl",
"path": "/conf/wknd-shared/settings/dam/cfm/models/adventure",
"name": "Adventure",
"etag": "eddd95e986a7aff0500f0649bcf6604c",
"description": "",
"created": {"at": "2023-08-02T16:01:34.582+03:00",
"by": "admin"
},
"modified": {"at": "2022-06-01T10:17:43.668-07:00",
"by": "admin"
},
"locked": false,
"status": "enabled",
"previewStatus": "IN_SYNC",
"fields": [{"type": "text",
"name": "title",
"label": "Title",
"required": true,
"multiple": false,
"maxLength": 255,
"validationType": "none"
},
{"type": "text",
"name": "slug",
"label": "Slug",
"description": "A short path to uniquely identify the Adventure. Can be used for pathing in client applications.",
"required": true,
"multiple": false,
"maxLength": 255,
"validationType": "custom",
"customValidationRegex": "^[a-z0-9\\-_]{5,40}$",
"customErrorMessage": "Slug must be at least 5 characters in length, lower case, using only letters and numbers and no spaces. Only special characters that can be used are dashes and underscore.."
},
{"type": "long-text",
"name": "description",
"label": "Description",
"description": "An overview of the trip.",
"required": false,
"multiple": false,
"mimeType": "text/html"
},
{"type": "enumeration",
"name": "adventureType",
"label": "Adventure Type",
"required": false,
"multiple": true,
"hint": "select",
"values": [{"key": "Day Trip",
"value": "Day Trip"
},
{"key": "Overnight Trip",
"value": "Overnight Trip"
},
{"key": "Training Session",
"value": "Training Session"
}
],
"placeholder": "Select the type of adventure"
},
{"type": "text",
"name": "tripLength",
"label": "Trip Length",
"required": false,
"multiple": false,
"maxLength": 255,
"validationType": "none"
},
{"type": "enumeration",
"name": "activity",
"label": "Activity",
"required": false,
"multiple": true,
"hint": "select",
"values": [{"key": "Camping",
"value": "Camping"
},
{"key": "Surfing",
"value": "Surfing"
},
{"key": "Skiing",
"value": "Skiing"
},
{"key": "Cycling",
"value": "Cycling"
},
{"key": "Hiking",
"value": "Hiking"
},
{"key": "Skateboarding",
"value": "Skateboarding"
},
{"key": "Rock Climbing",
"value": "Rock Climbing"
},
{"key": "Running",
"value": "Running"
},
{"key": "Snowboarding",
"value": "Snowboarding"
},
{"key": "Social",
"value": "Social"
}
],
"placeholder": "Select the activity"
},
{"type": "number",
"name": "groupSize",
"label": "Group Size",
"description": "Group size",
"required": false,
"multiple": false,
"min": 1
},
{"type": "enumeration",
"name": "difficulty",
"label": "Difficulty",
"required": false,
"multiple": true,
"hint": "select",
"values": [{"key": "Beginner",
"value": "Beginner"
},
{"key": "Intermediate",
"value": "Intermediate"
},
{"key": "Advanced",
"value": "Advanced"
},
{"key": "Expert",
"value": "Expert"
}
],
"placeholder": "Select the difficulty level"
},
{"type": "float-number",
"name": "price",
"label": "Price",
"description": "Price of the Adventure",
"required": false,
"multiple": false,
"defaultValue": 100
},
{"type": "content-reference",
"name": "primaryImage",
"label": "Primary Image",
"required": false,
"multiple": false,
"showThumbnail": false,
"root": "/content/dam/wknd",
"allowedContentTypes": ["image"
]
},
{"type": "long-text",
"name": "itinerary",
"label": "Itinerary",
"required": false,
"multiple": false,
"mimeType": "text/html"
},
{"type": "long-text",
"name": "gearList",
"label": "What to Bring",
"required": false,
"multiple": false,
"mimeType": "text/html"
}
],
"tags": [{"id": "wknd-shared:season/summer",
"title": "Summer",
"i18n": [ ],
"titlePath": "WKND Shared : Season / Summer",
"name": "summer",
"path": "/content/cq:tags/wknd-shared/season/summer",
"description": ""
},
{"id": "wknd-shared:season/spring",
"title": "Spring",
"i18n": [ ],
"titlePath": "WKND Shared : Season / Spring",
"name": "spring",
"path": "/content/cq:tags/wknd-shared/season/spring",
"description": ""
}
],
"previewUrlPattern": "http://localhost:4502/${contentFragment.model.name}/${contentFragment.id}.html"
}

Get the details for a Content Fragment Model

This operation allows retrieving the headers for a Content Fragment Model, when a client needs to execute subsequent operations that need to be consistent (e.g. check an ETag value, check if the model still exists, etc.).

SecuritybearerAuth

Request

path Parameters

id

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

403

Forbidden

404

Not Found

500

Internal Server Error

head/cf/models/{id}

Request samples

curl
Java
Node.js
JavaScript

Edit a Content Fragment Model

This operation allows editing a Content Fragment Model. The changes are passed as JSON Patch documents.

Save conflicts are detected by leveraging conditional HTTP requests. When a conflict occurs, the server will reply with a 412 response. It becomes the caller's responsibility to resolve the conflict, either by accepting the values from the server, or by overwriting them.

SecuritybearerAuth

Request

path Parameters

id

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.

If-Match

required

string

The If-Match header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is "*", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value.

For more details, please head over to RFC9110.

Request Body schema: application/json-patch+json
required

Array

op required	string The operation to perform add
path required	string non-empty The location where information should be added
required	string or number or Array of any or object or boolean (PatchValue) The information to place at the location indicated by the `path` parameter

Responses

200

OK

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

403

Forbidden. Indicates that the server understood the request but refuses to fulfil it.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

406

Not Acceptable. 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.

409

Conflict. Indicates that the request could not be completed due to a conflict with the current state of the target resource.

412

Precondition Failed. Indicates that one or more conditions given in the request header fields evaluated to false when tested on the server.

415

Unsupported Media Type. Indicates that the origin server is refusing to service the request because the content is in a format not supported by this method on the target resource.

428

Precondition Required. Indicates that the origin server requires the request to be conditional.

500

Internal Server Error. Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

patch/cf/models/{id}

Request samples

Payload
curl
Java
Node.js
JavaScript

application/json-patch+json

[{"op": "add",
"path": "/dc:title",
"value": "Flower Photo"
}
]

Response samples

application/json

{"id": "L2NvbmYvd2tuZC1zaGFyZWQvc2V0dGluZ3MvZGFtL2NmbS9tb2RlbHMvYWR2ZW50dXJl",
"path": "/conf/wknd-shared/settings/dam/cfm/models/adventure",
"name": "Name changed by PATCH CFM",
"description": "",
"created": {"at": "2023-08-02T16:01:34.582+03:00",
"by": "admin"
},
"modified": {"at": "2022-06-01T10:17:43.668-07:00",
"by": "admin"
},
"locked": false,
"status": "enabled",
"fields": [{"type": "text",
"name": "title",
"label": "Title",
"required": true,
"multiple": false,
"maxLength": 255,
"validationType": "none"
},
{"type": "text",
"name": "slug",
"label": "Slug",
"description": "A short path to uniquely identify the Adventure. Can be used for pathing in client applications.",
"required": true,
"multiple": false,
"maxLength": 255,
"validationType": "custom",
"customValidationRegex": "^[a-z0-9\\-_]{5,40}$",
"customErrorMessage": "Slug must be at least 5 characters in length, lower case, using only letters and numbers and no spaces. Only special characters that can be used are dashes and underscore.."
},
{"type": "long-text",
"name": "description",
"label": "Description",
"description": "An overview of the trip.",
"required": false,
"multiple": false,
"mimeType": "text/html"
},
{"type": "enumeration",
"name": "adventureType",
"label": "Adventure Type",
"required": false,
"multiple": true,
"hint": "select",
"values": [{"key": "Day Trip",
"value": "Day Trip"
},
{"key": "Overnight Trip",
"value": "Overnight Trip"
},
{"key": "Training Session",
"value": "Training Session"
}
]
},
{"type": "text",
"name": "tripLength",
"label": "Trip Length",
"required": false,
"multiple": false,
"maxLength": 255,
"validationType": "none"
},
{"type": "enumeration",
"name": "activity",
"label": "Activity",
"required": false,
"multiple": true,
"hint": "select",
"values": [{"key": "Camping",
"value": "Camping"
},
{"key": "Surfing",
"value": "Surfing"
},
{"key": "Skiing",
"value": "Skiing"
},
{"key": "Cycling",
"value": "Cycling"
},
{"key": "Hiking",
"value": "Hiking"
},
{"key": "Skateboarding",
"value": "Skateboarding"
},
{"key": "Rock Climbing",
"value": "Rock Climbing"
},
{"key": "Running",
"value": "Running"
},
{"key": "Snowboarding",
"value": "Snowboarding"
},
{"key": "Social",
"value": "Social"
}
]
},
{"type": "number",
"name": "groupSize",
"label": "Group Size",
"description": "Group size",
"required": false,
"multiple": false,
"min": 1
},
{"type": "enumeration",
"name": "difficulty",
"label": "Difficulty",
"required": false,
"multiple": true,
"hint": "select",
"values": [{"key": "Beginner",
"value": "Beginner"
},
{"key": "Intermediate",
"value": "Intermediate"
},
{"key": "Advanced",
"value": "Advanced"
},
{"key": "Expert",
"value": "Expert"
}
]
},
{"type": "float-number",
"name": "price",
"label": "Price",
"description": "Price of the Adventure",
"required": false,
"multiple": false,
"defaultValue": 100
},
{"type": "content-reference",
"name": "primaryImage",
"label": "Primary Image",
"required": false,
"multiple": false,
"showThumbnail": false,
"root": "/content/dam/wknd",
"allowedContentTypes": ["image"
]
},
{"type": "long-text",
"name": "itinerary",
"label": "Itinerary",
"required": false,
"multiple": false,
"mimeType": "text/html"
},
{"type": "long-text",
"name": "gearList",
"label": "What to Bring",
"required": false,
"multiple": false,
"mimeType": "text/html"
}
],
"tags": [{"id": "wknd-shared:season/summer",
"title": "Summer",
"i18n": [ ],
"titlePath": "WKND Shared : Season / Summer",
"name": "summer",
"path": "/content/cq:tags/wknd-shared/season/summer",
"description": ""
},
{"id": "wknd-shared:season/spring",
"title": "Spring",
"i18n": [ ],
"titlePath": "WKND Shared : Season / Spring",
"name": "spring",
"path": "/content/cq:tags/wknd-shared/season/spring",
"description": ""
}
]
}

Delete a Content Fragment Model

SecuritybearerAuth

Request

path Parameters

id

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.

If-Match

required

string

The If-Match header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is "*", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value.

For more details, please head over to RFC9110.

Responses

204

The delete operation completed successfully. The response body doesn't provide any content.

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

403

Forbidden. Indicates that the server understood the request but refuses to fulfil it.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

409

Conflict. Indicates that the request could not be completed due to a conflict with the current state of the target resource.

412

Precondition Failed. Indicates that one or more conditions given in the request header fields evaluated to false when tested on the server.

428

Precondition Required. Indicates that the origin server requires the request to be conditional.

500

Internal Server Error. Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

delete/cf/models/{id}

Request samples

curl
Java
Node.js
JavaScript

Response samples

application/problem+json

{"type": "http://api.adobeaemcloud.com/adobe/meta/errors/bad_request",
"title": "Bad Request",
"status": 400,
"detail": "Bad request, please check that you have provided the correct parameters and that they are valid."
}

Publish Content Fragment Models

This operation starts an AEM workflow for publishing Content Fragment Models.

SecuritybearerAuth

Request

Request Body schema: application/json

Request parameters to publish content fragment models.

ids required	Array of strings (Base64URLId) [ 1 .. 50 ] items unique The list of content fragment model ids.
agentId	string Default: "publish" The agent id used for publishing the content fragment models.
filterAllowedModelIdsByStatus required	Array of any unique The status of the referenced models. A model is in `draft` as soon as it's created, unless the user specifically marks the model as `enabled`. A model is in `disabled` state only when a user explicitly disables the model. Items Enum: "ENABLED" "DISABLED" "DRAFT"
workflowModelId	string Default: "/etc/workflow/models/scheduled_model_activation_with_references" The workflow model id used for initiating the workflow instance to handle the publication. AEM provides the designated model `/etc/workflow/models/scheduled_model_activation_with_references` for publishing contents including references.
workflowTitle	string A freely defined non-empty string used to identify the workflow when it executes.
scheduledTime	integer <int64> The scheduled time as an epoch timestamp.

Responses

200

OK

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

406

Not Acceptable. 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.

415

Unsupported Media Type. Indicates that the origin server is refusing to service the request because the content is in a format not supported by this method on the target resource.

500

Internal Server Error. Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

post/cf/models/publish

Request samples

Payload
curl
Java
Node.js
JavaScript

application/json

{"ids": ["L2NvbmYvd2tuZC1zaGFyZWQvc2V0dGluZ3MvZGFtL2NmbS9tb2RlbHMvYXJ0aWNsZQ==",
"L2NvbmYvd2tuZC1zaGFyZWQvc2V0dGluZ3MvZGFtL2NmbS9tb2RlbHMvYWR2ZW50dXJl"
],
"filterAllowedModelIdsByStatus": ["DRAFT",
"ENABLED"
],
"workflowModelId": "/etc/workflow/models/scheduled_model_activation_with_references",
"workflowTitle": "Workflow Title",
"scheduledTime": 1635244063701
}

Response samples

application/json

{"workflowInstanceId": "/var/workflow/instances/server0/2022-01-21/scheduled_activation_with_references_23",
"items": [{"path": "/content/dam/fragment",
"status": "SUCCESS_TRIGGERED"
},
{"path": "/content/dam/missing_fragment",
"status": "ERROR_NOT_FOUND"
},
{"path": "/content/dam/referenced_fragment",
"status": "ERROR_REFERENCED"
}
]
}

Get the scheduled publication status for a list of Content Fragment Models

SecuritybearerAuth

Request

Request Body schema: application/json
required

ids

required

Array of strings (Base64URLId) [ 1 .. 50 ] items unique

The list of Content Fragment Model IDs.

Responses

200

OK

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

406

Not Acceptable. 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.

415

Unsupported Media Type. Indicates that the origin server is refusing to service the request because the content is in a format not supported by this method on the target resource.

500

Internal Server Error. Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

post/cf/models/scheduledPublicationStatus

Request samples

Payload
curl
Java
Node.js
JavaScript

application/json

{"ids": ["string"
]
}

Response samples

200
400
406
415
500

application/json

{"items": [{"id": "string",
"scheduledPublicationStatus": {"action": "PUBLISH",
"status": "PENDING",
"scheduledBy": "admin",
"scheduledDate": "2023-08-04T12:11:09.120Z"
}
}
]
}

Get the UI schema associated with the Content Fragment Model

SecuritybearerAuth

Request

path Parameters

id

required

string (Base64URLId) non-empty

The ID of the Content Fragment Model.

header Parameters

X-Adobe-Accept-Unsupported-API

required

integer

The X-Adobe-Accept-Unsupported-API request header is required when a client wants to opt-in into using a product-only API, not designed for public consumption. Not providing this header to an endpoint that requires it will make the server answer with a 400 status code.

Value: 1

Responses

200

A response containing a UI schema

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

406

Not Acceptable. 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

Internal Server Error. Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

get/cf/models/{id}/uiSchema

Request samples

curl
Java
Node.js
JavaScript

Response samples

200
400
404
406
500

application/json

{"uiSchema": {"type": "HorizontalLayout",
"elements": [{"type": "Control",
"label": "Source",
"scope": "#/properties/source"
},
{"type": "Control",
"label": "Image",
"scope": "#/properties/image"
},
{"type": "Control",
"label": "Video",
"scope": "#/properties/video"
},
{"type": "Control",
"label": "Image",
"scope": "#/properties/image"
}
]
},
"staticSchema": {"type": "object",
"properties": {"source": {"type": "boolean",
"description": "media source"
},
"image": {"type": "string",
"description": "image source"
},
"video": {"type": "string",
"description": "video source"
}
},
"required": ["source"
]
}
}

Update the existing UI schema associated with a Content Fragment Model

SecuritybearerAuth

Request

path Parameters

id

required

string (Base64URLId) non-empty

The ID of the Content Fragment Model.

header Parameters

X-Adobe-Accept-Unsupported-API

required

integer

The X-Adobe-Accept-Unsupported-API request header is required when a client wants to opt-in into using a product-only API, not designed for public consumption. Not providing this header to an endpoint that requires it will make the server answer with a 400 status code.

Value: 1

If-Match

required

string

The If-Match header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is "*", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value.

For more details, please head over to RFC9110.

Request Body schema: application/json
required

	object (Element) Common base interface for any UI schema element.
	Array of objects (Constraint)

Responses

204

The UI schema was successfully updated.

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

403

Forbidden. Indicates that the server understood the request but refuses to fulfil it.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

406

Not Acceptable. 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.

412

Precondition Failed. Indicates that one or more conditions given in the request header fields evaluated to false when tested on the server.

415

Unsupported Media Type. Indicates that the origin server is refusing to service the request because the content is in a format not supported by this method on the target resource.

428

Precondition Required. Indicates that the origin server requires the request to be conditional.

500

Internal Server Error. Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

put/cf/models/{id}/uiSchema

Request samples

Payload
curl
Java
Node.js
JavaScript

application/json

{"uiSchema": {"type": "Categorization",
"elements": [{"type": "Category",
"label": "Personal Information",
"elements": [{"type": "Control",
"scope": "#/properties/firstName"
},
{"type": "Control",
"scope": "#/properties/secondName"
}
]
},
{"type": "Category",
"label": "Address",
"elements": [{"type": "Control",
"scope": "#/properties/address/properties/street"
},
{"type": "Control",
"scope": "#/properties/address/properties/streetNumber"
}
]
}
]
}
}

Response samples

application/problem+json

{"type": "http://api.adobeaemcloud.com/adobe/meta/errors/bad_request",
"title": "Bad Request",
"status": 400,
"detail": "Bad request, please check that you have provided the correct parameters and that they are valid."
}

Copy a Content Fragment Model

This operation copies the Content Fragment Model from one location to another.

SecuritybearerAuth

Request

path Parameters

id

required

string (Base64URLId) non-empty

The unique identifier of the Content Fragment Model to be copied.

Request Body schema: application/json
required

parentPath required	string non-empty The configuration folder to which the Content Fragment Model should be copied. The provided destination path should already exist. If the destination path does not exist, the copy operation will not be performed and the system will return an error.
name	string This property allows you to specify a new name for the resource being copied. When a value is not provided the original name of the resource will be used. In case of resource conflicts in the destination folder, the server will automatically generate an alternative resource name based on the provided value.

Responses

201

The Content Fragment Model was successfully copied.

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

403

Forbidden. Indicates that the server understood the request but refuses to fulfil it.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

406

Not Acceptable. 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.

415

Unsupported Media Type. Indicates that the origin server is refusing to service the request because the content is in a format not supported by this method on the target resource.

500

Internal Server Error. Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

post/cf/models/{id}/copy

Request samples

Payload
curl
Java
Node.js
JavaScript

application/json

{"parentPath": "string",
"name": "string"
}

Response samples

application/json

{"id": "L2NvbmYvd2tuZC1zaGFyZWQvc2V0dGluZ3MvZGFtL2NmbS9tb2RlbHMvYWR2ZW50dXJl",
"path": "/conf/wknd-shared/settings/dam/cfm/models/adventure",
"name": "Adventure",
"etag": "eddd95e986a7aff0500f0649bcf6604c",
"description": "",
"created": {"at": "2023-08-02T16:01:34.582+03:00",
"by": "admin"
},
"modified": {"at": "2022-06-01T10:17:43.668-07:00",
"by": "admin"
},
"locked": false,
"status": "enabled",
"previewStatus": "IN_SYNC",
"fields": [{"type": "text",
"name": "title",
"label": "Title",
"required": true,
"multiple": false,
"maxLength": 255,
"validationType": "none"
},
{"type": "text",
"name": "slug",
"label": "Slug",
"description": "A short path to uniquely identify the Adventure. Can be used for pathing in client applications.",
"required": true,
"multiple": false,
"maxLength": 255,
"validationType": "custom",
"customValidationRegex": "^[a-z0-9\\-_]{5,40}$",
"customErrorMessage": "Slug must be at least 5 characters in length, lower case, using only letters and numbers and no spaces. Only special characters that can be used are dashes and underscore.."
},
{"type": "long-text",
"name": "description",
"label": "Description",
"description": "An overview of the trip.",
"required": false,
"multiple": false,
"mimeType": "text/html"
},
{"type": "enumeration",
"name": "adventureType",
"label": "Adventure Type",
"required": false,
"multiple": true,
"hint": "select",
"values": [{"key": "Day Trip",
"value": "Day Trip"
},
{"key": "Overnight Trip",
"value": "Overnight Trip"
},
{"key": "Training Session",
"value": "Training Session"
}
],
"placeholder": "Select the type of adventure"
},
{"type": "text",
"name": "tripLength",
"label": "Trip Length",
"required": false,
"multiple": false,
"maxLength": 255,
"validationType": "none"
},
{"type": "enumeration",
"name": "activity",
"label": "Activity",
"required": false,
"multiple": true,
"hint": "select",
"values": [{"key": "Camping",
"value": "Camping"
},
{"key": "Surfing",
"value": "Surfing"
},
{"key": "Skiing",
"value": "Skiing"
},
{"key": "Cycling",
"value": "Cycling"
},
{"key": "Hiking",
"value": "Hiking"
},
{"key": "Skateboarding",
"value": "Skateboarding"
},
{"key": "Rock Climbing",
"value": "Rock Climbing"
},
{"key": "Running",
"value": "Running"
},
{"key": "Snowboarding",
"value": "Snowboarding"
},
{"key": "Social",
"value": "Social"
}
],
"placeholder": "Select the activity"
},
{"type": "number",
"name": "groupSize",
"label": "Group Size",
"description": "Group size",
"required": false,
"multiple": false,
"min": 1
},
{"type": "enumeration",
"name": "difficulty",
"label": "Difficulty",
"required": false,
"multiple": true,
"hint": "select",
"values": [{"key": "Beginner",
"value": "Beginner"
},
{"key": "Intermediate",
"value": "Intermediate"
},
{"key": "Advanced",
"value": "Advanced"
},
{"key": "Expert",
"value": "Expert"
}
],
"placeholder": "Select the difficulty level"
},
{"type": "float-number",
"name": "price",
"label": "Price",
"description": "Price of the Adventure",
"required": false,
"multiple": false,
"defaultValue": 100
},
{"type": "content-reference",
"name": "primaryImage",
"label": "Primary Image",
"required": false,
"multiple": false,
"showThumbnail": false,
"root": "/content/dam/wknd",
"allowedContentTypes": ["image"
]
},
{"type": "long-text",
"name": "itinerary",
"label": "Itinerary",
"required": false,
"multiple": false,
"mimeType": "text/html"
},
{"type": "long-text",
"name": "gearList",
"label": "What to Bring",
"required": false,
"multiple": false,
"mimeType": "text/html"
}
],
"tags": [{"id": "wknd-shared:season/summer",
"title": "Summer",
"i18n": [ ],
"titlePath": "WKND Shared : Season / Summer",
"name": "summer",
"path": "/content/cq:tags/wknd-shared/season/summer",
"description": ""
},
{"id": "wknd-shared:season/spring",
"title": "Spring",
"i18n": [ ],
"titlePath": "WKND Shared : Season / Spring",
"name": "spring",
"path": "/content/cq:tags/wknd-shared/season/spring",
"description": ""
}
],
"previewUrlPattern": "http://localhost:4502/${contentFragment.model.name}/${contentFragment.id}.html"
}

Model Management

List all Content Fragment Models

query Parameters

Create a Content Fragment Model

query Parameters

Request Body schema: application/json

Get a Content Fragment Model

path Parameters

header Parameters

Get the details for a Content Fragment Model

path Parameters

header Parameters

Edit a Content Fragment Model

path Parameters

header Parameters

Request Body schema: application/json-patch+jsonrequired

Delete a Content Fragment Model

path Parameters

header Parameters

Publish Content Fragment Models

Request Body schema: application/json

Get the scheduled publication status for a list of Content Fragment Models

Request Body schema: application/jsonrequired

Get the UI schema associated with the Content Fragment Model

path Parameters

header Parameters

Update the existing UI schema associated with a Content Fragment Model

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Copy a Content Fragment Model

path Parameters

Request Body schema: application/jsonrequired

Request Body schema: application/json-patch+json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required