mirror of
https://github.com/datahub-project/datahub.git
synced 2025-07-08 09:41:19 +00:00
110 lines
157 KiB
HTML
110 lines
157 KiB
HTML
<!doctype html>
|
||
<html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-current plugin-docs plugin-id-default docs-doc-id-docs/managed-datahub/datahub-api/entity-events-api" data-has-hydrated="false">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="generator" content="Docusaurus v2.4.3">
|
||
<title data-rh="true">Entity Events API | DataHub</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.datahub.com/docs/managed-datahub/datahub-api/entity-events-api"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Entity Events API | DataHub"><meta data-rh="true" name="description" content="This guide details the Entity Events API, which allows you to take action when things change on DataHub."><meta data-rh="true" property="og:description" content="This guide details the Entity Events API, which allows you to take action when things change on DataHub."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.datahub.com/docs/managed-datahub/datahub-api/entity-events-api"><link data-rh="true" rel="alternate" href="https://docs.datahub.com/docs/managed-datahub/datahub-api/entity-events-api" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.datahub.com/docs/managed-datahub/datahub-api/entity-events-api" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://RK0UG797F3-dsn.algolia.net" crossorigin="anonymous"><link rel="alternate" type="application/rss+xml" href="/learn/rss.xml" title="DataHub RSS Feed">
|
||
<link rel="alternate" type="application/atom+xml" href="/learn/atom.xml" title="DataHub Atom Feed">
|
||
|
||
<link rel="preconnect" href="https://www.google-analytics.com">
|
||
<link rel="preconnect" href="https://www.googletagmanager.com">
|
||
<script async src="https://www.googletagmanager.com/gtag/js?id=G-PKGVLETT4C"></script>
|
||
<script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-PKGVLETT4C",{})</script>
|
||
<link rel="preconnect" href="https://www.googletagmanager.com">
|
||
<script>window.dataLayer=window.dataLayer||[]</script>
|
||
<script>!function(e,t,a,n,g){e[n]=e[n]||[],e[n].push({"gtm.start":(new Date).getTime(),event:"gtm.js"});var m=t.getElementsByTagName(a)[0],r=t.createElement(a);r.async=!0,r.src="https://www.googletagmanager.com/gtm.js?id=GTM-5M8T9HNN",m.parentNode.insertBefore(r,m)}(window,document,"script","dataLayer")</script>
|
||
|
||
|
||
<link rel="search" type="application/opensearchdescription+xml" title="DataHub" href="/opensearch.xml">
|
||
|
||
|
||
|
||
|
||
<meta httpequiv="Content-Security-Policy" content="frame-ancestors 'self' https://*.acryl.io https://acryldata.io http://localhost:*">
|
||
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Manrope:wght@400;500;700&display=swap">
|
||
<script src="https://tools.luckyorange.com/core/lo.js?site-id=28ea8a38" async defer="defer"></script>
|
||
<script src="/scripts/rb2b.js" async defer="defer"></script>
|
||
<script src="https://app.revenuehero.io/scheduler.min.js"></script>
|
||
<script src="https://tag.clearbitscripts.com/v1/pk_2e321cabe30432a5c44c0424781aa35f/tags.js" referrerpolicy="strict-origin-when-cross-origin"></script>
|
||
<script src="/scripts/reo.js"></script>
|
||
<script id="runllm-widget-script" type="module" src="https://widget.runllm.com" crossorigin="true" runllm-name="DataHub" runllm-assistant-id="81" runllm-position="BOTTOM_RIGHT" runllm-keyboard-shortcut="Mod+j" runllm-preset="docusaurus" runllm-theme-color="#1890FF" runllm-brand-logo="https://docs.datahub.com/img/datahub-logo-color-mark.svg" runllm-community-url="https://datahub.com/slack" runllm-community-type="slack" runllm-disable-ask-a-person="true" async></script><link rel="stylesheet" href="/assets/css/styles.d8fe2eb8.css">
|
||
<link rel="preload" href="/assets/js/runtime~main.b31f62e5.js" as="script">
|
||
<link rel="preload" href="/assets/js/main.bc908355.js" as="script">
|
||
</head>
|
||
<body class="navigation-with-keyboard">
|
||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-5M8T9HNN" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||
|
||
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}return t}()||function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}(),document.documentElement.setAttribute("data-announcement-bar-initially-dismissed",function(){try{return"true"===localStorage.getItem("docusaurus.announcement.dismiss")}catch(t){}return!1}())</script><div id="__docusaurus">
|
||
<div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><div class="announcementBar_mb4j" style="background-color:transparent;color:#ffffff" role="banner"><div class="content_knG7 announcementBarContent_xLdY"><div class="shimmer-banner"><p>DataHub Secures $35 Million Series B</p><a href="https://datahub.com/news/series-b-announcement/" target="_blank" class="button"><div>Read the announcement<span> →</span></div></a></div></div></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a href="https://datahub.com" target="_blank" rel="noopener noreferrer" class="navbar__brand"><div class="navbar__logo"><img src="/img/datahub-logo-color-light-horizontal.svg" alt="DataHub Logo" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/datahub-logo-color-dark-horizontal.svg" alt="DataHub Logo" class="themedImage_ToTc themedImage--dark_i4oU"></div></a><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link versionNavItem_cbn8">Next</a><ul class="dropdown__menu"><li><a aria-current="page" class="dropdown__link dropdown__link--active" href="/docs/managed-datahub/datahub-api/entity-events-api">Next</a></li><li><a class="dropdown__link" href="/docs/1.1.0/managed-datahub/datahub-api/entity-events-api">1.1.0</a></li><li><hr class="dropdown-separator" style="margin: 0.4rem;"></li><li><div class="dropdown__link"><b>Archived versions</b></div></li><li>
|
||
<a class="dropdown__link" href="https://docs-website-t9sv4w3gr-acryldata.vercel.app/docs/features">1.0.0
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-t9sv4w3gr-acryldata.vercel.app/docs/0.15.0/features">0.15.0
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-8jkm4uler-acryldata.vercel.app/docs/0.14.1/features">0.14.1
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-eue2qafvn-acryldata.vercel.app/docs/features">0.14.0
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-psat3nzgi-acryldata.vercel.app/docs/features">0.13.1
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-lzxh86531-acryldata.vercel.app/docs/features">0.13.0
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-2uuxmgza2-acryldata.vercel.app/docs/features">0.12.1
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-irpoe2osc-acryldata.vercel.app/docs/features">0.11.0
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-1gv2yzn9d-acryldata.vercel.app/docs/features">0.10.5
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li></ul></div></div><div class="navbar__items navbar__items--right"><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/docs">Docs</a><a class="navbar__item navbar__link" href="/integrations">Integrations</a><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Learn</a><ul class="dropdown__menu dropdown__menu_Z8FC"><div class="wrapper_kp81"><div><a href="https://datahub.com/weekly-demo" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-join-slack.png" alt="Weekly Demo"></div><div class="title_c7DP">Weekly Demo</div></a></div><div><a href="https://datahub.com/use-cases" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-forum.png" alt="Use Cases"></div><div class="title_c7DP">Use Cases</div></a></div><div><a href="httpps://datahub.com/adoption-stories" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-events.png" alt="Adoption Stories"></div><div class="title_c7DP">Adoption Stories</div></a></div><div><a href="https://medium.com/datahub-project" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-champions.png" alt="Blog"></div><div class="title_c7DP">Blog</div></a></div><div><a href="https://www.youtube.com/channel/UC3qFQC5IiwR5fvWEqi_tJ5w" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-share-your-journey.png" alt="Youtube"></div><div class="title_c7DP">Youtube</div></a></div></div></ul></div><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Community</a><ul class="dropdown__menu dropdown__menu_Z8FC"><div class="wrapper_kp81"><div><a href="https://datahub.com/slack/" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-join-slack.png" alt="Join Slack"></div><div class="title_c7DP">Join Slack</div></a></div><div><a href="https://datahub.com/events" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-events.png" alt="Events"></div><div class="title_c7DP">Events</div></a></div><div><a href="https://datahub.com/champions/" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-champions.png" alt="Champions"></div><div class="title_c7DP">Champions</div></a></div><div><a href="https://datahub.com/share-your-journey/" target="_blank" rel="noopener noreferrer" class="card_BUD7"><div class="icon_BgHd"><img src="/img/icon-share-your-journey.png" alt="Share Your Journey"></div><div class="title_c7DP">Share Your Journey</div></a></div></div></ul></div><a href="https://datahub.com/products/why-datahub-cloud/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">
|
||
<style>
|
||
.cloud-cta {
|
||
color: var(--ifm-menu-color-active);
|
||
font-weight: 600;
|
||
background: linear-gradient(40deg, var(--ifm-menu-color-active), var(--ifm-menu-color-active));
|
||
background-size: 200% 100%;
|
||
-webkit-background-clip: text;
|
||
background-clip: text;
|
||
transition: background-image 0.3s ease;
|
||
}
|
||
.cloud-cta:hover {
|
||
color: transparent;
|
||
background: linear-gradient(40deg, var(--ifm-menu-color-active), #ff1493);
|
||
background-size: 200% 100%;
|
||
-webkit-background-clip: text;
|
||
background-clip: text;
|
||
animation: gradientShift 3s ease infinite;
|
||
}
|
||
@keyframes gradientShift {
|
||
0%, 100% { background-position: 0% 50%; }
|
||
50% { background-position: 100% 50%; }
|
||
}
|
||
</style>
|
||
<div class="cloud-cta">Get Cloud</div>
|
||
</a><a href="https://datahub.com/slack?utm_source=docs&utm_medium=header&utm_campaign=docs_header" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">
|
||
<style>
|
||
.slack-logo:hover {
|
||
opacity: 0.8;
|
||
}
|
||
</style>
|
||
<img class="slack-logo" src="https://upload.wikimedia.org/wikipedia/commons/d/d5/Slack_icon_2019.svg" , alt="slack" , height="20px" style="margin: 10px 0 0 0;">
|
||
</a><div class="searchBox_ZlJk"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20" aria-hidden="true"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebarViewport_Xe31"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG menuWithAnnouncementBar_GW3s"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Getting Started</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/features">What Is DataHub?</a><button aria-label="Toggle the collapsible sidebar category 'What Is DataHub?'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/category/features">Features</a><button aria-label="Toggle the collapsible sidebar category 'Features'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>DataHub Cloud</div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/managed-datahub/managed-datahub-overview">DataHub Cloud Overview</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/managed-datahub/welcome-acryl">Getting Started with DataHub Cloud</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/authentication/guides/sso/initialize-oidc">Configure Single Sign-On</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/managed-datahub/remote-executor/about">Remote Executor</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" href="/docs/managed-datahub/datahub-api/entity-events-api">DataHub API</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item saasOnly"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/managed-datahub/datahub-api/entity-events-api">Entity Events API</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/docs/managed-datahub/datahub-api/graphql-api/getting-started">GraphQL API</a></div></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/managed-datahub/slack/saas-slack-app">Slack</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/managed-datahub/operator-guide/setting-up-events-api-on-aws-eventbridge">Operator Guides</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item saasOnly"><a class="menu__link" href="/docs/managed-datahub/approval-workflows">Change Proposals & Approval Workflows</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/managed-datahub/chrome-extension">Cloud Chrome Extension</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item saasOnly"><a class="menu__link" href="/docs/managed-datahub/subscription-and-notification">Subscriptions & Notifications</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/managed-datahub/release-notes/v_0_3_12">DataHub Cloud Release History</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Integrations</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/metadata-ingestion">Overview</a><button aria-label="Toggle the collapsible sidebar category 'Overview'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/metadata-ingestion/cli-ingestion">Quickstart Guides</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/metadata-ingestion/source_overview">Sources</a><button aria-label="Toggle the collapsible sidebar category 'Sources'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/metadata-ingestion/schedule_docs/intro">Advanced Guides</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>API & SDKs</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/metadata-modeling/metadata-model">DataHub's Open Metadata Standard</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/what-is-datahub/datahub-concepts">Concepts</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/metadata-standards">Metadata Standards</a><button aria-label="Toggle the collapsible sidebar category 'Metadata Standards'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/api/datahub-apis">APIs and SDKs Overview</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/api/graphql/overview">API</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/metadata-ingestion/as-a-library">Python SDK</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/metadata-integration/java/as-a-library">Java SDK</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/cli">DataHub CLI</a><button aria-label="Toggle the collapsible sidebar category 'DataHub CLI'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/act-on-metadata">DataHub Actions</a><button aria-label="Toggle the collapsible sidebar category 'DataHub Actions'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/api/tutorials/datasets">Guides</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Admin</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/authentication">Authentication</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/authorization">Authorization</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/how/delete-metadata">Advanced Guides</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Deployment</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/category/deployment-guides">Deployment Guides</a><button aria-label="Toggle the collapsible sidebar category 'Deployment Guides'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/deploy/confluent-cloud">Advanced Guides</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Developers</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/architecture/architecture">Architecture</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/developers">Developing on DataHub</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/advanced/mcp-mcl">Advanced Guides</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Community</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/category/community">Community</a><button aria-label="Toggle the collapsible sidebar category 'Community'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/releases">Release History</a></div></li></ul></nav></div></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">DataHub API</span><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Entity Events API</span><meta itemprop="position" content="2"></li></ul></nav><span class="theme-doc-version-badge badge badge--secondary">Version: Next</span><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><h1>Entity Events API</h1><div class="availabilityCard_P5od card"><strong>Feature Availability</strong><div><span class="platform_wqXv">Self-Hosted DataHub <span role="img" aria-label="close-circle" class="anticon anticon-close-circle"><svg fill-rule="evenodd" viewBox="64 64 896 896" focusable="false" data-icon="close-circle" width="1em" height="1em" fill="currentColor" aria-hidden="true"><path d="M512 64c247.4 0 448 200.6 448 448S759.4 960 512 960 64 759.4 64 512 264.6 64 512 64zm127.98 274.82h-.04l-.08.06L512 466.75 384.14 338.88c-.04-.05-.06-.06-.08-.06a.12.12 0 00-.07 0c-.03 0-.05.01-.09.05l-45.02 45.02a.2.2 0 00-.05.09.12.12 0 000 .07v.02a.27.27 0 00.06.06L466.75 512 338.88 639.86c-.05.04-.06.06-.06.08a.12.12 0 000 .07c0 .03.01.05.05.09l45.02 45.02a.2.2 0 00.09.05.12.12 0 00.07 0c.02 0 .04-.01.08-.05L512 557.25l127.86 127.87c.04.04.06.05.08.05a.12.12 0 00.07 0c.03 0 .05-.01.09-.05l45.02-45.02a.2.2 0 00.05-.09.12.12 0 000-.07v-.02a.27.27 0 00-.05-.06L557.25 512l127.87-127.86c.04-.04.05-.06.05-.08a.12.12 0 000-.07c0-.03-.01-.05-.05-.09l-45.02-45.02a.2.2 0 00-.09-.05.12.12 0 00-.07 0z"></path></svg></span></span></div><div><span role="img" aria-label="cloud" class="anticon anticon-cloud managedIcon_AxXO"><svg viewBox="64 64 896 896" focusable="false" data-icon="cloud" width="1em" height="1em" fill="currentColor" aria-hidden="true"><path d="M811.4 418.7C765.6 297.9 648.9 212 512.2 212S258.8 297.8 213 418.6C127.3 441.1 64 519.1 64 612c0 110.5 89.5 200 199.9 200h496.2C870.5 812 960 722.5 960 612c0-92.7-63.1-170.7-148.6-193.3zm36.3 281a123.07 123.07 0 01-87.6 36.3H263.9c-33.1 0-64.2-12.9-87.6-36.3A123.3 123.3 0 01140 612c0-28 9.1-54.3 26.2-76.3a125.7 125.7 0 0166.1-43.7l37.9-9.9 13.9-36.6c8.6-22.8 20.6-44.1 35.7-63.4a245.6 245.6 0 0152.4-49.9c41.1-28.9 89.5-44.2 140-44.2s98.9 15.3 140 44.2c19.9 14 37.5 30.8 52.4 49.9 15.1 19.3 27.1 40.7 35.7 63.4l13.8 36.5 37.8 10c54.3 14.5 92.1 63.8 92.1 120 0 33.1-12.9 64.3-36.3 87.7z"></path></svg></span><span class="platform_wqXv platformAvailable_Y8lN">DataHub Cloud <span role="img" aria-label="check-circle" class="anticon anticon-check-circle"><svg viewBox="64 64 896 896" focusable="false" data-icon="check-circle" width="1em" height="1em" fill="currentColor" aria-hidden="true"><path d="M512 64C264.6 64 64 264.6 64 512s200.6 448 448 448 448-200.6 448-448S759.4 64 512 64zm193.5 301.7l-210.6 292a31.8 31.8 0 01-51.7 0L318.5 484.9c-3.8-5.3 0-12.7 6.5-12.7h46.9c10.2 0 19.9 4.9 25.9 13.3l71.2 98.8 157.2-218c6-8.3 15.6-13.3 25.9-13.3H699c6.5 0 10.3 7.4 6.5 12.7z"></path></svg></span></span></div></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="introduction">Introduction<a href="#introduction" class="hash-link" aria-label="Direct link to Introduction" title="Direct link to Introduction"></a></h2><p>The Events API allows you to integrate changes happening on the DataHub Metadata Graph in real time into a broader event-based architecture.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="supported-integrations">Supported Integrations<a href="#supported-integrations" class="hash-link" aria-label="Direct link to Supported Integrations" title="Direct link to Supported Integrations"></a></h3><ul><li><a href="/docs/managed-datahub/operator-guide/setting-up-events-api-on-aws-eventbridge">AWS EventBridge</a></li><li><a href="/docs/actions/sources/datahub-cloud-event-source">DataHub Cloud Event Source</a></li></ul><h3 class="anchor anchorWithStickyNavbar_LWe7" id="use-cases">Use Cases<a href="#use-cases" class="hash-link" aria-label="Direct link to Use Cases" title="Direct link to Use Cases"></a></h3><p>Real-time use cases broadly fall into the following categories:</p><ul><li><strong>Workflow Integration:</strong> Integrate DataHub flows into your organization's internal workflow management system. For example, create a Jira ticket when specific Tags or Terms are proposed on a Dataset.</li><li><strong>Notifications</strong>: Generate organization-specific notifications when a change is made on DataHub. For example, send an email to the governance team when a "PII" tag is added to any data asset.</li><li><strong>Metadata Enrichment</strong>: Trigger downstream metadata changes when an upstream change occurs. For example, propagating glossary terms or tags to downstream entities.</li><li><strong>Synchronization</strong>: Syncing changes made in DataHub into a 3rd party system. For example, reflecting Tag additions in DataHub into Snowflake.</li><li><strong>Auditing:</strong> Audit <!-- -->*<!-- -->*<!-- -->*<!-- -->*<!-- --> <em>who</em> is making <em>what changes</em> on DataHub through time.</li></ul><h2 class="anchor anchorWithStickyNavbar_LWe7" id="event-structure">Event Structure<a href="#event-structure" class="hash-link" aria-label="Direct link to Event Structure" title="Direct link to Event Structure"></a></h2><p>Each entity event is serialized to JSON & follows a common base structure.</p><p><strong>Common Fields</strong></p><table><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Optional</th></tr></thead><tbody><tr><td><strong>entityUrn</strong></td><td>String</td><td>The unique identifier for the Entity being changed. For example, a Dataset's urn.</td><td>Fals<strong>e</strong></td></tr><tr><td><strong>entityType</strong></td><td>String</td><td>The type of the entity being changed. Supported values include <code>dataset</code>, <code>chart</code>, <code>dashboard</code>, <code>dataFlow (Pipeline)</code>, <code>dataJob</code> (Task), <code>domain</code>, <code>tag</code>, <code>glossaryTerm</code>, <code>corpGroup</code>, & <code>corpUser.</code></td><td>False</td></tr><tr><td><strong>category</strong></td><td>String</td><td>The category of the change, related to the kind of operation that was performed. Examples include <code>TAG</code>, <code>GLOSSARY_TERM</code>, <code>DOMAIN</code>, <code>LIFECYCLE</code>, and more.</td><td>False</td></tr><tr><td><strong>operation</strong></td><td>String</td><td>The operation being performed on the entity given the category. For example, <code>ADD</code> ,<code>REMOVE</code>, <code>MODIFY</code>. For the set of valid operations, see the full catalog below.</td><td>False</td></tr><tr><td><strong>modifier</strong></td><td>String</td><td>The modifier that has been applied to the entity. The value depends on the category. An example includes the URN of a tag being applied to a Dataset or Schema Field.</td><td>True</td></tr><tr><td><strong>parameters</strong></td><td>Dict</td><td>Additional key-value parameters used to provide specific context. The precise contents depends on the category + operation of the event. See the catalog below for a full summary of the combinations.</td><td>True</td></tr><tr><td><strong>auditStamp.actor</strong></td><td>String</td><td>The urn of the actor who triggered the change.</td><td>False</td></tr><tr><td><strong>auditStamp.time</strong></td><td>Number</td><td>The timestamp in milliseconds corresponding to the event.</td><td>False</td></tr></tbody></table><p>For example, an event indicating that a Tag has been added to a particular Dataset would populate each of these fields:</p><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token plain">{</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityUrn": "urn:li:dataset:abc",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityType": "dataset",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "category": "TAG",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "operation": "ADD",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "modifier": "urn:li:tag:PII",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "parameters": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "tagUrn": "urn:li:tag:PII"</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "auditStamp": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "actor": "urn:li:corpuser:jdoe",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "time": 1649953100653</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>In the following sections, we'll take a closer look at the purpose and structure of each supported event type.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="event-types">Event Types<a href="#event-types" class="hash-link" aria-label="Direct link to Event Types" title="Direct link to Event Types"></a></h2><p>Below, we will review the catalog of events available for consumption.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="add-tag-event">Add Tag Event<a href="#add-tag-event" class="hash-link" aria-label="Direct link to Add Tag Event" title="Direct link to Add Tag Event"></a></h3><p>This event is emitted when a Tag has been added to an entity on DataHub.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="header">Header<a href="#header" class="hash-link" aria-label="Direct link to Header" title="Direct link to Header"></a></h4><table><thead><tr><th>Category</th><th>Operation</th><th>Entity Types</th><th data-hidden="true"></th></tr></thead><tbody><tr><td>TAG</td><td>ADD</td><td><code>dataset</code>, <code>dashboard</code>, <code>chart</code>, <code>dataJob</code>, <code>container</code>, <code>dataFlow</code> , <code>schemaField</code></td><td></td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters"></a></h4><table><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Optional</th></tr></thead><tbody><tr><td>tagUrn</td><td>String</td><td>The urn of the tag that has been added.</td><td>False</td></tr><tr><td>fieldPath</td><td>String</td><td>The path of the schema field which the tag is being added to. This field is <strong>only</strong> present if the entity type is <code>schemaField</code>.</td><td>True</td></tr><tr><td>parentUrn</td><td>String</td><td>The urn of a parent entity. This field is only present if the entity type is <code>schemaField</code>, and will contain the parent Dataset to which the field belongs.</td><td>True</td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="sample-event">Sample Event<a href="#sample-event" class="hash-link" aria-label="Direct link to Sample Event" title="Direct link to Sample Event"></a></h4><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token plain">{</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityUrn": "urn:li:dataset:abc",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityType": "dataset",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "category": "TAG",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "operation": "ADD",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "modifier": "urn:li:tag:PII"</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "parameters": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "tagUrn": "urn:li:tag:PII"</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "auditStamp": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "actor": "urn:li:corpuser:jdoe",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "time": 1649953100653</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="remove-tag-event">Remove Tag Event<a href="#remove-tag-event" class="hash-link" aria-label="Direct link to Remove Tag Event" title="Direct link to Remove Tag Event"></a></h3><p>This event is emitted when a Tag has been removed from an entity on DataHub.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="header-1">Header<a href="#header-1" class="hash-link" aria-label="Direct link to Header" title="Direct link to Header"></a></h4><table><thead><tr><th>Category</th><th>Operation</th><th>Entity Types</th><th data-hidden="true"></th></tr></thead><tbody><tr><td>TAG</td><td>REMOVE</td><td><code>dataset</code>, <code>dashboard</code>, <code>chart</code>, <code>dataJob</code>, <code>container</code>, <code>dataFlow</code>, <code>schemaField</code></td><td></td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="parameters-1">Parameters<a href="#parameters-1" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters"></a></h4><table><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Optional</th></tr></thead><tbody><tr><td>tagUrn</td><td>String</td><td>The urn of the tag that has been removed.</td><td>False</td></tr><tr><td>fieldPath</td><td>String</td><td>The path of the schema field which the tag is being removed from. This field is <strong>only</strong> present if the entity type is <code>schemaField</code>.</td><td>True</td></tr><tr><td>parentUrn</td><td>String</td><td>The urn of a parent entity. This field is only present if the entity type is <code>schemaField</code>, and will contain the parent Dataset to which the field belongs.</td><td>True</td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="sample-event-1">Sample Event<a href="#sample-event-1" class="hash-link" aria-label="Direct link to Sample Event" title="Direct link to Sample Event"></a></h4><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token plain">{</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityUrn": "urn:li:dataset:abc",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityType": "dataset",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "category": "TAG",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "operation": "REMOVE",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "modifier": "urn:li:tag:PII",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "parameters": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "tagUrn": "urn:li:tag:PII"</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "auditStamp": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "actor": "urn:li:corpuser:jdoe",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "time": 1649953100653</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="add-glossary-term-event">Add Glossary Term Event<a href="#add-glossary-term-event" class="hash-link" aria-label="Direct link to Add Glossary Term Event" title="Direct link to Add Glossary Term Event"></a></h3><p>This event is emitted when a Glossary Term has been added to an entity on DataHub.</p><p><strong>Header</strong></p><table><thead><tr><th>Category</th><th>Operation</th><th>Entity Types</th><th data-hidden="true"></th></tr></thead><tbody><tr><td>GLOSSARY_TERM</td><td>ADD</td><td><code>dataset</code>, <code>dashboard</code>, <code>chart</code>, <code>dataJob</code>, <code>container</code>, <code>dataFlow</code> , <code>schemaField</code></td><td></td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="parameters-2">Parameters<a href="#parameters-2" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters"></a></h4><table><thead><tr><th>Name</th><th></th><th>Type</th><th>Description</th><th>Optional</th></tr></thead><tbody><tr><td>termUrn</td><td></td><td>String</td><td>The urn of the glossary term that has been added.</td><td>False</td></tr><tr><td>fieldPath</td><td></td><td>String</td><td>The path of the schema field to which the term is being added. This field is <strong>only</strong> present if the entity type is <code>schemaField</code>.</td><td>True</td></tr><tr><td>parentUrn</td><td></td><td>String</td><td>The urn of a parent entity. This field is only present if the entity type is <code>schemaField</code>, and will contain the parent Dataset to which the field belongs.</td><td>True</td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="sample-event-2">Sample Event<a href="#sample-event-2" class="hash-link" aria-label="Direct link to Sample Event" title="Direct link to Sample Event"></a></h4><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token plain">{</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityUrn": "urn:li:dataset:abc",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityType": "dataset",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "category": "GLOSSARY_TERM",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "operation": "ADD",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "modifier": "urn:li:glossaryTerm:ExampleNode.ExampleTerm",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "parameters": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "termUrn": "urn:li:glossaryTerm:ExampleNode.ExampleTerm"</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "auditStamp": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "actor": "urn:li:corpuser:jdoe",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "time": 1649953100653</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="remove-glossary-term-event">Remove Glossary Term Event<a href="#remove-glossary-term-event" class="hash-link" aria-label="Direct link to Remove Glossary Term Event" title="Direct link to Remove Glossary Term Event"></a></h3><p>This event is emitted when a Glossary Term has been removed from an entity on DataHub.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="header-2">Header<a href="#header-2" class="hash-link" aria-label="Direct link to Header" title="Direct link to Header"></a></h4><table><thead><tr><th>Category</th><th>Operation</th><th>Entity Types</th><th data-hidden="true"></th></tr></thead><tbody><tr><td>GLOSSARY_TERM</td><td>REMOVE</td><td><code>dataset</code>, <code>dashboard</code>, <code>chart</code>, <code>dataJob</code>, <code>container</code>, <code>dataFlow</code> , <code>schemaField</code></td><td></td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="parameters-3">Parameters<a href="#parameters-3" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters"></a></h4><table><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Optional</th></tr></thead><tbody><tr><td>termUrn</td><td>String</td><td>The urn of the glossary term that has been removed.</td><td>False</td></tr><tr><td>fieldPath</td><td>String</td><td>The path of the schema field from which the term is being removed. This field is <strong>only</strong> present if the entity type is <code>schemaField</code>.</td><td>True</td></tr><tr><td>parentUrn</td><td>String</td><td>The urn of a parent entity. This field is only present if the entity type is <code>schemaField</code>, and will contain the parent Dataset to which the field belongs.</td><td>True</td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="sample-event-3">Sample Event<a href="#sample-event-3" class="hash-link" aria-label="Direct link to Sample Event" title="Direct link to Sample Event"></a></h4><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token plain">{</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityUrn": "urn:li:dataset:abc",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityType": "dataset",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "category": "GLOSSARY_TERM",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "operation": "REMOVE",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "modifier": "urn:li:glossaryTerm:ExampleNode.ExampleTerm",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "parameters": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "termUrn": "urn:li:glossaryTerm:ExampleNode.ExampleTerm"</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "auditStamp": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "actor": "urn:li:corpuser:jdoe",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "time": 1649953100653</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="add-domain-event">Add Domain Event<a href="#add-domain-event" class="hash-link" aria-label="Direct link to Add Domain Event" title="Direct link to Add Domain Event"></a></h3><p>This event is emitted when Domain has been added to an entity on DataHub.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="header-3">Header<a href="#header-3" class="hash-link" aria-label="Direct link to Header" title="Direct link to Header"></a></h4><table><thead><tr><th>Category</th><th>Operation</th><th>Entity Types</th><th data-hidden="true"></th></tr></thead><tbody><tr><td>DOMAIN</td><td>ADD</td><td><code>dataset</code>, <code>dashboard</code>, <code>chart</code>, <code>dataJob</code>, <code>container</code>, <code>dataFlow</code> </td><td></td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="parameters-4">Parameters<a href="#parameters-4" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters"></a></h4><table><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Optional</th></tr></thead><tbody><tr><td>domainUrn</td><td>String</td><td>The urn of the domain that has been added.</td><td>False</td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="sample-event-4">Sample Event<a href="#sample-event-4" class="hash-link" aria-label="Direct link to Sample Event" title="Direct link to Sample Event"></a></h4><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token plain">{</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityUrn": "urn:li:dataset:abc",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityType": "dataset",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "category": "DOMAIN",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "operation": "ADD",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "modifier": "urn:li:domain:ExampleDomain",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "parameters": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "domainUrn": "urn:li:domain:ExampleDomain"</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "auditStamp": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "actor": "urn:li:corpuser:jdoe",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "time": 1649953100653</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="remove-domain-event">Remove Domain Event<a href="#remove-domain-event" class="hash-link" aria-label="Direct link to Remove Domain Event" title="Direct link to Remove Domain Event"></a></h3><p>This event is emitted when Domain has been removed from an entity on DataHub.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="header-4">Header<a href="#header-4" class="hash-link" aria-label="Direct link to Header" title="Direct link to Header"></a></h4><table><thead><tr><th>Category</th><th>Operation</th><th>Entity Types</th><th data-hidden="true"></th></tr></thead><tbody><tr><td>DOMAIN</td><td>REMOVE</td><td><code>dataset</code>, <code>dashboard</code>, <code>chart</code>, <code>dataJob</code>, <code>container</code> ,<code>dataFlow</code> </td><td></td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="parameters-5">Parameters<a href="#parameters-5" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters"></a></h4><table><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Optional</th></tr></thead><tbody><tr><td>domainUrn</td><td>String</td><td>The urn of the domain that has been removed.</td><td>False</td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="sample-event-5">Sample Event<a href="#sample-event-5" class="hash-link" aria-label="Direct link to Sample Event" title="Direct link to Sample Event"></a></h4><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token plain">{</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityUrn": "urn:li:dataset:abc",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityType": "dataset",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "category": "DOMAIN",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "operation": "REMOVE",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "modifier": "urn:li:domain:ExampleDomain",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "parameters": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "domainUrn": "urn:li:domain:ExampleDomain"</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "auditStamp": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "actor": "urn:li:corpuser:jdoe",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "time": 1649953100653</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="add-owner-event">Add Owner Event<a href="#add-owner-event" class="hash-link" aria-label="Direct link to Add Owner Event" title="Direct link to Add Owner Event"></a></h3><p>This event is emitted when a new owner has been assigned to an entity on DataHub.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="header-5">Header<a href="#header-5" class="hash-link" aria-label="Direct link to Header" title="Direct link to Header"></a></h4><table><thead><tr><th>Category</th><th>Operation</th><th>Entity Types</th><th data-hidden="true"></th></tr></thead><tbody><tr><td>OWNER</td><td>ADD</td><td><code>dataset</code>, <code>dashboard</code>, <code>chart</code>, <code>dataJob</code>, <code>dataFlow</code> , <code>container</code>, <code>glossaryTerm</code>, <code>domain</code>, <code>tag</code></td><td></td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="parameters-6">Parameters<a href="#parameters-6" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters"></a></h4><table><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Optional</th></tr></thead><tbody><tr><td>ownerUrn</td><td>String</td><td>The urn of the owner that has been added.</td><td>False</td></tr><tr><td>ownerType</td><td>String</td><td>The type of the owner that has been added. <code>TECHNICAL_OWNER</code>, <code>BUSINESS_OWNER</code>, <code>DATA_STEWARD</code>, <code>NONE</code>, etc.</td><td>False</td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="sample-event-6">Sample Event<a href="#sample-event-6" class="hash-link" aria-label="Direct link to Sample Event" title="Direct link to Sample Event"></a></h4><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token plain">{</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityUrn": "urn:li:dataset:abc",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityType": "dataset",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "category": "OWNER",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "operation": "ADD",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "modifier": "urn:li:corpuser:jdoe",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "parameters": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "ownerUrn": "urn:li:corpuser:jdoe",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "ownerType": "BUSINESS_OWNER"</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "auditStamp": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "actor": "urn:li:corpuser:jdoe",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "time": 1649953100653</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="remove-owner-event">Remove Owner Event<a href="#remove-owner-event" class="hash-link" aria-label="Direct link to Remove Owner Event" title="Direct link to Remove Owner Event"></a></h3><p>This event is emitted when an existing owner has been removed from an entity on DataHub.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="header-6">Header<a href="#header-6" class="hash-link" aria-label="Direct link to Header" title="Direct link to Header"></a></h4><table><thead><tr><th>Category</th><th>Operation</th><th>Entity Types</th><th data-hidden="true"></th></tr></thead><tbody><tr><td>OWNER</td><td>REMOVE</td><td><code>dataset</code>, <code>dashboard</code>, <code>chart</code>, <code>dataJob</code>, <code>container</code> ,<code>dataFlow</code> , <code>glossaryTerm</code>, <code>domain</code>, <code>tag</code></td><td></td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="parameters-7">Parameters<a href="#parameters-7" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters"></a></h4><table><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Optional</th></tr></thead><tbody><tr><td>ownerUrn</td><td>String</td><td>The urn of the owner that has been removed.</td><td>False</td></tr><tr><td>ownerType</td><td>String</td><td>The type of the owner that has been removed. <code>TECHNICAL_OWNER</code>, <code>BUSINESS_OWNER</code>, <code>DATA_STEWARD</code>, <code>NONE</code>, etc.</td><td>False</td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="sample-event-7">Sample Event<a href="#sample-event-7" class="hash-link" aria-label="Direct link to Sample Event" title="Direct link to Sample Event"></a></h4><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token plain">{</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityUrn": "urn:li:dataset:abc",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityType": "dataset",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "category": "OWNER",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "operation": "REMOVE",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "modifier": "urn:li:corpuser:jdoe",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "parameters": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "ownerUrn": "urn:li:corpuser:jdoe",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "ownerType": "BUSINESS_OWNER"</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "auditStamp": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "actor": "urn:li:corpuser:jdoe",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "time": 1649953100653</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="add-description-event">Add Description Event<a href="#add-description-event" class="hash-link" aria-label="Direct link to Add Description Event" title="Direct link to Add Description Event"></a></h3><p>This event is emitted when a description has been added to an entity on DataHub.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="header-7">Header<a href="#header-7" class="hash-link" aria-label="Direct link to Header" title="Direct link to Header"></a></h4><table><thead><tr><th>Category</th><th>Operation</th><th>Entity Types</th><th data-hidden="true"></th></tr></thead><tbody><tr><td>DOCUMENTATION</td><td>ADD</td><td><code>dataset</code>, <code>dashboard</code>, <code>chart</code>, <code>dataJob</code>, <code>dataFlow</code> , <code>container</code>, <code>glossaryTerm</code>, <code>domain</code>, <code>tag</code>, <code>schemaField</code></td><td></td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="parameters-8">Parameters<a href="#parameters-8" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters"></a></h4><table><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Optional</th></tr></thead><tbody><tr><td>description</td><td>String</td><td>The description that has been added.</td><td>False</td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="sample-event-8">Sample Event<a href="#sample-event-8" class="hash-link" aria-label="Direct link to Sample Event" title="Direct link to Sample Event"></a></h4><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token plain">{</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityUrn": "urn:li:dataset:abc",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityType": "dataset",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "category": "DOCUMENTATION",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "operation": "ADD",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "parameters": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "description": "This is a new description"</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "auditStamp": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "actor": "urn:li:corpuser:jdoe",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "time": 1706646452982</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="remove-description-event">Remove Description Event<a href="#remove-description-event" class="hash-link" aria-label="Direct link to Remove Description Event" title="Direct link to Remove Description Event"></a></h3><p>This event is emitted when an existing description has been removed from an entity on DataHub.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="header-8">Header<a href="#header-8" class="hash-link" aria-label="Direct link to Header" title="Direct link to Header"></a></h4><table><thead><tr><th>Category</th><th>Operation</th><th>Entity Types</th><th data-hidden="true"></th></tr></thead><tbody><tr><td>DOCUMENTATION</td><td>REMOVE</td><td><code>dataset</code>, <code>dashboard</code>, <code>chart</code>, <code>dataJob</code>, <code>container</code> ,<code>dataFlow</code> , <code>glossaryTerm</code>, <code>domain</code>, <code>tag</code>, <code>schemaField</code></td><td></td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="parameters-9">Parameters<a href="#parameters-9" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters"></a></h4><table><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Optional</th></tr></thead><tbody><tr><td>description</td><td>String</td><td>The description that has been removed.</td><td>False</td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="sample-event-9">Sample Event<a href="#sample-event-9" class="hash-link" aria-label="Direct link to Sample Event" title="Direct link to Sample Event"></a></h4><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token plain">{</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityUrn": "urn:li:dataset:abc",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityType": "dataset",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "category": "DOCUMENTATION",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "operation": "REMOVE",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "parameters": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "description": "This is the removed description"</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "auditStamp": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "actor": "urn:li:corpuser:jdoe",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "time": 1706646452982</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="modify-deprecation-event">Modify Deprecation Event<a href="#modify-deprecation-event" class="hash-link" aria-label="Direct link to Modify Deprecation Event" title="Direct link to Modify Deprecation Event"></a></h3><p>This event is emitted when the deprecation status of an entity has been modified on DataHub.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="header-9">Header<a href="#header-9" class="hash-link" aria-label="Direct link to Header" title="Direct link to Header"></a></h4><table><thead><tr><th>Category</th><th>Operation</th><th>Entity Types</th><th data-hidden="true"></th></tr></thead><tbody><tr><td>DEPRECATION</td><td>MODIFY</td><td><code>dataset</code>, <code>dashboard</code>, <code>chart</code>, <code>dataJob</code>, <code>dataFlow</code> , <code>container</code></td><td></td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="parameters-10">Parameters<a href="#parameters-10" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters"></a></h4><table><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Optional</th></tr></thead><tbody><tr><td>status</td><td>String</td><td>The new deprecation status of the entity, either <code>DEPRECATED</code> or <code>ACTIVE</code>.</td><td>False</td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="sample-event-10">Sample Event<a href="#sample-event-10" class="hash-link" aria-label="Direct link to Sample Event" title="Direct link to Sample Event"></a></h4><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token plain">{</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityUrn": "urn:li:dataset:abc",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityType": "dataset",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "category": "DEPRECATION",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "operation": "MODIFY",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "modifier": "DEPRECATED",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "parameters": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "status": "DEPRECATED"</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "auditStamp": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "actor": "urn:li:corpuser:jdoe",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "time": 1649953100653</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="add-dataset-schema-field-event">Add Dataset Schema Field Event<a href="#add-dataset-schema-field-event" class="hash-link" aria-label="Direct link to Add Dataset Schema Field Event" title="Direct link to Add Dataset Schema Field Event"></a></h3><p>This event is emitted when a new field has been added to a <strong>Dataset</strong> <strong>Schema</strong>.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="header-10">Header<a href="#header-10" class="hash-link" aria-label="Direct link to Header" title="Direct link to Header"></a></h4><table><thead><tr><th>Category</th><th>Operation</th><th>Entity Types</th><th data-hidden="true"></th></tr></thead><tbody><tr><td>TECHNICAL_SCHEMA</td><td>ADD</td><td><code>dataset</code></td><td></td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="parameters-11">Parameters<a href="#parameters-11" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters"></a></h4><table><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Optional</th></tr></thead><tbody><tr><td>fieldUrn</td><td>String</td><td>The urn of the new schema field.</td><td>False</td></tr><tr><td>fieldPath</td><td>String</td><td>The path of the new field. For more information about field paths, check out <a href="/docs/generated/metamodel/entities/dataset#field-paths-explained">Dataset Field Paths Explained</a></td><td>False</td></tr><tr><td>nullable</td><td>Boolean</td><td>Whether the new field is nullable.</td><td>False</td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="sample-event-11">Sample Event<a href="#sample-event-11" class="hash-link" aria-label="Direct link to Sample Event" title="Direct link to Sample Event"></a></h4><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token plain">{</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityUrn": "urn:li:dataset:abc",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityType": "dataset",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "category": "TECHNICAL_SCHEMA",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "operation": "ADD",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "modifier": "urn:li:schemaField:(urn:li:dataset:abc,newFieldName)",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "parameters": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "fieldUrn": "urn:li:schemaField:(urn:li:dataset:abc,newFieldName)",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "fieldPath": "newFieldName",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "nullable": false</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "auditStamp": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "actor": "urn:li:corpuser:jdoe",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "time": 1649953100653</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="remove-dataset-schema-field-event">Remove Dataset Schema Field Event<a href="#remove-dataset-schema-field-event" class="hash-link" aria-label="Direct link to Remove Dataset Schema Field Event" title="Direct link to Remove Dataset Schema Field Event"></a></h3><p>This event is emitted when a new field has been remove from a <strong>Dataset</strong> <strong>Schema</strong>.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="header-11">Header<a href="#header-11" class="hash-link" aria-label="Direct link to Header" title="Direct link to Header"></a></h4><table><thead><tr><th>Category</th><th>Operation</th><th>Entity Types</th><th data-hidden="true"></th></tr></thead><tbody><tr><td>TECHNICAL_SCHEMA</td><td>REMOVE</td><td><code>dataset</code></td><td></td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="parameters-12">Parameters<a href="#parameters-12" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters"></a></h4><table><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Optional</th></tr></thead><tbody><tr><td>fieldUrn</td><td>String</td><td>The urn of the removed schema field.</td><td>False</td></tr><tr><td>fieldPath</td><td>String</td><td>The path of the removed field. For more information about field paths, check out <a href="/docs/generated/metamodel/entities/dataset#field-paths-explained">Dataset Field Paths Explained</a></td><td>False</td></tr><tr><td>nullable</td><td>Boolean</td><td>Whether the removed field is nullable.</td><td>False</td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="sample-event-12">Sample Event<a href="#sample-event-12" class="hash-link" aria-label="Direct link to Sample Event" title="Direct link to Sample Event"></a></h4><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token plain">{</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityUrn": "urn:li:dataset:abc",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityType": "dataset",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "category": "TECHNICAL_SCHEMA",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "operation": "REMOVE",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "modifier": "urn:li:schemaField:(urn:li:dataset:abc,newFieldName)",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "parameters": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "fieldUrn": "urn:li:schemaField:(urn:li:dataset:abc,newFieldName)",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "fieldPath": "newFieldName",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "nullable": false</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "auditStamp": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "actor": "urn:li:corpuser:jdoe",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "time": 1649953100653</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="entity-create-event">Entity Create Event<a href="#entity-create-event" class="hash-link" aria-label="Direct link to Entity Create Event" title="Direct link to Entity Create Event"></a></h3><p>This event is emitted when a new entity has been created on DataHub.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="header-12">Header<a href="#header-12" class="hash-link" aria-label="Direct link to Header" title="Direct link to Header"></a></h4><table><thead><tr><th>Category</th><th>Operation</th><th>Entity Types</th><th data-hidden="true"></th></tr></thead><tbody><tr><td>LIFECYCLE</td><td>CREATE</td><td><code>dataset</code>, <code>dashboard</code>, <code>chart</code>, <code>dataJob</code>, <code>dataFlow</code> , <code>glossaryTerm</code>, <code>domain</code>, <code>tag</code>, <code>container</code></td><td></td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="parameters-13">Parameters<a href="#parameters-13" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters"></a></h4><p><em>None</em></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="sample-event-13">Sample Event<a href="#sample-event-13" class="hash-link" aria-label="Direct link to Sample Event" title="Direct link to Sample Event"></a></h4><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token plain">{</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityUrn": "urn:li:dataset:abc",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityType": "dataset",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "category": "LIFECYCLE",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "operation": "CREATE",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "auditStamp": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "actor": "urn:li:corpuser:jdoe",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "time": 1649953100653</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="entity-soft-delete-event">Entity Soft-Delete Event<a href="#entity-soft-delete-event" class="hash-link" aria-label="Direct link to Entity Soft-Delete Event" title="Direct link to Entity Soft-Delete Event"></a></h3><p>This event is emitted when a new entity has been soft-deleted on DataHub.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="header-13">Header<a href="#header-13" class="hash-link" aria-label="Direct link to Header" title="Direct link to Header"></a></h4><table><thead><tr><th>Category</th><th>Operation</th><th>Entity Types</th><th data-hidden="true"></th></tr></thead><tbody><tr><td>LIFECYCLE</td><td>SOFT_DELETE</td><td><code>dataset</code>, <code>dashboard</code>, <code>chart</code>, <code>dataJob</code>, <code>dataFlow</code> , <code>glossaryTerm</code>, <code>domain</code>, <code>tag</code>, <code>container</code></td><td></td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="parameters-14">Parameters<a href="#parameters-14" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters"></a></h4><p><em>None</em></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="sample-event-14">Sample Event<a href="#sample-event-14" class="hash-link" aria-label="Direct link to Sample Event" title="Direct link to Sample Event"></a></h4><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token plain">{</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityUrn": "urn:li:dataset:abc",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityType": "dataset",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "category": "LIFECYCLE",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "operation": "SOFT_DELETE",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "auditStamp": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "actor": "urn:li:corpuser:jdoe",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "time": 1649953100653</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="entity-hard-delete-event">Entity Hard-Delete Event<a href="#entity-hard-delete-event" class="hash-link" aria-label="Direct link to Entity Hard-Delete Event" title="Direct link to Entity Hard-Delete Event"></a></h3><p>This event is emitted when a new entity has been hard-deleted on DataHub.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="header-14">Header<a href="#header-14" class="hash-link" aria-label="Direct link to Header" title="Direct link to Header"></a></h4><table><thead><tr><th>Category</th><th>Operation</th><th>Entity Types</th><th data-hidden="true"></th></tr></thead><tbody><tr><td>LIFECYCLE</td><td>HARD_DELETE</td><td><code>dataset</code>, <code>dashboard</code>, <code>chart</code>, <code>dataJob</code>, <code>dataFlow</code> , <code>glossaryTerm</code>, <code>domain</code>, <code>tag</code>, <code>container</code></td><td></td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="parameters-15">Parameters<a href="#parameters-15" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters"></a></h4><p><em>None</em></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="sample-event-15">Sample Event<a href="#sample-event-15" class="hash-link" aria-label="Direct link to Sample Event" title="Direct link to Sample Event"></a></h4><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token plain">{</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityUrn": "urn:li:dataset:abc",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityType": "dataset",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "category": "LIFECYCLE",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "operation": "HARD_DELETE",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "auditStamp": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "actor": "urn:li:corpuser:jdoe",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "time": 1649953100653</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="completed-assertion-run-event">Completed Assertion Run Event<a href="#completed-assertion-run-event" class="hash-link" aria-label="Direct link to Completed Assertion Run Event" title="Direct link to Completed Assertion Run Event"></a></h3><p>This event is emitted when an Assertion has been run has succeeded on DataHub.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="header-15">Header<a href="#header-15" class="hash-link" aria-label="Direct link to Header" title="Direct link to Header"></a></h4><table><thead><tr><th>Category</th><th>Operation</th><th>Entity Types</th><th data-hidden="true"></th></tr></thead><tbody><tr><td>RUN</td><td>COMPLETED</td><td><code>assertion</code></td><td></td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="parameters-16">Parameters<a href="#parameters-16" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters"></a></h4><table><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Optional</th></tr></thead><tbody><tr><td>runResult</td><td>String</td><td>The result of the run, either <code>SUCCESS</code> or <code>FAILURE</code>.</td><td>False</td></tr><tr><td>runId</td><td>String</td><td>Native (platform-specific) identifier for this run.</td><td>False</td></tr><tr><td>aserteeUrn</td><td>String</td><td>Urn of entity on which the assertion is applicable.</td><td>False</td></tr></tbody></table><h4></h4><h4 class="anchor anchorWithStickyNavbar_LWe7" id="sample-event-16">Sample Event<a href="#sample-event-16" class="hash-link" aria-label="Direct link to Sample Event" title="Direct link to Sample Event"></a></h4><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token plain">{</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityUrn": "urn:li:assertion:abc",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityType": "assertion",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "category": "RUN",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "operation": "COMPLETED",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "parameters": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "runResult": "SUCCESS",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "runId": "123",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "asserteeUrn": "urn:li:dataset:def"</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "auditStamp": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "actor": "urn:li:corpuser:jdoe",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "time": 1649953100653</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="started-data-process-instance-run-event">Started Data Process Instance Run Event<a href="#started-data-process-instance-run-event" class="hash-link" aria-label="Direct link to Started Data Process Instance Run Event" title="Direct link to Started Data Process Instance Run Event"></a></h3><p>This event is emitted when a Data Process Instance Run has STARTED on DataHub.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="header-16">Header<a href="#header-16" class="hash-link" aria-label="Direct link to Header" title="Direct link to Header"></a></h4><table><thead><tr><th>Category</th><th>Operation</th><th>Entity Types</th><th data-hidden="true"></th></tr></thead><tbody><tr><td>RUN</td><td>STARTED</td><td><code>dataProcessInstance</code></td><td></td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="parameters-17">Parameters<a href="#parameters-17" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters"></a></h4><table><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Optional</th></tr></thead><tbody><tr><td>attempt</td><td>Integer</td><td>The number of attempts that have been made.</td><td>True</td></tr><tr><td>dataFlowUrn</td><td>String</td><td>The urn of the associated Data Flow. Only filled in if this run is associated with a Data Flow.</td><td>True</td></tr><tr><td>dataJobUrn</td><td>String</td><td>The urn of the associated Data Flow. Only filled in if this run is associated with a Data Job.</td><td>True</td></tr><tr><td>parentInstanceUrn</td><td>String</td><td>Urn of the parent DataProcessInstance (if there is one).</td><td>True</td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="sample-event-17">Sample Event<a href="#sample-event-17" class="hash-link" aria-label="Direct link to Sample Event" title="Direct link to Sample Event"></a></h4><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token plain">{</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityUrn": "urn:li:dataProcessInstance:abc",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityType": "dataProcessInstance",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "category": "RUN",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "operation": "STARTED",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "parameters": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "dataFlowUrn": "urn:li:dataFlow:def",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "attempt": "1",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "parentInstanceUrn": ""urn:li:dataProcessInstance:ghi"</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "auditStamp": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "actor": "urn:li:corpuser:jdoe",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "time": 1649953100653</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="completed-data-process-instance-run-event">Completed Data Process Instance Run Event<a href="#completed-data-process-instance-run-event" class="hash-link" aria-label="Direct link to Completed Data Process Instance Run Event" title="Direct link to Completed Data Process Instance Run Event"></a></h3><p>This event is emitted when a Data Process Instance Run has been COMPLETED on DataHub.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="header-17">Header<a href="#header-17" class="hash-link" aria-label="Direct link to Header" title="Direct link to Header"></a></h4><table><thead><tr><th>Category</th><th>Operation</th><th>Entity Types</th><th data-hidden="true"></th></tr></thead><tbody><tr><td>RUN</td><td>COMPLETED</td><td><code>dataProcessInstance</code></td><td></td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="parameters-18">Parameters<a href="#parameters-18" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters"></a></h4><table><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Optional</th></tr></thead><tbody><tr><td>runResult</td><td>String</td><td>The result of the run, one of <code>SUCCESS</code> , <code>FAILURE</code>, <code>SKIPPED</code>, or <code>UP_FOR_RETRY</code> .</td><td>False</td></tr><tr><td>attempt</td><td>Integer</td><td>The number of attempts that have been made.</td><td>True</td></tr><tr><td>dataFlowUrn</td><td>String</td><td>The urn of the associated Data Flow. Only filled in if this run is associated with a Data Flow.</td><td>True</td></tr><tr><td>dataJobUrn</td><td>String</td><td>The urn of the associated Data Flow. Only filled in if this run is associated with a Data Job.</td><td>True</td></tr><tr><td>parentInstanceUrn</td><td>String</td><td>Urn of the parent DataProcessInstance.</td><td>True</td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="sample-event-18">Sample Event<a href="#sample-event-18" class="hash-link" aria-label="Direct link to Sample Event" title="Direct link to Sample Event"></a></h4><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token plain">{</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityUrn": "urn:li:dataProcessInstance:abc",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityType": "dataProcessInstance",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "category": "RUN",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "operation": "COMPLETED",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "parameters": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "runResult": "SUCCESS"</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "attempt": "2",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "dataFlowUrn": "urn:li:dataFlow:def",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "auditStamp": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "actor": "urn:li:corpuser:jdoe",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "time": 1649953100653</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="action-request-created-event">Action Request Created Event<a href="#action-request-created-event" class="hash-link" aria-label="Direct link to Action Request Created Event" title="Direct link to Action Request Created Event"></a></h3><p>This event is emitted when a new Action Request (Metadata Proposal) has been created.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="header-18">Header<a href="#header-18" class="hash-link" aria-label="Direct link to Header" title="Direct link to Header"></a></h4><table><thead><tr><th>Category</th><th>Operation</th><th>Entity Types</th><th data-hidden="true"></th></tr></thead><tbody><tr><td>LIFECYCLE</td><td><code>CREATED</code></td><td><code>actionRequest</code></td><td></td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="parameters-19">Parameters<a href="#parameters-19" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters"></a></h4><p>These are the common parameters for all Action Request create events.</p><table><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Optional</th></tr></thead><tbody><tr><td>actionRequestType</td><td>String</td><td>The type of Action Request. One of <code>TAG_ASSOCIATION</code>, <code>TERM_ASSOCIATION</code>, <code>CREATE_GLOSSARY_NODE</code>, <code>CREATE_GLOSSARY_TERM</code>, or <code>UPDATE_DESCRIPTION.</code></td><td>False</td></tr><tr><td>resourceType</td><td>String</td><td>The type of entity this Action Request is applied on, such as <code>dataset</code>.</td><td>True</td></tr><tr><td>resourceUrn</td><td>String</td><td>The entity this Action Request is applied on.</td><td>True</td></tr><tr><td>subResourceType</td><td>String</td><td>Filled if this Action Request is applied on a sub-resource, such as a <code>schemaField</code>.</td><td>True</td></tr><tr><td>subResource</td><td>String</td><td>Identifier of the sub-resource if this proposal is applied on one.</td><td>True</td></tr></tbody></table><p>Parameters specific to different proposal types are listed below.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="tag-association-proposal-specific-parameters-and-sample-event">Tag Association Proposal Specific Parameters and Sample Event<a href="#tag-association-proposal-specific-parameters-and-sample-event" class="hash-link" aria-label="Direct link to Tag Association Proposal Specific Parameters and Sample Event" title="Direct link to Tag Association Proposal Specific Parameters and Sample Event"></a></h4><table><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Optional</th></tr></thead><tbody><tr><td>tagUrn</td><td>String</td><td>The urn of the Tag that would be applied.</td><td>False</td></tr></tbody></table><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token plain">{</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityUrn": "urn:li:actionRequest:abc",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityType": "actionRequest",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "category": "LIFECYCLE",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "operation": "CREATED",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "parameters": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "actionRequestType": "TAG_ASSOCIATION",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "resourceType": "dataset",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "resourceUrn": "urn:li:dataset:snowflakeDataset,</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "tagUrn": "urn:li:tag:Classification"</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "auditStamp": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "actor": "urn:li:corpuser:jdoe",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "time": 1649953100653</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h4 class="anchor anchorWithStickyNavbar_LWe7" id="term-association-proposal-specific-parameters-and-sample-event">Term Association Proposal Specific Parameters and Sample Event<a href="#term-association-proposal-specific-parameters-and-sample-event" class="hash-link" aria-label="Direct link to Term Association Proposal Specific Parameters and Sample Event" title="Direct link to Term Association Proposal Specific Parameters and Sample Event"></a></h4><table><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Optional</th></tr></thead><tbody><tr><td>termUrn</td><td>String</td><td>The urn of the Glossary Term that would be applied.</td><td>False</td></tr></tbody></table><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token plain">{</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityUrn": "urn:li:actionRequest:abc",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityType": "actionRequest",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "category": "LIFECYCLE",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "operation": "CREATED",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "parameters": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "actionRequestType": "TERM_ASSOCIATION",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "resourceType": "dataset",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "resourceUrn": "urn:li:dataset:snowflakeDataset,</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "termUrn": "urn:li:glossaryTerm:Classification"</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "auditStamp": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "actor": "urn:li:corpuser:jdoe",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "time": 1649953100653</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h4 class="anchor anchorWithStickyNavbar_LWe7" id="create-glossary-nodeterm-proposal-specific-parameters-and-sample-event">Create Glossary Node/Term Proposal Specific Parameters and Sample Event<a href="#create-glossary-nodeterm-proposal-specific-parameters-and-sample-event" class="hash-link" aria-label="Direct link to Create Glossary Node/Term Proposal Specific Parameters and Sample Event" title="Direct link to Create Glossary Node/Term Proposal Specific Parameters and Sample Event"></a></h4><table><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Optional</th></tr></thead><tbody><tr><td>glossaryEntityName</td><td>String</td><td>The name of the Glossary Entity that would be created.</td><td>False</td></tr><tr><td>parentNodeUrn</td><td>String</td><td>The urn of the Parent Node that would be associated with the new Glossary Entity.</td><td>True</td></tr><tr><td>description</td><td>String</td><td>The description of the new Glossary Entity.</td><td>True</td></tr></tbody></table><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token plain">{</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityUrn": "urn:li:actionRequest:abc",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityType": "actionRequest",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "category": "LIFECYCLE",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "operation": "CREATED",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "parameters": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "actionRequestType": "CREATE_GLOSSARY_TERM",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "resourceType": "glossaryNode",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "glossaryEntityName": "PII",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "parentNodeUrn": "urn:li:glossaryNode:Classification",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "description": "Personally Identifiable Information"</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "auditStamp": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "actor": "urn:li:corpuser:jdoe",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "time": 1649953100653</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h4 class="anchor anchorWithStickyNavbar_LWe7" id="update-description-proposal-specific-parameters">Update Description Proposal Specific Parameters<a href="#update-description-proposal-specific-parameters" class="hash-link" aria-label="Direct link to Update Description Proposal Specific Parameters" title="Direct link to Update Description Proposal Specific Parameters"></a></h4><table><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Optional</th></tr></thead><tbody><tr><td>description</td><td>String</td><td>The proposed updated description.</td><td>False</td></tr></tbody></table><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token plain">{</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityUrn": "urn:li:actionRequest:abc",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityType": "actionRequest",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "category": "LIFECYCLE",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "operation": "CREATED",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "parameters": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "actionRequestType": "UPDATE_DESCRIPTION",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "resourceType": "glossaryNode",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "description": "Personally Identifiable Information"</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "auditStamp": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "actor": "urn:li:corpuser:jdoe",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "time": 1649953100653</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="action-request-status-change-event">Action Request Status Change Event<a href="#action-request-status-change-event" class="hash-link" aria-label="Direct link to Action Request Status Change Event" title="Direct link to Action Request Status Change Event"></a></h3><p>This event is emitted when an existing Action Request (proposal) changes status. For example, this event will be emitted when an Action Request transitions from pending to completed.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="header-19">Header<a href="#header-19" class="hash-link" aria-label="Direct link to Header" title="Direct link to Header"></a></h4><table><thead><tr><th>Category</th><th>Operation</th><th>Entity Types</th><th data-hidden="true"></th></tr></thead><tbody><tr><td>LIFECYCLE</td><td><code>PENDING,</code> <code>COMPLETED</code></td><td><code>actionRequest</code></td><td></td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="parameters-20">Parameters<a href="#parameters-20" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters"></a></h4><p>These are the common parameters for all parameters.</p><table><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Optional</th></tr></thead><tbody><tr><td>actionRequestStatus</td><td>String</td><td>The status of the Action Request.</td><td>False</td></tr><tr><td>actionRequestResult</td><td>String</td><td>Only filled if the <code>actionRequestStatus</code> is <code>COMPLETED</code>. Either <code>ACCEPTED</code> or <code>REJECTED</code>.</td><td>True</td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="sample-event-19">Sample Event<a href="#sample-event-19" class="hash-link" aria-label="Direct link to Sample Event" title="Direct link to Sample Event"></a></h4><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token plain">{</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityUrn": "urn:li:actionRequest:abc",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityType": "actionRequest",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "category": "LIFECYCLE",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "operation": "COMPLETED",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "parameters": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "actionRequestStatus": "COMPLETED",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "actionRequestResult": "ACCEPTED"</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "auditStamp": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "actor": "urn:li:corpuser:jdoe",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "time": 1649953100653</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="incident-change-event">Incident Change Event<a href="#incident-change-event" class="hash-link" aria-label="Direct link to Incident Change Event" title="Direct link to Incident Change Event"></a></h3><p>This event is emitted when an Incident has been created or it's status changes.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="header-20">Header<a href="#header-20" class="hash-link" aria-label="Direct link to Header" title="Direct link to Header"></a></h4><table><thead><tr><th>Category</th><th>Operation</th><th>Entity Types</th><th data-hidden="true"></th></tr></thead><tbody><tr><td>INCIDENT</td><td><code>ACTIVE, </code><code>RESOLVED</code></td><td><code>incident</code></td><td></td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="parameters-21">Parameters<a href="#parameters-21" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters"></a></h4><table><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Optional</th></tr></thead><tbody><tr><td>entities</td><td>String</td><td>The list of entities associated with the incident</td><td>False</td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="sample-event-20">Sample Event<a href="#sample-event-20" class="hash-link" aria-label="Direct link to Sample Event" title="Direct link to Sample Event"></a></h4><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token plain">{</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityUrn": "urn:li:incident:16ff200a-0ac5-4a7d-bbab-d4bdb4f831f9",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entityType": "incident",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "category": "INCIDENT",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "operation": "ACTIVE",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "parameters": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "entities": "[urn:li:dataset:abc, urn:li:dataset:abc2]",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "auditStamp": {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "actor": "urn:li:corpuser:jdoe",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "time": 1649953100653</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="slackUtm_uoBr"><div class="slackUtm_uoBr"><hr>Need more help? Join the conversation in <a href="https://datahub.com/slack?utm_source=docs&utm_medium=footer&utm_campaign=docs_footer&utm_content=docs/managed-datahub/datahub-api/entity-events-api">Slack!</a></div></div><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/datahub-project/datahub/blob/master/docs/managed-datahub/datahub-api/entity-events-api.md" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_VsjB"></div></div></footer><div class="feedbackWrapper_mUHF"><div class="feedbackWidget_PX4d"><div class="feedbackButtons_wn3V"><strong>Is this page helpful?</strong><div><button class="feedbackButton_UgQs"><span role="img" aria-label="like" class="anticon anticon-like"><svg viewBox="64 64 896 896" focusable="false" data-icon="like" width="1em" height="1em" fill="currentColor" aria-hidden="true"><path d="M885.9 533.7c16.8-22.2 26.1-49.4 26.1-77.7 0-44.9-25.1-87.4-65.5-111.1a67.67 67.67 0 00-34.3-9.3H572.4l6-122.9c1.4-29.7-9.1-57.9-29.5-79.4A106.62 106.62 0 00471 99.9c-52 0-98 35-111.8 85.1l-85.9 311H144c-17.7 0-32 14.3-32 32v364c0 17.7 14.3 32 32 32h601.3c9.2 0 18.2-1.8 26.5-5.4 47.6-20.3 78.3-66.8 78.3-118.4 0-12.6-1.8-25-5.4-37 16.8-22.2 26.1-49.4 26.1-77.7 0-12.6-1.8-25-5.4-37 16.8-22.2 26.1-49.4 26.1-77.7-.2-12.6-2-25.1-5.6-37.1zM184 852V568h81v284h-81zm636.4-353l-21.9 19 13.9 25.4a56.2 56.2 0 016.9 27.3c0 16.5-7.2 32.2-19.6 43l-21.9 19 13.9 25.4a56.2 56.2 0 016.9 27.3c0 16.5-7.2 32.2-19.6 43l-21.9 19 13.9 25.4a56.2 56.2 0 016.9 27.3c0 22.4-13.2 42.6-33.6 51.8H329V564.8l99.5-360.5a44.1 44.1 0 0142.2-32.3c7.6 0 15.1 2.2 21.1 6.7 9.9 7.4 15.2 18.6 14.6 30.5l-9.6 198.4h314.4C829 418.5 840 436.9 840 456c0 16.5-7.2 32.1-19.6 43z"></path></svg></span></button><button class="feedbackButton_UgQs"><span role="img" aria-label="dislike" class="anticon anticon-dislike"><svg viewBox="64 64 896 896" focusable="false" data-icon="dislike" width="1em" height="1em" fill="currentColor" aria-hidden="true"><path d="M885.9 490.3c3.6-12 5.4-24.4 5.4-37 0-28.3-9.3-55.5-26.1-77.7 3.6-12 5.4-24.4 5.4-37 0-28.3-9.3-55.5-26.1-77.7 3.6-12 5.4-24.4 5.4-37 0-51.6-30.7-98.1-78.3-118.4a66.1 66.1 0 00-26.5-5.4H144c-17.7 0-32 14.3-32 32v364c0 17.7 14.3 32 32 32h129.3l85.8 310.8C372.9 889 418.9 924 470.9 924c29.7 0 57.4-11.8 77.9-33.4 20.5-21.5 31-49.7 29.5-79.4l-6-122.9h239.9c12.1 0 23.9-3.2 34.3-9.3 40.4-23.5 65.5-66.1 65.5-111 0-28.3-9.3-55.5-26.1-77.7zM184 456V172h81v284h-81zm627.2 160.4H496.8l9.6 198.4c.6 11.9-4.7 23.1-14.6 30.5-6.1 4.5-13.6 6.8-21.1 6.7a44.28 44.28 0 01-42.2-32.3L329 459.2V172h415.4a56.85 56.85 0 0133.6 51.8c0 9.7-2.3 18.9-6.9 27.3l-13.9 25.4 21.9 19a56.76 56.76 0 0119.6 43c0 9.7-2.3 18.9-6.9 27.3l-13.9 25.4 21.9 19a56.76 56.76 0 0119.6 43c0 9.7-2.3 18.9-6.9 27.3l-14 25.5 21.9 19a56.76 56.76 0 0119.6 43c0 19.1-11 37.5-28.8 48.4z"></path></svg></span></button></div></div></div></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/managed-datahub/remote-executor/monitoring"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Monitoring Remote Executor</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/managed-datahub/datahub-api/graphql-api/getting-started"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Getting Started</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#introduction" class="table-of-contents__link toc-highlight">Introduction</a><ul><li><a href="#supported-integrations" class="table-of-contents__link toc-highlight">Supported Integrations</a></li><li><a href="#use-cases" class="table-of-contents__link toc-highlight">Use Cases</a></li></ul></li><li><a href="#event-structure" class="table-of-contents__link toc-highlight">Event Structure</a></li><li><a href="#event-types" class="table-of-contents__link toc-highlight">Event Types</a><ul><li><a href="#add-tag-event" class="table-of-contents__link toc-highlight">Add Tag Event</a></li><li><a href="#remove-tag-event" class="table-of-contents__link toc-highlight">Remove Tag Event</a></li><li><a href="#add-glossary-term-event" class="table-of-contents__link toc-highlight">Add Glossary Term Event</a></li><li><a href="#remove-glossary-term-event" class="table-of-contents__link toc-highlight">Remove Glossary Term Event</a></li><li><a href="#add-domain-event" class="table-of-contents__link toc-highlight">Add Domain Event</a></li><li><a href="#remove-domain-event" class="table-of-contents__link toc-highlight">Remove Domain Event</a></li><li><a href="#add-owner-event" class="table-of-contents__link toc-highlight">Add Owner Event</a></li><li><a href="#remove-owner-event" class="table-of-contents__link toc-highlight">Remove Owner Event</a></li><li><a href="#add-description-event" class="table-of-contents__link toc-highlight">Add Description Event</a></li><li><a href="#remove-description-event" class="table-of-contents__link toc-highlight">Remove Description Event</a></li><li><a href="#modify-deprecation-event" class="table-of-contents__link toc-highlight">Modify Deprecation Event</a></li><li><a href="#add-dataset-schema-field-event" class="table-of-contents__link toc-highlight">Add Dataset Schema Field Event</a></li><li><a href="#remove-dataset-schema-field-event" class="table-of-contents__link toc-highlight">Remove Dataset Schema Field Event</a></li><li><a href="#entity-create-event" class="table-of-contents__link toc-highlight">Entity Create Event</a></li><li><a href="#entity-soft-delete-event" class="table-of-contents__link toc-highlight">Entity Soft-Delete Event</a></li><li><a href="#entity-hard-delete-event" class="table-of-contents__link toc-highlight">Entity Hard-Delete Event</a></li><li><a href="#completed-assertion-run-event" class="table-of-contents__link toc-highlight">Completed Assertion Run Event</a></li><li><a href="#started-data-process-instance-run-event" class="table-of-contents__link toc-highlight">Started Data Process Instance Run Event</a></li><li><a href="#completed-data-process-instance-run-event" class="table-of-contents__link toc-highlight">Completed Data Process Instance Run Event</a></li><li><a href="#action-request-created-event" class="table-of-contents__link toc-highlight">Action Request Created Event</a></li><li><a href="#action-request-status-change-event" class="table-of-contents__link toc-highlight">Action Request Status Change Event</a></li><li><a href="#incident-change-event" class="table-of-contents__link toc-highlight">Incident Change Event</a></li></ul></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/">Introduction</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/quickstart">Quickstart</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://datahub.com/slack" target="_blank" rel="noopener noreferrer" class="footer__link-item">Slack<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://www.youtube.com/channel/UC3qFQC5IiwR5fvWEqi_tJ5w" target="_blank" rel="noopener noreferrer" class="footer__link-item">YouTube<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://medium.com/datahub-project" target="_blank" rel="noopener noreferrer" class="footer__link-item">Blog<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/docs/townhalls">Town Halls</a></li><li class="footer__item"><a href="https://datahub.com/adoption-stories/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Adoption<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://demo.datahub.com/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Demo</a></li><li class="footer__item"><a href="https://feature-requests.datahubproject.io/roadmap" target="_blank" rel="noopener noreferrer" class="footer__link-item">Roadmap<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/docs/contributing">Contributing</a></li><li class="footer__item"><a href="https://github.com/datahub-project/datahub" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://feature-requests.datahubproject.io/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Feature Requests<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2015-2025 DataHub Project Authors.</div></div></div></footer></div>
|
||
<script src="/assets/js/runtime~main.b31f62e5.js"></script>
|
||
<script src="/assets/js/main.bc908355.js"></script>
|
||
</body>
|
||
</html> |