POST
/
v2
/
pipelines
/
{id}
/
mappers

Authorizations

lume-api-key
string
headerrequired

Path Parameters

id
required

The ID or name of the pipeline to retrieve.

Body

application/json
sample_data
required

Sample data used to initialize a mapper. Will be executed as a run after initialization.

base_version
integer | null

The version number of the base mapper to be edited. If omitted, the active version in the pipeline is used.

global_edit
object | null

Global edits to be applied to the base mapper. If present, any field transformation logic may potentially change.

field_edits
object[] | null

List of field edits to be applied to the base mapper. If present for a field, that field's transformation logic may potentially change.

Response

200 - application/json

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

version
integer
required

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

user_id
string
required

The UUID of the user who created the 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
target_schema
object | null

The target JSON schema to which data will be mapped.

transformations
object[] | null

The transformation logic executed by the mapper.

manifest
object | null

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