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.
A list of Content Fragment Models was successfully returned.
Bad Request. The Problem Details object will provide more information about the exact cause.
Forbidden
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.
{- "items": [
- {
- "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"
}
]
}, - {
- "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": ""
}
], - "previewUrlPattern": "http://localhost:4502/${contentFragment.model.name}/${contentFragment.id}.html"
}
], - "cursor": "string"
}
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.
The request payload to create one or more Content Fragment Models.
Array of objects (CreateContentFragmentModel) |
The Content Fragment Models were successfully created.
Bad Request. The Problem Details object will provide more information about the exact cause.
Forbidden
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.
Unsupported Media Type. When provided as a response to a PATCH
request,
the response will provide an Accept-Patch
response header to notify
the client what patch document media types are supported.
The server encountered an unexpected error. Retrying the request after a certain time could help.
{- "models": [
- {
- "name": "A simple CFM",
- "description": "This is a simple CFM",
- "locked": true,
- "status": "enabled",
- "fields": [
- {
- "type": "text",
- "name": "title",
- "label": "Title",
- "required": false,
- "multiple": false,
- "maxLength": 255,
- "validationType": "none"
}, - {
- "type": "text",
- "name": "slug",
- "label": "Slug",
- "description": "A short path to be used to uniquely identify the article. 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."
}
]
}
]
}
{- "items": [
- {
- "id": "L2NvbmYvZ2xvYmFsL3NldHRpbmdzL2RhbS9jZm0vbW9kZWxzL2Etc2ltcGxlLWNmbQ",
- "path": "/conf/global/settings/dam/cfm/models/a-simple-cfm",
- "name": "A simple CFM"
}
]
}
If-None-Match | string The For more details, please head over to RFC9110. |
OK
Not Modified
Bad Request. The Problem Details object will provide more information about the exact cause.
Forbidden
Not Found
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.
The server encountered an unexpected error. Retrying the request after a certain time could help.
{- "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"
}
]
}, - {
- "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": ""
}
], - "previewUrlPattern": "http://localhost:4502/${contentFragment.model.name}/${contentFragment.id}.html"
}
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.).
If-None-Match | string The For more details, please head over to RFC9110. |
OK
Not Modified
Bad Request
Forbidden
Not Found
Internal Server Error
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.
If-None-Match | string The For more details, please head over to RFC9110. |
If-Match required | string The For more details, please head over to RFC9110. |
Adds the contents of the value
parameter to the location indicated by the path
parameter.
OK
Bad Request. The Problem Details object will provide more information about the exact cause.
Forbidden
Not Found
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.
Conflict
Precondition Failed
Unsupported Media Type. When provided as a response to a PATCH
request,
the response will provide an Accept-Patch
response header to notify
the client what patch document media types are supported.
Precondition Required
The server encountered an unexpected error. Retrying the request after a certain time could help.
[- {
- "op": "replace",
- "path": "/name",
- "value": "Name changed by PATCH CFM."
}
]
{- "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": ""
}
]
}
If-None-Match | string The For more details, please head over to RFC9110. |
If-Match required | string The For more details, please head over to RFC9110. |
The delete operation completed successfully. The response body doesn't provide any content.
Bad Request. The Problem Details object will provide more information about the exact cause.
Forbidden
Not Found
Conflict
Precondition Failed
Precondition Required
The server encountered an unexpected error. Retrying the request after a certain time could help.
{- "title": "Bad Request",
- "status": 400,
- "detail": "Bad request, please check that you have provided the correct parameters and that they are valid."
}
This operation starts an AEM workflow for publishing Content Fragment Models.
Request parameters to publish content fragment models.
OK
Bad Request. The Problem Details object will provide more information about the exact cause.
Not Found
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.
Unsupported Media Type. When provided as a response to a PATCH
request,
the response will provide an Accept-Patch
response header to notify
the client what patch document media types are supported.
The server encountered an unexpected error. Retrying the request after a certain time could help.
{- "ids": [
- "L2NvbmYvd2tuZC1zaGFyZWQvc2V0dGluZ3MvZGFtL2NmbS9tb2RlbHMvYXJ0aWNsZQ==",
- "L2NvbmYvd2tuZC1zaGFyZWQvc2V0dGluZ3MvZGFtL2NmbS9tb2RlbHMvYWR2ZW50dXJl"
], - "filterAllowedModelIdsByStatus": [
- "DRAFT",
- "ENABLED"
], - "workflowModelId": "/etc/workflow/models/scheduled_model_activation_with_references",
- "workflowTitle": "Workflow Title",
- "scheduledTime": 1635244063701
}
{- "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"
}
]
}
A response containing a UI schema
Not Found
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.
The server encountered an unexpected error. Retrying the request after a certain time could help.
{- "uiSchema": {
- "type": "Control",
- "options": {
- "collapsible": false
}, - "rule": {
- "effect": "HIDE",
- "condition": {
- "scope": [
- {
- "scope": "#/properties/name"
}, - {
- "scope": "#/properties/age"
}, - {
- "scope": "#"
}
], - "schema": {
- "contains": { },
- "const": "string",
- "enum": [
- "string"
], - "not": { },
- "minimum": 0,
- "maximum": 0,
- "minLength": 0,
- "maxLength": 0,
- "exclusiveMinimum": 0,
- "exclusiveMaximum": 0,
- "multipleOf": 0,
- "pattern": "string",
- "minItems": 0,
- "maxItems": 0,
- "uniqueItems": true,
- "required": [
- "string"
]
}
}
}
}, - "modified": {
- "at": "2021-01-30T08:30:00Z",
- "by": "jdoe",
- "fullName": "John Doe"
}
}
X-Adobe-Accept-Unsupported-API required | integer The |
If-Match required | string The For more details, please head over to RFC9110. |
The UI schema was successfully updated.
Bad Request. The Problem Details object will provide more information about the exact cause.
Forbidden
Not Found
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.
Precondition Failed
Unsupported Media Type. When provided as a response to a PATCH
request,
the response will provide an Accept-Patch
response header to notify
the client what patch document media types are supported.
Precondition Required
The server encountered an unexpected error. Retrying the request after a certain time could help.
{- "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"
}
]
}
]
}
{- "title": "Bad Request",
- "status": 400,
- "detail": "Bad request, please check that you have provided the correct parameters and that they are valid."
}