OpenLineage (2-0-0)

Download OpenAPI specification:Download

License: Apache 2.0

OpenLineage is an open source lineage and metadata collection API for the data ecosystem.

OpenLineage

Send an event related to the state of a run

Updates a run state for a job.

Request Body schema: application/json
One of
eventTime
required
string <date-time>

the time the event occurred at

producer
required
string <uri>

URI identifying the producer of this metadata. For example this could be a git url with a given tag or sha

schemaURL
required
string <uri>

The JSON Pointer (https://tools.ietf.org/html/rfc6901) URL to the corresponding version of the schema definition for this RunEvent

eventType
string
Enum: "START" "RUNNING" "COMPLETE" "ABORT" "FAIL" "OTHER"

the current transition of the run state. It is required to issue 1 START event and 1 of [ COMPLETE, ABORT, FAIL ] event per run. Additional events with OTHER eventType can be added to the same run. For example to send additional metadata after the run is complete

required
object (Run)
required
object (Job)
Array of objects (InputDataset)

The set of input datasets.

Array of objects (OutputDataset)

The set of output datasets.

Responses

Request samples

Content type
application/json
Example
{}