Update Pipeline

Updates pipeline name and / or description.

Authorizations

lume-api-key

string

headerrequired

Path Parameters

required

The ID or name of the pipeline to retrieve.

Body

application/json

name

string | null

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

description

string | null

The new description of the pipeline.

mapper_version

integer | null

The version number of the mapper to make active in the pipeline.

Response

200 - application/json

A pipeline organizes mapper versions that operate on the same source data schema. It is initialized with a mapper which can be edited iteratively to produce new versions. A single mapper version is active at a time.

string

required

The UUID of the pipeline.

user_id

string

required

The UUID of the user who created the pipeline.

name

string

required

The user-provided name of the pipeline.

created_at

string

required

The date and time this pipeline was created.

description

string | null

The user-provided description of the pipeline.

last_run_status

enum<string> | null

The status of the last run of the active mapper in the pipeline.

Available options:

QUEUED,

RUNNING,

FINISHED,

FAILED,

NEEDS REVIEW

mapper

object

A mapper is a set of transformation logic that maps data from a source schema to a target schema.

mapper.version

integer

required

The mapper version number. Assigned sequentially from zero. Unique within a pipeline.

mapper.user_id

string

required

The UUID of the user who created the mapper.

mapper.creation_status

enum<string>

required

The status of mapper creation. The mapper is only usable once creation is complete.

Available options:

QUEUED,

RUNNING,

FINISHED,

FAILED,

NEEDS REVIEW

mapper.target_schema

object | null

The target JSON schema to which data will be mapped.

mapper.transformations

object[] | null

The transformation logic executed by the mapper.

mapper.manifest

object | null

A dependency graph of target fields and their corresponding source fields. Derived from the target schema and transformations.

mapper.manifest.items

object[]

required

mapper.manifest.items.dependencies

object | null

The dependencies of the target property

mapper.manifest.items.lookup_mappings

object[] | null

The mappings for this property

mapper.manifest.items.conditional

object | null

The conditional transformation for this property

mapper.manifest.items.property

object

required

The target property

mapper.manifest.items.children

object[]

The children of the target property

mapper.manifest.total

integer | null

required

Required range: x > 0

mapper.manifest.page

integer | null

required

Required range: x > 1

mapper.manifest.size

integer | null

required

Required range: x > 1

mapper.manifest.pages

integer | null

Required range: x > 0

Pipelines

Mappers

Runs

Target Schemas

Joined Data

Users

Usage

Authorizations

Path Parameters

Body

Response