Skip to content

/v1/catalog-imports/drafts

POST
/v1/catalog-imports/drafts
curl --request POST \
--url https://api.emely.io/v1/catalog-imports/drafts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "workspaceId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "source": { "description": "example", "fileName": "example", "mappedBy": "example" } }'

Create a catalog-import draft via the startCatalogImportDraft Action. The source is named here and carried onto every imported row. Requires an api_operator token.

Media typeapplication/json
object
workspaceId
required
string format: uuid
source
required
object
description
string
>= 1 characters <= 2000 characters
fileName
string
>= 1 characters <= 2000 characters
mappedBy
string
>= 1 characters <= 2000 characters
Examplegenerated
{
"workspaceId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"source": {
"description": "example",
"fileName": "example",
"mappedBy": "example"
}
}

The draft id and the upload limits

Media typeapplication/json
object
draftId
required
string
limits
required
object
partBytes
required
integer
documentBytes
required
integer
documentItems
required
integer
Examplegenerated
{
"draftId": "example",
"limits": {
"partBytes": 1,
"documentBytes": 1,
"documentItems": 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"
}

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