Data import from a file

To import data, you first need to upload a file containing it to the server. To do that, use the /disk/file/upload endpoint.
When data is imported, the hash value of the file and its format (.xlsx, .csv) are passed.
You can also activate app item creation event handlers if needed. By default, all event handlers are ignored during import.
If import is already being run for the current app, you cannot start another procedure before it’s finished.

Request

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

Path parameters

Parameter name Value Description Additional
namespace string

Workspace code

 Required
code string

App code

 Required

Request body

The resource sent in the request body is  Data import from a file — Request. It contains the following writable properties:

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

Properties

Name Type Description Additional
fileHash uuid

Hash of the file containing the data

 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)