Preview a package merge
const url = 'https://example.com/api/content/management/packages/example/example/merge';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/api/content/management/packages/example/example/merge \ --header 'Authorization: Bearer <token>'Returns a preview of the changes a package merge would apply. For a package that has already been merged, returns the stored merge snapshot (grid-level item metadata captured at merge time) with isSnapshot=true instead of a live preview. Requires the packages.merge permission.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Repository name or ID
Package name
Responses
Section titled “Responses”Merge preview (live) or stored merge snapshot (merged packages)
Merge preview detail
object
object
Snapshot format version
Site data with structureChanges diff captured at merge time
object
All items that were in the package at merge time
object
Item ID
Item name
Item type
Item slug
Item status at merge time
Item version at merge time
Creation timestamp (Unix ms)
object
User’s username/login
User’s display name
User’s email address
Last update timestamp (Unix ms)
object
User’s username/login
User’s display name
User’s email address
Items that did not exist in the main repository before the merge
object
Item ID
Item name
Item type
Item slug
Item status at merge time
Item version at merge time
Creation timestamp (Unix ms)
object
User’s username/login
User’s display name
User’s email address
Last update timestamp (Unix ms)
object
User’s username/login
User’s display name
User’s email address
Tracked deletes applied by the merge
object
Item ID
Item name
Item type
Item slug
Item status at merge time
Item version at merge time
Creation timestamp (Unix ms)
object
User’s username/login
User’s display name
User’s email address
Last update timestamp (Unix ms)
object
User’s username/login
User’s display name
User’s email address
Main repository versions of package items as of merge time
object
Item ID
Item name
Item type
Item slug
Item status at merge time
Item version at merge time
Creation timestamp (Unix ms)
object
User’s username/login
User’s display name
User’s email address
Last update timestamp (Unix ms)
object
User’s username/login
User’s display name
User’s email address
Always empty for snapshots (cross-package diffs are transient)
True — this response is a stored merge snapshot, not a live preview
True when the package was merged before snapshot support and no item data is available
Merge timestamp (Unix ms)
object
User’s username/login
User’s display name
User’s email address
Details of the merge operation
object
Example
{ "snapshotVersion": 1, "packageItems": [ { "createdByUser": { "userName": "user@example.com", "displayName": "John Doe", "email": "user@example.com" }, "updatedByUser": { "userName": "user@example.com", "displayName": "John Doe", "email": "user@example.com" } } ], "newItems": [ { "createdByUser": { "userName": "user@example.com", "displayName": "John Doe", "email": "user@example.com" }, "updatedByUser": { "userName": "user@example.com", "displayName": "John Doe", "email": "user@example.com" } } ], "deletedItems": [ { "createdByUser": { "userName": "user@example.com", "displayName": "John Doe", "email": "user@example.com" }, "updatedByUser": { "userName": "user@example.com", "displayName": "John Doe", "email": "user@example.com" } } ], "repoItems": [ { "createdByUser": { "userName": "user@example.com", "displayName": "John Doe", "email": "user@example.com" }, "updatedByUser": { "userName": "user@example.com", "displayName": "John Doe", "email": "user@example.com" } } ], "crossPackageDiffs": [], "mergedByUser": { "userName": "user@example.com", "displayName": "John Doe", "email": "user@example.com" }}Access denied
object
Indicates an error occurred
Error message describing what went wrong
Example
{ "error": true, "message": "Item not found"}