Run Pipeline

Authorizations

lume-api-key

string

headerrequired

Path Parameters

required

The ID or name of the pipeline to retrieve.

Body

application/json

data

required

The data to be mapped by the run.

mapper_version

integer | null

The version number of the mapper to use for the run. If omitted, the active version in the pipeline is used.

Response

200 - application/json

A run is a single execution of a mapper.

number

integer

required

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

user_id

string

required

The UUID of the user who created the run.

status

enum<string>

required

The status of the run. Run mappings are only available once the run is complete.

Available options:

QUEUED,

RUNNING,

FINISHED,

FAILED,

NEEDS REVIEW

mapper

object | null

The mapper used to produce the run.

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

mappings

object | null

The mappings produced by the run.

Pipelines

Mappers

Runs

Target Schemas

Joined Data

Users

Usage

Authorizations

Path Parameters

Body

Response