ONoneschema
Headless Importer

Import an embed file

Import the validated embed file. The import behavior is defined by the import_config object used to initialized the embed. An embed must be in the columns_mapped state to enable import, and an embed is returned in one of the following states depending on import config: import-pending or imported.

post/v1/embeds/{embed_id}/import

Request

  • Base URL
    https://api.oneschema.co
  • URL
    https://api.oneschema.co/v1/embeds/{embed_id}/import
  • Auth
    API key in header X-API-KEY

Path parameters

embed_idinteger required

The id of the embed which contains the file.

Response

200

idinteger
tokenstring
template_keystring
statusstring
user_jwtstring
imported_row_countinteger

Total number of imported rows. Only present when the embed status is "imported".

Example response

{
  "id": 41559,
  "token": "5fd6a161-86f1-4514-9e92-0660e19ad5c2",
  "template_key": "employees",
  "status": "columns_mapped",
  "user_jwt": "REPLACE_WITH_JWT",
  "imported_row_count": 995
}

Changes

No recorded changes to this operation across all 1 revision of this API.