Execute import content

Execute import content

Required permissions: IMPORT

post

/tenants/{tenantUid}/imports/files/{importFileUid}

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

importFileUidstringRequired

Reference to a import file.

Pattern: ^[A-Za-z0-9-_]+

Body

actionstring · enumOptional

ENUM	Description
EXECUTE	Execute Import job
ABORT	Abort running job

Possible values:

Responses

200

Example response

application/json

templateUidstringRequiredPattern: ^[A-Za-z0-9-_]+

base64DatastringRequired

contentTypestringRequired

actionstring · enum · min: 1Required

ENUM	Description
SIMULATE	Do a simulate on import. Return content without saving
PROCESS	Process file with given template. Save file if no errors

Possible values:

importFileUidstringRequiredPattern: ^[A-Za-z0-9-_]*

operationstring · enum · min: 1Required

ENUM	Description
INSERT	Only insert non-existing records, existing records will be ignored
UPDATE	Only update existing records, non-existing records will be ignored
UPSERT	non-existing records will be inserted, existing records will be updated

Possible values:

statestring · enum · min: 1Required

ENUM	Description
NOT_STARTED	Import not started
IMPORT_IN_PROGRESS	Import is running
IMPORT_ABORT	Import is aborting
IMPORT_ABORTED	Import has been aborted
VALIDATE_IN_PROGRESS	Validate is running
COMPLETE_NOTHING_TO_IMPORT	Import is done, but there where nothing to import
COMPLETE	Import complete
VALIDATE_FAILED	Validate failed
IMPORT_FAILED	Import failed
IMPORT_ABORT	Import is aborting
IMPORT_ABORTED	Import has been aborted
READY_TO_IMPORT	Validation OK, import is ready

Possible values:

post/tenants/{tenantUid}/imports/files/{importFileUid}

POST /v2/tenants/{tenantUid}/imports/files/{importFileUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "action": "EXECUTE"
}

200

Example response

{
  "templateUid": "text",
  "base64Data": "text",
  "contentType": "text",
  "action": "SIMULATE",
  "importFileUid": "text",
  "operation": "INSERT",
  "state": "NOT_STARTED"
}