Skip to content

Get update package

GET
/api/content/management/packages/{repo}/{packageName}
curl --request GET \
--url https://example.com/api/content/management/packages/example/example \
--header 'Authorization: Bearer <token>'

Retrieves a specific update package

repo
required

Repository CACHE_ROOT

string
packageName
required

Package name

string

Package retrieved successfully

Media typeapplication/json
object
name
required

Package name

string
description

Package description

string
items

Array of item IDs in the package

Array<string>
default:
deletedItems

Array of item IDs marked for deletion

Array<string>
repo
required

Repository CACHE_ROOT

string
site

Associated site ID (for site packages)

string
merged

Whether package has been merged

boolean
workflowInfo

Workflow state for the package

object
workflowName
required

Name of the workflow definition

string
workflowInstanceId

External workflow engine instance ID

string
currentStep
required

Current step in the workflow

string
status

Current workflow status

string
default: active
Allowed values: active completed cancelled error
nextActionUrl

URL for the next action in external engine

string format: uri
startedAt
required

Unix timestamp when workflow started

number
completedAt

Unix timestamp when workflow completed

number
assignee
object
userName
required

User’s username/login

string
displayName
required

User’s display name

string
email
required

User’s email address

string
metadata

Additional metadata from external engine

object
key
additional properties
steps

Ordered list of workflow steps

Array<object>
default:
object
name
required

Step key

string
label
required

Display label

string
allowedActions

Actions allowed from this step

Array<string>
default:
Allowed values: start approve reject route cancel
assignedGroups

Security group IDs whose members can be assigned to this step

Array<string>
default:
history

History of workflow actions

Array<object>
default:
object
timestamp
required

Unix timestamp in milliseconds

number
action
required

The action that occurred

string
Allowed values: start approve reject route cancel assign status_update
fromStep

The step before this action (null for start)

string | null
toStep
required

The step after this action

string
user
object
userName
required

User’s username/login

string
displayName
required

User’s display name

string
email
required

User’s email address

string
comment

Optional comment for this action

string
externalReference

External system reference ID

string
createdDate

Creation timestamp (Unix ms)

number
updatedDate

Last update timestamp (Unix ms)

number
createdByUser
object
userName
required

User’s username/login

string
displayName
required

User’s display name

string
email
required

User’s email address

string
updatedByUser
object
userName
required

User’s username/login

string
displayName
required

User’s display name

string
email
required

User’s email address

string
mergedDate

Merge timestamp (Unix ms)

number
mergedByUser
object
userName
required

User’s username/login

string
displayName
required

User’s display name

string
email
required

User’s email address

string
mergeInfo

Details of the merge operation

object
mergedItems
required

Item IDs actually merged (may be a subset for partial merges)

Array<string>
deferredPublishIds
required

Item IDs merged as drafts pending a future auto-publish date

Array<string>
publishItems
required

Whether items were published as part of the merge

boolean
publishSite
required

Whether site assets were published as part of the merge

boolean
hasMergeSnapshot

Whether a review snapshot of the package contents was saved at merge time

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

Package not found