118 lines
305 KiB
HTML
Raw Normal View History

<!doctype html>
<html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-current plugin-docs plugin-id-default docs-doc-id-graphql/inputObjects" data-has-hydrated="false">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v2.4.3">
<title data-rh="true">Input objects | 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/graphql/inputObjects"><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="Input objects | DataHub"><meta data-rh="true" name="description" content="AcceptRoleInput"><meta data-rh="true" property="og:description" content="AcceptRoleInput"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.datahub.com/docs/graphql/inputObjects"><link data-rh="true" rel="alternate" href="https://docs.datahub.com/docs/graphql/inputObjects" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.datahub.com/docs/graphql/inputObjects" 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 &#39;self&#39; 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.ec69bdbc.js" as="script">
<link rel="preload" href="/assets/js/main.89423a85.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/graphql/inputObjects">Next</a></li><li><a class="dropdown__link" href="/docs/1.1.0/graphql/inputObjects">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&amp;utm_medium=header&amp;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 &#x27;What Is DataHub?&#x27;" 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 &#x27;Features&#x27;" 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 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/datahub-api/entity-events-api">DataHub 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--subli
If businessAttributeUrn is null, then it will remove the business attribute from the resource</p><p style="margin-bottom:0.4em"><strong>Arguments</strong></p><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>businessAttributeUrn<br><a href="/docs/graphql/scalars#string"><code>String!</code></a></td><td><p>The urn of the business attribute to add</p></td></tr><tr><td>resourceUrn<br><a href="/docs/graphql/inputObjects#resourcerefinput"><code>[ResourceRefInput!]!</code></a></td><td><p>resource urns to add the business attribute to</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="addgroupmembersinput">AddGroupMembersInput<a href="#addgroupmembersinput" class="hash-link" aria-label="Direct link to AddGroupMembersInput" title="Direct link to AddGroupMembersInput"></a></h2><p>Input required to add members to an external DataHub group</p><p style="margin-bottom:0.4em"><strong>Arguments</strong></p><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>groupUrn<br><a href="/docs/graphql/scalars#string"><code>String!</code></a></td><td><p>The group to add members to</p></td></tr><tr><td>userUrns<br><a href="/docs/graphql/scalars#string"><code>[String!]!</code></a></td><td><p>The members to add to the group</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="addlinkinput">AddLinkInput<a href="#addlinkinput" class="hash-link" aria-label="Direct link to AddLinkInput" title="Direct link to AddLinkInput"></a></h2><p>Input provided when adding the association between a Metadata Entity and a Link</p><p style="margin-bottom:0.4em"><strong>Arguments</strong></p><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>linkUrl<br><a href="/docs/graphql/scalars#string"><code>String!</code></a></td><td><p>The url of the link to add or remove</p></td></tr><tr><td>label<br><a href="/docs/graphql/scalars#string"><code>String!</code></a></td><td><p>A label to attach to the link</p></td></tr><tr><td>resourceUrn<br><a href="/docs/graphql/scalars#string"><code>String!</code></a></td><td><p>The urn of the resource or entity to attach the link to, for example a dataset urn</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="addnativegroupmembersinput">AddNativeGroupMembersInput<a href="#addnativegroupmembersinput" class="hash-link" aria-label="Direct link to AddNativeGroupMembersInput" title="Direct link to AddNativeGroupMembersInput"></a></h2><p>Input required to add members to a native DataHub group</p><p style="margin-bottom:0.4em"><strong>Arguments</strong></p><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>groupUrn<br><a href="/docs/graphql/scalars#string"><code>String!</code></a></td><td><p>The group to add members to</p></td></tr><tr><td>userUrns<br><a href="/docs/graphql/scalars#string"><code>[String!]!</code></a></td><td><p>The members to add to the group</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="addownerinput">AddOwnerInput<a href="#addownerinput" class="hash-link" aria-label="Direct link to AddOwnerInput" title="Direct link to AddOwnerInput"></a></h2><p>Input provided when adding the association between a Metadata Entity and an user or group owner</p><p style="margin-bottom:0.4em"><strong>Arguments</strong></p><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>ownerUrn<br><a href="/docs/graphql/scalars#string"><code>String!</code></a></td><td><p>The primary key of the Owner to add or remove</p></td></tr><tr><td>ownerEntityType<br><a href="/docs/graphql/enums#ownerentitytype"><code>OwnerEntityType!</code></a></td><td><p>The owner type, either a user or group</p></td></tr><tr><td>type<br><a href="/docs/graphql/enums#ownershiptype"><code>OwnershipType</code></a></td><td><blockquote>Deprecated: No longer supported</blockquote><p>The ownership type for the new owner. If none is provided, then a new NONE will be added. Deprecated - Use ownershipTypeUrn field instead.</p></td></tr>
Todo: this is where additional filtering would go such as start &amp; end times/versions, change types, etc</p><p style="margin-bottom:0.4em"><strong>Arguments</strong></p><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>urn<br><a href="/docs/graphql/scalars#string"><code>String!</code></a></td><td><p>The urn to fetch timeline for</p></td></tr><tr><td>changeCategories<br><a href="/docs/graphql/enums#changecategorytype"><code>[ChangeCategoryType!]</code></a></td><td><p>The change category types to filter by. If left empty, will fetch all.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="globaltagsupdate">GlobalTagsUpdate<a href="#globaltagsupdate" class="hash-link" aria-label="Direct link to GlobalTagsUpdate" title="Direct link to GlobalTagsUpdate"></a></h2><p>Deprecated, use addTag or removeTag mutation instead
Update to the Tags associated with a Metadata Entity</p><p style="margin-bottom:0.4em"><strong>Arguments</strong></p><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>tags<br><a href="/docs/graphql/inputObjects#tagassociationupdate"><code>[TagAssociationUpdate!]</code></a></td><td><p>The new set of tags</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="groupingcriterion">GroupingCriterion<a href="#groupingcriterion" class="hash-link" aria-label="Direct link to GroupingCriterion" title="Direct link to GroupingCriterion"></a></h2><p>A single grouping criterion for grouping search results</p><p style="margin-bottom:0.4em"><strong>Arguments</strong></p><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>baseEntityType<br><a href="/docs/graphql/enums#entitytype"><code>EntityType</code></a></td><td><p>The base entity type that needs to be grouped e.g. schemaField Omitting this field will result in all base entities being grouped into the groupingEntityType.</p></td></tr><tr><td>groupingEntityType<br><a href="/docs/graphql/enums#entitytype"><code>EntityType!</code></a></td><td><p>The type of entity being grouped into e.g. dataset, domain, etc.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="groupingspec">GroupingSpec<a href="#groupingspec" class="hash-link" aria-label="Direct link to GroupingSpec" title="Direct link to GroupingSpec"></a></h2><p>A grouping specification for search results.</p><p style="margin-bottom:0.4em"><strong>Arguments</strong></p><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>groupingCriteria<br><a href="/docs/graphql/inputObjects#groupingcriterion"><code>[GroupingCriterion!]</code></a></td><td><p>A list of grouping criteria for grouping search results. There is no implied order in the grouping criteria.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="iconpropertiesinput">IconPropertiesInput<a href="#iconpropertiesinput" class="hash-link" aria-label="Direct link to IconPropertiesInput" title="Direct link to IconPropertiesInput"></a></h2><p>Input for Properties describing an icon associated with an entity</p><p style="margin-bottom:0.4em"><strong>Arguments</strong></p><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>iconLibrary<br><a href="/docs/graphql/enums#iconlibrary"><code>IconLibrary</code></a></td><td><p>The source of the icon: e.g. Antd, Material, etc</p></td></tr><tr><td>name<br><a href="/docs/graphql/scalars#string"><code>String</code></a></td><td><p>The name of the icon</p></td></tr><tr><td>style<br><a href="/docs/graphql/scalars#string"><code>String</code></a></td><td><p>Any modifier for the icon, this will be library-specific, e.g. filled/outlined, etc</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="incidentsourceinput">IncidentSourceInput<a href="#incidentsourceinput" class="hash-link" aria-label="Direct link to IncidentSourceInput" title="Direct link to IncidentSourceInput"></a></h2><p>Input required to create an incident source</p><p style="margin-bottom:0.4em"><strong>Arguments</strong></p><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>type<br><a href="/docs/graphql/enums#incidentsourcetype"><code>IncidentSourceType!</code></a></td><td><p>The type of the incident source</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="incidentstatusinput">IncidentStatusInput<a href="#incidentstatusinput" class="hash-link" aria-label="Direct link to IncidentStatusInput" title="Direct link to IncidentStatusInput"></a></h2><p>Input required to create an incident status</p><p style="margin-bottom:0.4em"><strong>Arguments</strong></p><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>state<br><a href="/docs/graphql/enums#incidentstate"><code>IncidentState!</code></a></td><td><p>The state of the incident</p></td></tr><tr><td>stage<br><a href="/docs/graphql/enums#incide
TODO Add a USER or GROUP actor enum</p><p style="margin-bottom:0.4em"><strong>Arguments</strong></p><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>url<br><a href="/docs/graphql/scalars#string"><code>String!</code></a></td><td><p>Link to a document or wiki page or another internal resource</p></td></tr><tr><td>description<br><a href="/docs/graphql/scalars#string"><code>String</code></a></td><td><p>Description of the resource</p></td></tr><tr><td>author<br><a href="/docs/graphql/scalars#string"><code>String!</code></a></td><td><p>The corp user urn of the author of the metadata</p></td></tr><tr><td>createdAt<br><a href="/docs/graphql/scalars#long"><code>Long</code></a></td><td><p>The time at which this metadata was created</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="institutionalmemoryupdate">InstitutionalMemoryUpdate<a href="#institutionalmemoryupdate" class="hash-link" aria-label="Direct link to InstitutionalMemoryUpdate" title="Direct link to InstitutionalMemoryUpdate"></a></h2><p>An update for the institutional memory information for a Metadata Entity</p><p style="margin-bottom:0.4em"><strong>Arguments</strong></p><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>elements<br><a href="/docs/graphql/inputObjects#institutionalmemorymetadataupdate"><code>[InstitutionalMemoryMetadataUpdate!]!</code></a></td><td><p>The individual references in the institutional memory</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="lineageedge">LineageEdge<a href="#lineageedge" class="hash-link" aria-label="Direct link to LineageEdge" title="Direct link to LineageEdge"></a></h2><p style="margin-bottom:0.4em"><strong>Arguments</strong></p><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>downstreamUrn<br><a href="/docs/graphql/scalars#string"><code>String!</code></a></td><td><p>Urn of the source entity. This urn is downstream of the destinationUrn.</p></td></tr><tr><td>upstreamUrn<br><a href="/docs/graphql/scalars#string"><code>String!</code></a></td><td><p>Urn of the destination entity. This urn is upstream of the destinationUrn</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="lineageflags">LineageFlags<a href="#lineageflags" class="hash-link" aria-label="Direct link to LineageFlags" title="Direct link to LineageFlags"></a></h2><p>Flags to control lineage behavior</p><p style="margin-bottom:0.4em"><strong>Arguments</strong></p><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>entitiesExploredPerHopLimit<br><a href="/docs/graphql/scalars#int"><code>Int</code></a></td><td><p>Limits the number of results explored per hop, still gets all edges each time a hop happens</p></td></tr><tr><td>startTimeMillis<br><a href="/docs/graphql/scalars#long"><code>Long</code></a></td><td><p>An optional starting time to filter on</p></td></tr><tr><td>endTimeMillis<br><a href="/docs/graphql/scalars#long"><code>Long</code></a></td><td><p>An optional ending time to filter on</p></td></tr><tr><td>ignoreAsHops<br><a href="/docs/graphql/inputObjects#entitytypetoplatforms"><code>[EntityTypeToPlatforms!]</code></a></td><td><p>Map of entity types to platforms to ignore when counting hops during graph walk. Note: this can potentially cause a large amount of additional hops to occur and should be used with caution.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="lineageinput">LineageInput<a href="#lineageinput" class="hash-link" aria-label="Direct link to LineageInput" title="Direct link to LineageInput"></a></h2><p>Input for the list lineage property of an Entity</p><p style="margin-bottom:0.4em"><strong>Arguments</strong></p><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>direction<br><a href="/docs/graphql/enums#lineagedirection"><code>LineageDirection!</code></a></td><td><p>The direction of the relationship, either incoming or outgoing from the source entity</p></td></tr><tr><td>st
TODO Add a USER or GROUP actor enum</p><p style="margin-bottom:0.4em"><strong>Arguments</strong></p><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>owner<br><a href="/docs/graphql/scalars#string"><code>String!</code></a></td><td><p>The owner URN, either a corpGroup or corpuser</p></td></tr><tr><td>type<br><a href="/docs/graphql/enums#ownershiptype"><code>OwnershipType</code></a></td><td><blockquote>Deprecated: No longer supported</blockquote><p>The owner type. Deprecated - Use ownershipTypeUrn field instead.</p></td></tr><tr><td>ownershipTypeUrn<br><a href="/docs/graphql/scalars#string"><code>String</code></a></td><td><p>The urn of the ownership type entity.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="pagemoduleparamsinput">PageModuleParamsInput<a href="#pagemoduleparamsinput" class="hash-link" aria-label="Direct link to PageModuleParamsInput" title="Direct link to PageModuleParamsInput"></a></h2><p>Input for the specific parameters stored for a module</p><p style="margin-bottom:0.4em"><strong>Arguments</strong></p><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>linkParams<br><a href="/docs/graphql/inputObjects#linkmoduleparamsinput"><code>LinkModuleParamsInput</code></a></td><td><p>The params required if the module is type LINK</p></td></tr><tr><td>richTextParams<br><a href="/docs/graphql/inputObjects#richtextmoduleparamsinput"><code>RichTextModuleParamsInput</code></a></td><td><p>The params required if the module is type RICH_TEXT</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="pagetemplaterowinput">PageTemplateRowInput<a href="#pagetemplaterowinput" class="hash-link" aria-label="Direct link to PageTemplateRowInput" title="Direct link to PageTemplateRowInput"></a></h2><p>Input a row of a page template</p><p style="margin-bottom:0.4em"><strong>Arguments</strong></p><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>modules<br><a href="/docs/graphql/scalars#string"><code>[String!]!</code></a></td><td><p>A list of Page Module urns that comprise this row</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="platforminput">PlatformInput<a href="#platforminput" class="hash-link" aria-label="Direct link to PlatformInput" title="Direct link to PlatformInput"></a></h2><p>Input representing A Data Platform</p><p style="margin-bottom:0.4em"><strong>Arguments</strong></p><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>urn<br><a href="/docs/graphql/scalars#string"><code>String</code></a></td><td><p>Urn of platform</p></td></tr><tr><td>name<br><a href="/docs/graphql/scalars#string"><code>String</code></a></td><td><p>Name of platform</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="policymatchcriterioninput">PolicyMatchCriterionInput<a href="#policymatchcriterioninput" class="hash-link" aria-label="Direct link to PolicyMatchCriterionInput" title="Direct link to PolicyMatchCriterionInput"></a></h2><p>Criterion to define relationship between field and values</p><p style="margin-bottom:0.4em"><strong>Arguments</strong></p><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>field<br><a href="/docs/graphql/scalars#string"><code>String!</code></a></td><td><p>The name of the field that the criterion refers to e.g. entity_type, entity_urn, domain</p></td></tr><tr><td>values<br><a href="/docs/graphql/scalars#string"><code>[String!]!</code></a></td><td><p>Values. Matches criterion if any one of the values matches condition (OR-relationship)</p></td></tr><tr><td>condition<br><a href="/docs/graphql/enums#policymatchcondition"><code>PolicyMatchCondition!</code></a></td><td><p>The name of the field that the criterion refers to</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="policymatchfilterinput">PolicyMatchFilterInput<a href="#policymatchfilterinput" class="hash-link" aria-label="Direct link to PolicyMatchFilterInput" title="Direct l
i.e. for search pages, the query/filters. for entity pages, the entity urn and tab</p><p style="margin-bottom:0.4em"><strong>Arguments</strong></p><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>scenario<br><a href="/docs/graphql/enums#scenariotype"><code>ScenarioType!</code></a></td><td><p>Scenario in which the recommendations will be displayed</p></td></tr><tr><td>searchRequestContext<br><a href="/docs/graphql/inputObjects#searchrequestcontext"><code>SearchRequestContext</code></a></td><td><p>Additional context for defining the search page requesting recommendations</p></td></tr><tr><td>entityRequestContext<br><a href="/docs/graphql/inputObjects#entityrequestcontext"><code>EntityRequestContext</code></a></td><td><p>Additional context for defining the entity page requesting recommendations</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="relatedtermsinput">RelatedTermsInput<a href="#relatedtermsinput" class="hash-link" aria-label="Direct link to RelatedTermsInput" title="Direct link to RelatedTermsInput"></a></h2><p>Input provided when adding Terms to an asset</p><p style="margin-bottom:0.4em"><strong>Arguments</strong></p><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>urn<br><a href="/docs/graphql/scalars#string"><code>String!</code></a></td><td><p>The Glossary Term urn to add or remove this relationship to/from</p></td></tr><tr><td>termUrns<br><a href="/docs/graphql/scalars#string"><code>[String!]!</code></a></td><td><p>The primary key of the Glossary Term to add or remove</p></td></tr><tr><td>relationshipType<br><a href="/docs/graphql/enums#termrelationshiptype"><code>TermRelationshipType!</code></a></td><td><p>The type of relationship we&#x27;re adding or removing to/from for a Glossary Term</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="relationshipfieldmappinginput">RelationshipFieldMappingInput<a href="#relationshipfieldmappinginput" class="hash-link" aria-label="Direct link to RelationshipFieldMappingInput" title="Direct link to RelationshipFieldMappingInput"></a></h2><p>Details about the ERModelRelationship</p><p style="margin-bottom:0.4em"><strong>Arguments</strong></p><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>sourceField<br><a href="/docs/graphql/scalars#string"><code>String</code></a></td><td><p>Details about the ERModelRelationship</p></td></tr><tr><td>destinationField<br><a href="/docs/graphql/scalars#string"><code>String</code></a></td><td><p>Details about the ERModelRelationship</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="relationshipsinput">RelationshipsInput<a href="#relationshipsinput" class="hash-link" aria-label="Direct link to RelationshipsInput" title="Direct link to RelationshipsInput"></a></h2><p>Input for the list relationships field of an Entity</p><p style="margin-bottom:0.4em"><strong>Arguments</strong></p><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>types<br><a href="/docs/graphql/scalars#string"><code>[String!]!</code></a></td><td><p>The types of relationships to query, representing an OR</p></td></tr><tr><td>direction<br><a href="/docs/graphql/enums#relationshipdirection"><code>RelationshipDirection!</code></a></td><td><p>The direction of the relationship, either incoming or outgoing from the source entity</p></td></tr><tr><td>start<br><a href="/docs/graphql/scalars#int"><code>Int</code></a></td><td><p>The starting offset of the result set</p></td></tr><tr><td>count<br><a href="/docs/graphql/scalars#int"><code>Int</code></a></td><td><p>The number of results to be returned</p></td></tr><tr><td>includeSoftDelete<br><a href="/docs/graphql/scalars#boolean"><code>Boolean</code></a></td><td><p>Whether to include soft-deleted, related, entities</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="removegroupmembersinput">RemoveGroupMembersInput<a href="#removegroupmembersinput" class="hash-link" aria-label="Direct link to RemoveG
A tag update to be applied</p><p style="margin-bottom:0.4em"><strong>Arguments</strong></p><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>tag<br><a href="/docs/graphql/inputObjects#tagupdateinput"><code>TagUpdateInput!</code></a></td><td><p>The tag being applied</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="tagupdateinput">TagUpdateInput<a href="#tagupdateinput" class="hash-link" aria-label="Direct link to TagUpdateInput" title="Direct link to TagUpdateInput"></a></h2><p>Deprecated, use addTag or removeTag mutations instead
An update for a particular Tag entity</p><p style="margin-bottom:0.4em"><strong>Arguments</strong></p><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>urn<br><a href="/docs/graphql/scalars#string"><code>String!</code></a></td><td><p>The primary key of the Tag</p></td></tr><tr><td>name<br><a href="/docs/graphql/scalars#string"><code>String!</code></a></td><td><p>The display name of a Tag</p></td></tr><tr><td>description<br><a href="/docs/graphql/scalars#string"><code>String</code></a></td><td><p>Description of the tag</p></td></tr><tr><td>ownership<br><a href="/docs/graphql/inputObjects#ownershipupdate"><code>OwnershipUpdate</code></a></td><td><p>Ownership metadata of the tag</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="termassociationinput">TermAssociationInput<a href="#termassociationinput" class="hash-link" aria-label="Direct link to TermAssociationInput" title="Direct link to TermAssociationInput"></a></h2><p>Input provided when updating the association between a Metadata Entity and a Glossary Term</p><p style="margin-bottom:0.4em"><strong>Arguments</strong></p><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>termUrn<br><a href="/docs/graphql/scalars#string"><code>String!</code></a></td><td><p>The primary key of the Glossary Term to add or remove</p></td></tr><tr><td>resourceUrn<br><a href="/docs/graphql/scalars#string"><code>String!</code></a></td><td><p>The target Metadata Entity to add or remove the Glossary Term from</p></td></tr><tr><td>subResourceType<br><a href="/docs/graphql/enums#subresourcetype"><code>SubResourceType</code></a></td><td><p>An optional type of a sub resource to attach the Glossary Term to</p></td></tr><tr><td>subResource<br><a href="/docs/graphql/scalars#string"><code>String</code></a></td><td><p>An optional sub resource identifier to attach the Glossary Term to</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="testdefinitioninput">TestDefinitionInput<a href="#testdefinitioninput" class="hash-link" aria-label="Direct link to TestDefinitionInput" title="Direct link to TestDefinitionInput"></a></h2><p style="margin-bottom:0.4em"><strong>Arguments</strong></p><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>json<br><a href="/docs/graphql/scalars#string"><code>String</code></a></td><td><p>The string representation of the Test Deprecated! JSON representation is no longer supported.</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="typequalifierinput">TypeQualifierInput<a href="#typequalifierinput" class="hash-link" aria-label="Direct link to TypeQualifierInput" title="Direct link to TypeQualifierInput"></a></h2><p>Input for specifying specific entity types as values</p><p style="margin-bottom:0.4em"><strong>Arguments</strong></p><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>allowedTypes<br><a href="/docs/graphql/scalars#string"><code>[String!]</code></a></td><td><p>The list of allowed entity types as urns (ie. [&quot;urn:li:entityType:datahub.corpuser&quot;])</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="unlinkversioninput">UnlinkVersionInput<a href="#unlinkversioninput" class="hash-link" aria-label="Direct link to UnlinkVersionInput" title="Direct link to UnlinkVersionInput"></a></h2><p>Input for unlinking a versioned entity from a Version Set</p><p style="margin-bottom:0.4em"><strong>Arguments</strong></p><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td>versionSet<br><a href="/docs/graphql/scalars#string"><code>String</code></a></td><td><p>The target version set</p></td></tr><tr><td>unlinkedEntity<br><a href="/docs/graphql/scalars#string"><code>String</code></a></td><td><p>The target versioned entity to unlink</p></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="updateapplicationinput">UpdateApplicationInput<a href="#updateapplicationinput" class="hash-link" aria-label="Direct lin
<script src="/assets/js/runtime~main.ec69bdbc.js"></script>
<script src="/assets/js/main.89423a85.js"></script>
</body>
</html>