POST
/
mapping

This is a workflow endpoint, which is an abstraction over multiple base endpoints. This endpoint allows an end to end mapping generation workflow to be executed from scratch. This endpoint does the following in one call:

  1. Create Pipeline: creates a pipeline given a name, description, and target schema.
  2. Create Job: creates a job given source data.
  3. Run job: executes job run.
  4. Get Result: returns the output result object.

Authorizations

Authorization
string
headerrequired

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
data
object[]
required

The data to be processed

name
string
required

The name of the pipeline. Must be unique within the organization.

description
string | null

The description of the pipeline

target_schema
required

The target schema to associate with the pipeline

from_sheet
boolean
default: false

The name of the sheet to read from in the source file

sheet_id
string | null

The name of the sheet to read from in the source file

Response

200 - application/json
id
string
required
status
string
required
created_at
string
required
updated_at
string | null
job_id
string
required

The job ID

pipeline_id
string
required

The pipeline ID

mapped_data
object[] | null

The mapped data

link
string | null

The link to the mapped data

Run PipelineGet Mapping