Fragment Versioning

List a Content Fragment's Versions

This operation provides support for retrieving all the Versions 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)

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

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/cf/fragments/{fragmentId}/versions

Request samples

curl
Java
Node.js
JavaScript

Response samples

application/json

{"items": [{"createdBy": "admin",
"title": "1.0",
"id": "4e6c78a1-67e0-430a-85c5-511a6458a666",
"label": "a label",
"comment": "a comment",
"created": "2023-08-04T16:30:54.898+03:00",
"modified": {"at": "2022-06-01T10:17:43.668-07:00",
"by": "admin"
}
}
],
"cursor": "string"
}

Create a Version for a Content Fragment

SecuritybearerAuth

Request

path Parameters

fragmentId

required

string <uuid> (UUID)

Resource unique identifier

Example: 49af775d-0e7a-46c3-913d-00f762528373

Request Body schema: application/json

Request payload to create a content fragment version.

label	string Content Fragment version label.
comment	string Content Fragment version comment.

Responses

201

The Content Fragment Version was successfully created.

400

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

403

Forbidden

404

Not Found

415

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.

500

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

post/cf/fragments/{fragmentId}/versions

Request samples

Payload
curl
Java
Node.js
JavaScript

application/json

{"label": "first version",
"comment": "v1"
}

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."
}

Get a Version for a Content Fragment

SecuritybearerAuth

Request

path Parameters

fragmentId required	string <uuid> (UUID) Content Fragment unique identifier Example: 49af775d-0e7a-46c3-913d-00f762528373
versionId required	string <uuid> (UUID) Content Fragment Version unique identifier Example: 49af775d-0e7a-46c3-913d-00f762528373

Responses

200

400

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

404

Not Found

406

500

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

get/cf/fragments/{fragmentId}/versions/{versionId}

Request samples

curl
Java
Node.js
JavaScript

Response samples

application/json

{"path": "/content/dam/wknd-shared/en/contributors/ian-provo",
"title": "Ian Provo",
"description": "",
"id": "6d980e6a-c9e7-444b-af43-5503c46a061c",
"created": {"at": "2023-08-02T16:01:48.275+03:00",
"by": "admin"
},
"modified": {"at": "2023-08-04T14:51:58.597+03:00",
"by": "admin"
},
"status": "DRAFT",
"fields": [{"type": "text",
"name": "firstName",
"multiple": false,
"values": ["Ian"
]
},
{"type": "text",
"name": "lastName",
"multiple": false,
"values": ["Provo"
]
},
{"type": "content-reference",
"name": "profilePicture",
"multiple": false,
"values": ["/content/dam/wknd-shared/en/contributors/ian_provo.jpg"
]
},
{"type": "date-time",
"name": "birthDay",
"multiple": false,
"values": ["1988-09-26T14:09:00-07:00"
]
},
{"type": "long-text",
"name": "biography",
"multiple": false,
"mimeType": "text/html",
"values": [ ]
},
{"type": "enumeration",
"name": "occupations",
"multiple": true,
"values": ["Influencer",
"Photographer"
]
}
],
"variations": [{"name": "another",
"title": "Another",
"description": "",
"fields": [{"type": "text",
"name": "firstName",
"multiple": false,
"values": ["IanX"
]
},
{"type": "text",
"name": "lastName",
"multiple": false,
"values": ["Provo"
]
},
{"type": "content-reference",
"name": "profilePicture",
"multiple": false,
"values": ["/content/dam/wknd-shared/en/contributors/ian_provo.jpg"
]
},
{"type": "date-time",
"name": "birthDay",
"multiple": false,
"values": [ ]
},
{"type": "long-text",
"name": "biography",
"multiple": false,
"mimeType": "text/html",
"values": [ ]
},
{"type": "enumeration",
"name": "occupations",
"multiple": true,
"values": ["Influencer"
]
}
],
"tags": [ ]
}
],
"tags": [{"id": "wknd-shared:activity/social",
"title": "Social",
"i18n": [ ],
"titlePath": "WKND Shared : Activity / Social",
"name": "social",
"path": "/content/cq:tags/wknd-shared/activity/social",
"description": ""
}
],
"references": [{"type": "asset",
"name": "ian_provo.jpg",
"fieldName": "profilePicture",
"path": "/content/dam/wknd-shared/en/contributors/ian_provo.jpg",
"created": {"at": "2023-08-02T16:01:47.765+03:00",
"by": "admin"
},
"status": "DRAFT",
"assetId": "urn:aaid:aem:1fb05fe4-c12b-4f85-b1ca-aa92cdbd6a62",
"repo:size": 251434,
"dc:format": "image/jpeg",
"tiff:ImageWidth": 1152,
"tiff:ImageHeight": 1152
}
],
"model": {"id": "L2NvbmYvd2tuZC1zaGFyZWQvc2V0dGluZ3MvZGFtL2NmbS9tb2RlbHMvYXV0aG9y",
"path": "/conf/wknd-shared/settings/dam/cfm/models/author",
"name": "Author",
"title": "Author"
},
"validationStatus": [ ],
"fieldTags": [ ],
"etag": "79d1081c7b275f62a99ccd92828c4c83"
}

Delete a Content Fragment Version

SecuritybearerAuth

Request

path Parameters

fragmentId required	string <uuid> (UUID) Content Fragment unique identifier Example: 49af775d-0e7a-46c3-913d-00f762528373
versionId required	string <uuid> (UUID) Content Fragment Version unique identifier Example: 49af775d-0e7a-46c3-913d-00f762528373

header Parameters

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

No Content

400

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

403

Forbidden

404

Not Found

412

Precondition Failed

428

Precondition Required

500

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

delete/cf/fragments/{fragmentId}/versions/{versionId}

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."
}

Restore a Content Fragment Version

This operation will replace the current version (named or not) of the indicated Content Fragment with the contents stored in the passed Version.

SecuritybearerAuth

Request

path Parameters

fragmentId required	string <uuid> (UUID) Content Fragment unique identifier Example: 49af775d-0e7a-46c3-913d-00f762528373
versionId required	string <uuid> (UUID) Content Fragment Version unique identifier Example: 49af775d-0e7a-46c3-913d-00f762528373

Responses

200

400

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

404

Not Found

500

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

post/cf/fragments/{fragmentId}/versions/restore/{versionId}

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."
}

➔ Next to Model Management