POST
/
pipelines

Creates a new pipeline.

See Target Schema Guide to learn more about the target_schema format requirements.

Authorizations

Authorization
string
headerrequired

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

Body

application/json

A pipeline is an object containing source and target schemas, and associated with a mapper that jobs can be executed on.

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

A pipeline is an object containing source and target schemas, and associated with a mapper that jobs can be executed on.

id
string
required

The id of the pipeline

user_id
string
required

The user id of the pipeline

name
string
required

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

description
string | null

The description of the pipeline

target_schema_id
string
required

The id of the target schema associated with the pipeline

source_schema_id
string | null

The id of the source schema associated with the pipeline

last_status
string | null

The status of the last job run on this pipeline.

updated_at
string | null
required

The date and time this pipeline was last updated

created_at
string
required

The date and time this pipeline was created

Get PipelinesLearn Pipeline