Create an update package
const url = 'https://example.com/api/content/management/packages/example';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"name":"spring-2024-update","description":"example","repo":"my-repo","site":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/content/management/packages/example \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "name": "spring-2024-update", "description": "example", "repo": "my-repo", "site": "example" }'Creates a new update package for bundling content changes
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Repository CACHE_ROOT
Request Body
Section titled “Request Body”object
Package name (required)
Example
spring-2024-updatePackage description
Repository CACHE_ROOT (required)
Example
my-repoAssociated site ID (for site packages)
Responses
Section titled “Responses”Package created successfully
object
Package name
Package description
Array of item IDs in the package
Array of item IDs marked for deletion
Repository CACHE_ROOT
Associated site ID (for site packages)
Whether package has been merged
Workflow state for the package
object
Name of the workflow definition
External workflow engine instance ID
Current step in the workflow
Current workflow status
URL for the next action in external engine
Unix timestamp when workflow started
Unix timestamp when workflow completed
object
User’s username/login
User’s display name
User’s email address
Additional metadata from external engine
object
Ordered list of workflow steps
object
Step key
Display label
Actions allowed from this step
Security group IDs whose members can be assigned to this step
History of workflow actions
object
Unix timestamp in milliseconds
The action that occurred
The step before this action (null for start)
The step after this action
object
User’s username/login
User’s display name
User’s email address
Optional comment for this action
External system reference ID
Creation timestamp (Unix ms)
Last update timestamp (Unix ms)
object
User’s username/login
User’s display name
User’s email address
object
User’s username/login
User’s display name
User’s email address
Merge timestamp (Unix ms)
object
User’s username/login
User’s display name
User’s email address
Details of the merge operation
object
Item IDs actually merged (may be a subset for partial merges)
Item IDs merged as drafts pending a future auto-publish date
Whether items were published as part of the merge
Whether site assets were published as part of the merge
Whether a review snapshot of the package contents was saved at merge time
Example
{ "name": "spring-2024-update", "items": [], "repo": "my-repo", "merged": false, "workflowInfo": { "workflowName": "content-approval", "workflowInstanceId": "wf-123", "currentStep": "review", "status": "active", "nextActionUrl": "https://engine/api/tasks/123/complete", "startedAt": 1706025600000, "completedAt": 1706112000000, "assignee": { "userName": "user@example.com", "displayName": "John Doe", "email": "user@example.com" }, "steps": [], "history": [] }, "createdDate": 1704067200000, "updatedDate": 1704153600000, "createdByUser": { "userName": "user@example.com", "displayName": "John Doe", "email": "user@example.com" }, "updatedByUser": { "userName": "user@example.com", "displayName": "John Doe", "email": "user@example.com" }, "mergedDate": 1704240000000, "mergedByUser": { "userName": "user@example.com", "displayName": "John Doe", "email": "user@example.com" }}Invalid request