Post runEvent

POST 
/lineage

Updates a run state for a job. When authorization is enabled, job.namespace identifies the Gravitino metalake (organization), and every input and output dataset namespace must match it. Dataset names must be Gravitino metadata full names. The optional datasetType facet defaults to TABLE; supported values are TABLE, VIEW, FILE, FILESET, MODEL, and TOPIC. Inputs and outputs both require metadata visibility because this endpoint records producer-reported lineage rather than attesting underlying read or write execution. RunEvents without datasets require only metalake membership. Unsupported or external dataset identifiers are rejected when authorization is enabled. When authorization is disabled, generic OpenLineage namespaces remain supported.

Request

application/json

Body

eventTime date-timerequired

the time the event occurred at

producer urirequired

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

schemaURL urirequired

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

eventType string

Possible values: [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

run

object

required

runId uuidrequired

The globally unique ID of the run associated with the job.

facets

object

The run facets.

anyOf

MOD1

property name*

RunFacet

A Run Facet

_producer urirequired

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

_schemaURL urirequired

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

property name* any

A Run Facet

job

object

required

namespace stringrequired

The namespace containing that job

name stringrequired

The unique name for that job within that namespace

facets

object

The job facets.

anyOf

MOD1

property name*

JobFacet

A Job Facet

_producer urirequired

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

_schemaURL urirequired

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

_deleted boolean

set to true to delete a facet

property name* any

A Job Facet

inputs

object[]

The set of input datasets.

Array [

namespace stringrequired

The namespace containing that dataset

name stringrequired

The unique name for that dataset within that namespace

facets

object

The facets for this dataset

anyOf

MOD1

property name*

DatasetFacet

A Dataset Facet

_producer urirequired

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

_schemaURL urirequired

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

_deleted boolean

set to true to delete a facet

property name* any

A Dataset Facet

inputFacets

object

The input facets for this dataset.

anyOf

MOD1

property name*

InputDatasetFacet

An Input Dataset Facet

_producer urirequired

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

_schemaURL urirequired

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

property name* any

An Input Dataset Facet

]

outputs

object[]

The set of output datasets.

Array [

namespace stringrequired

The namespace containing that dataset

name stringrequired

The unique name for that dataset within that namespace

facets

object

The facets for this dataset

anyOf

MOD1

property name*

DatasetFacet

A Dataset Facet

_producer urirequired

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

_schemaURL urirequired

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

_deleted boolean

set to true to delete a facet

property name* any

A Dataset Facet

outputFacets

object

The output facets for this dataset

anyOf

MOD1

property name*

OutputDatasetFacet

An Output Dataset Facet

_producer urirequired

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

_schemaURL urirequired

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

property name* any

An Output Dataset Facet

]

Responses

201

Created

400

Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure, such as invalid json. Usually serves application/json content, although in some cases simple text/plain content might be returned by the server's middleware.

application/vnd.gravitino.v1+json

Schema

Schema

code integerrequired

Possible values: >= 1000 and <= 1100

HTTP response code

type stringrequired

Internal type definition of the error

message stringrequired

A human-readable message

stack string[]

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string",
  "stack": [
    "string"
  ]
}

Example

{
  "code": 1003,
  "type": "BadRequestException",
  "message": "Malformed request"
}

403

Forbidden - The caller cannot access at least one input or output dataset.

application/vnd.gravitino.v1+json

Schema

Schema

code integerrequired

Possible values: >= 1000 and <= 1100

HTTP response code

type stringrequired

Internal type definition of the error

message stringrequired

A human-readable message

stack string[]

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string",
  "stack": [
    "string"
  ]
}

429

Too Many Requests

5xx

A server-side problem that might not be addressable from the client side. Used for server 5xx errors without more specific documentation in individual routes.

application/vnd.gravitino.v1+json

Schema

Schema

code integerrequired

Possible values: >= 1000 and <= 1100

HTTP response code

type stringrequired

Internal type definition of the error

message stringrequired

A human-readable message

stack string[]

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string",
  "stack": [
    "string"
  ]
}

Example

{
  "code": 1002,
  "type": "RuntimeException",
  "message": "Internal Server Error",
  "stack": [
    "java.lang.RuntimeException: Internal Server Error"
  ]
}

Loading...