GET
/
v2
/
pipelines
/
{id}
/
mappers
/
{version}

Authorizations

​
lume-api-key
string
headerrequired

Path Parameters

​
version
integer
required
​
id
required

The ID or name of the pipeline to retrieve.

Query Parameters

​
include
enum<string>[]
Available options:
target_schema,
transformations,
manifest
​
page
integer
default: 1
Required range: x > 1
​
size
integer
default: 50
Required range: 1 < x < 100

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.

Create MapperList Mappers