Skip to content

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

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

Read one stored plan via the getCatalogImportPlan Action: status, ledger counts and one report page (48 KB pages; pass page to page through). Requires an api_operator token.

planId
required
string format: uuid
page
integer
>= 1

The plan status, ledger and one report page

Media typeapplication/json
object
planId
required
string
draftId
required
string
status
required
string
schemaSha256
required
string
documentSha256
required
string
ledger
page
required
integer
pages
required
integer
report
required
string
Examplegenerated
{
"planId": "example",
"draftId": "example",
"status": "example",
"schemaSha256": "example",
"documentSha256": "example",
"ledger": "example",
"page": 1,
"pages": 1,
"report": "example"
}

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

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