Skip to content

/v1/catalog-imports/plans/{planId}/apply

POST
/v1/catalog-imports/plans/{planId}/apply
curl --request POST \
--url https://api.emely.io/v1/catalog-imports/plans/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/apply \
--header 'Authorization: Bearer <token>'

Apply a stored plan via the applyCatalogImport Action: re-checks every pending unit against the live catalog (a moved read set makes the plan stale and writes nothing), then commits one unit per transaction under the draft lease and resumes across calls. Requires an api_operator token.

planId
required
string format: uuid

The apply result (applied / partial / stale / busy)

Media typeapplication/json
object
status
required
string
applied
required
Array<string>
remainingUnits
required
Array<string>
failedUnits
required
Array<object>
object
key
required
string
error
required
string
blockedUnits
required
Array<string>
staleUnits
Array<object> | null
object
key
required
string
detail
required
string
droppedOps
unitMs
elapsedMs
required
integer
Examplegenerated
{
"status": "example",
"applied": [
"example"
],
"remainingUnits": [
"example"
],
"failedUnits": [
{
"key": "example",
"error": "example"
}
],
"blockedUnits": [
"example"
],
"staleUnits": [
{
"key": "example",
"detail": "example"
}
],
"droppedOps": "example",
"unitMs": "example",
"elapsedMs": 1
}

Validation refused by the Action

Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer
detail
string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example"
}

Missing or invalid bearer token

Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer
detail
string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example"
}

Token role refused for this route

Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer
detail
string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example"
}

Import plan not found

Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer
detail
string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example"
}

Plan is superseded or already stale

Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer
detail
string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example"
}

Upstream error

Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer
detail
string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example"
}