Runs
Get Run
Retrieves a pipeline run by number for a given mapper version. The active mapper version is used by default.
GET
/
v2
/
pipelines
/
{id}
/
runs
/
{number}
Authorizations
lume-api-key
string
headerrequiredPath Parameters
number
integer
requiredid
required
The ID or name of the pipeline to retrieve.
Query Parameters
include
enum<string>[]
Available options:
target_schema
, transformations
, mappings
mapper_version
integer | null
page
integer
default: 1Required range:
x > 1
size
integer
default: 50Required range:
1 < x < 100
Response
200 - application/json
A run is a single execution of a mapper.
number
integer
requiredThe run number. Assigned sequentially from zero. Unique within a pipeline for a given mapper version.
user_id
string
requiredThe UUID of the user who created the run.
status
enum<string>
requiredThe 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.
mappings
object | null
The mappings produced by the run.