Data import from a file

First, upload the file with data to the server. You can d it using the /disk/file/upload endpoint.
For data import, the hash value of the uploaded file and the data format (xlsx, csv) are passed.
It is possible to specify if event handlers need to be activated for item creation. By deafault, event handlers are ignored.
If import is already running for the app, you will not be able to start a new import.

Request

POST /pub/v1/app/{namespace}/{code}/import

Path parameters

Parameter name Value Description Additional
namespace string

Workspace Code

 Required
code string

Workspace App Code

 Required

Request body

The request body takes a complete resource  Data import from a file - Request. Containing the following writable properties:

{
    "fileHash": "uuid",
    "format": "string",
    "withEventHandlers": "boolean"
}

Properties

Name Type Description Additional
fileHash uuid

Hash of the data file

 Optional.
format string

Format

 Optional.
withEventHandlers boolean

Run event handlers

 Optional.

Authorization

This request requires the use of one of following authorisation methods: API key

Response

The following HTTP status codes may be returned.

Status code Description Resource
200 OK

Import result model.

 Import result model (Data import from a file)