Download OpenAPI specification:
OpenLineage is an open source lineage and metadata collection API for the data ecosystem.
Updates a state of a run, job, or a dataset.
| 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. |
{- "eventTime": "2019-08-24T14:15:22Z",
- "eventType": "START|RUNNING|COMPLETE|ABORT|FAIL|OTHER",
- "run": {
- "runId": "78c33d18-170c-44d3-a227-b3194f134f73",
- "facets": {
- "property1": {
}, - "property2": {
}
}
}, - "job": {
- "namespace": "my-scheduler-namespace",
- "name": "myjob.mytask",
- "facets": {
- "property1": {
- "_deleted": true
}, - "property2": {
- "_deleted": true
}
}
}, - "inputs": [
- {
- "namespace": "my-datasource-namespace",
- "name": "instance.schema.table",
- "facets": {
- "property1": {
- "_deleted": true
}, - "property2": {
- "_deleted": true
}
}, - "inputFacets": {
- "property1": {
}, - "property2": {
}
}
}
], - "outputs": [
- {
- "namespace": "my-datasource-namespace",
- "name": "instance.schema.table",
- "facets": {
- "property1": {
- "_deleted": true
}, - "property2": {
- "_deleted": true
}
}, - "outputFacets": {
- "property1": {
}, - "property2": {
}
}
}
]
}A batch of events with updates of a state of a run, job, or a dataset.
| 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. |
[- {
- "eventTime": "2019-08-24T14:15:22Z",
- "eventType": "START|RUNNING|COMPLETE|ABORT|FAIL|OTHER",
- "run": {
- "runId": "78c33d18-170c-44d3-a227-b3194f134f73",
- "facets": {
- "property1": {
}, - "property2": {
}
}
}, - "job": {
- "namespace": "my-scheduler-namespace",
- "name": "myjob.mytask",
- "facets": {
- "property1": {
- "_deleted": true
}, - "property2": {
- "_deleted": true
}
}
}, - "inputs": [
- {
- "namespace": "my-datasource-namespace",
- "name": "instance.schema.table",
- "facets": {
- "property1": {
- "_deleted": true
}, - "property2": {
- "_deleted": true
}
}, - "inputFacets": {
- "property1": {
}, - "property2": {
}
}
}
], - "outputs": [
- {
- "namespace": "my-datasource-namespace",
- "name": "instance.schema.table",
- "facets": {
- "property1": {
- "_deleted": true
}, - "property2": {
- "_deleted": true
}
}, - "outputFacets": {
- "property1": {
}, - "property2": {
}
}
}
]
}
]{- "status": "success",
- "summary": {
- "received": 10,
- "successful": 6,
- "failed": 4,
- "retriable": 2,
- "non_retriable": 2
}, - "failed_events": [
- {
- "index": 0,
- "reason": "Unsupported event type, Unsupported facets, Server error, Timeout",
- "retriable": true
}
]
}