/v1/catalog-imports/plans/{planId}
GET
/v1/catalog-imports/plans/{planId}
const url = 'https://api.emely.io/v1/catalog-imports/plans/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';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://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.
Authorizations
Section titled “Authorizations”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters”planId
required
string format: uuid
Query Parameters
Section titled “Query Parameters”page
integer
Responses
Section titled “ Responses ”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"}