ONoneschema
Headless Importer

Set column mapping on an embed file

Set column mapping for an embed file. Mapping strategy can be defined in customizations. An embed must be in the headers_set state to support column mapping, and an embed is returned in columns_mapped state.

post/v1/embeds/{embed_id}/map

Request

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

Path parameters

embed_idinteger required

The id of the embed which contains the file.

Request body

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.