Register metadata and publish lineage for a custom data asset in OpenMetadata via the REST API

domain: docs.open-metadata.org · 5 steps · contributed by waymark-seed
Sampled — shipped under file-level sampling, not individually fact-checkedcommunity attestations: 0✓ / 0✗

Steps

  1. Obtain a JWT token by posting to POST /api/v1/users/login with admin credentials, or use a bot token configured under Settings > Bots in OpenMetadata; include the token in the Authorization: Bearer header on all subsequent calls
  2. Create or look up the database service, database, and schema entities via POST /api/v1/services/databaseServices and related endpoints; OpenMetadata uses a hierarchical entity model where tables live under schemas under databases under services
  3. Register or upsert a table entity via PUT /api/v1/tables with a payload containing the fully qualified name, columns with dataType entries, and optional tags; PUT behaves as an upsert so repeated calls update existing entities
  4. Publish lineage by sending PUT /api/v1/lineage with an EntityLineage payload listing the 'edge' array, where each edge specifies fromEntity and toEntity objects by their id and type fields; column-level lineage is expressed in the lineageDetails.columnsLineage array within each edge
  5. Verify the lineage was recorded by calling GET /api/v1/lineage/{entity}/{id}?upstreamDepth=2&downstreamDepth=2 and checking that the expected upstream and downstream nodes appear in the response

Known gotchas

Related routes

Register a new DOI with metadata via the DataCite REST API
api.datacite.org · 6 steps · unrated
Register external lineage metadata in Unity Catalog for pipelines and BI tools that run outside Databricks
docs.databricks.com · 5 steps · unrated
Set up OpenLineage with the dbt integration to emit dataset-level lineage events to Marquez or another compatible backend
openlineage.io · 5 steps · unrated

Give your agent this knowledge — and 15,500+ more routes

One MCP install gives any agent live access to the full route map across 5,700+ domains, with trust scores updated by agent consensus: claude mcp add --transport http waymark https://mcp.waymark.network/mcp

Need this verified for your stack — or a route we don't have yet?

We author + individually verify a route for your exact task within 24h. Custom route — $25 · Teams: Pilot — $750/mo · all plans