Mutations
acceptRole
Type: Boolean
Accept role using invite token
Arguments
| Name | Description |
|---|---|
inputAcceptRoleInput! |
addBusinessAttribute
Type: Boolean
Add Business Attribute
Arguments
| Name | Description |
|---|---|
inputAddBusinessAttributeInput! |
addGroupMembers
Type: Boolean
Add members to a group
Arguments
| Name | Description |
|---|---|
inputAddGroupMembersInput! |
addLink
Type: Boolean
Add a link, or institutional memory, for a particular asset
Arguments
| Name | Description |
|---|---|
inputAddLinkInput! |
addOwner
Type: Boolean
Add an owner to a particular Entity
Arguments
| Name | Description |
|---|---|
inputAddOwnerInput! |
addOwners
Type: Boolean
Add multiple owners to a particular Entity
Arguments
| Name | Description |
|---|---|
inputAddOwnersInput! |
addRelatedTerms
Type: Boolean
Add multiple related Terms to a Glossary Term to establish relationships
Arguments
| Name | Description |
|---|---|
inputRelatedTermsInput! |
addTag
Type: Boolean
Add a tag to a particular Entity or subresource
Arguments
| Name | Description |
|---|---|
inputTagAssociationInput! |
addTags
Type: Boolean
Add multiple tags to a particular Entity or subresource
Arguments
| Name | Description |
|---|---|
inputAddTagsInput! |
addTerm
Type: Boolean
Add a glossary term to a particular Entity or subresource
Arguments
| Name | Description |
|---|---|
inputTermAssociationInput! |
addTerms
Type: Boolean
Add multiple glossary terms to a particular Entity or subresource
Arguments
| Name | Description |
|---|---|
inputAddTermsInput! |
batchAddOwners
Type: Boolean
Add owners to multiple Entities
Arguments
| Name | Description |
|---|---|
inputBatchAddOwnersInput! |
batchAddTags
Type: Boolean
Add tags to multiple Entities or subresources
Arguments
| Name | Description |
|---|---|
inputBatchAddTagsInput! |
batchAddTerms
Type: Boolean
Add glossary terms to multiple Entities or subresource
Arguments
| Name | Description |
|---|---|
inputBatchAddTermsInput! |
batchAddToDataProducts
Type: Boolean
Adds multiple assets to multiple data products (additive - preserves existing memberships). Available when multipleDataProductsPerAsset feature flag is enabled.
Arguments
| Name | Description |
|---|---|
inputBatchSetDataProductsInput! | Input for batch adding assets to data products |
batchAssignForm
Type: Boolean
Assign a form to different entities. This will be a patch by adding this form to the list of forms on an entity.
Arguments
| Name | Description |
|---|---|
inputBatchAssignFormInput! |
batchAssignRole
Type: Boolean
Batch assign roles to users
Arguments
| Name | Description |
|---|---|
inputBatchAssignRoleInput! |
batchRemoveForm
Type: Boolean!
Remove a form from a given list of entities.
Arguments
| Name | Description |
|---|---|
inputBatchRemoveFormInput! |
batchRemoveFromDataProducts
Type: Boolean
Removes multiple assets from multiple data products (does not affect other memberships). Available when multipleDataProductsPerAsset feature flag is enabled.
Arguments
| Name | Description |
|---|---|
inputBatchSetDataProductsInput! | Input for batch removing assets from data products |
batchRemoveOwners
Type: Boolean
Remove owners from multiple Entities
Arguments
| Name | Description |
|---|---|
inputBatchRemoveOwnersInput! |
batchRemoveTags
Type: Boolean
Remove tags from multiple Entities or subresource
Arguments
| Name | Description |
|---|---|
inputBatchRemoveTagsInput! |
batchRemoveTerms
Type: Boolean
Remove glossary terms from multiple Entities or subresource
Arguments
| Name | Description |
|---|---|
inputBatchRemoveTermsInput! |
batchSetApplication
Type: Boolean
Batch set or unset a Application to a list of entities
Arguments
| Name | Description |
|---|---|
inputBatchSetApplicationInput! | Input for batch setting application |
batchSetDataProduct
Type: Boolean
Batch set or unset a DataProduct to a list of entities
Arguments
| Name | Description |
|---|---|
inputBatchSetDataProductInput! | Input for batch setting data product |
batchSetDomain
Type: Boolean
Set domain for multiple Entities
Arguments
| Name | Description |
|---|---|
inputBatchSetDomainInput! |
batchUnsetApplication
Type: Boolean
Batch unset a specific Application from a list of entities
Arguments
| Name | Description |
|---|---|
inputBatchUnsetApplicationInput! | Input for batch unsetting application |
batchUpdateDeprecation
Type: Boolean
Updates the deprecation status for a batch of assets.
Arguments
| Name | Description |
|---|---|
inputBatchUpdateDeprecationInput! |
batchUpdateSoftDeleted
Type: Boolean
Updates the soft deleted status for a batch of assets
Arguments
| Name | Description |
|---|---|
inputBatchUpdateSoftDeletedInput! |
batchUpdateStepStates
Type: BatchUpdateStepStatesResult!
Batch update the state for a set of steps.
Arguments
| Name | Description |
|---|---|
inputBatchUpdateStepStatesInput! |
cancelIngestionExecutionRequest
Type: String
Cancel a running execution request, provided the urn of the original execution request
Arguments
| Name | Description |
|---|---|
inputCancelIngestionExecutionRequestInput! |
createAccessToken
Type: AccessToken
Generates an access token for DataHub APIs for a particular user & of a particular type
Arguments
| Name | Description |
|---|---|
inputCreateAccessTokenInput! |
createApplication
Type: Application
Create a new Application
Arguments
| Name | Description |
|---|---|
inputCreateApplicationInput! | Inputs required to create a new Application. |
createBusinessAttribute
Type: BusinessAttribute
Create Business Attribute Api
Arguments
| Name | Description |
|---|---|
inputCreateBusinessAttributeInput! | Inputs required to create a new BusinessAttribute. |
createDataHubFile
Type: CreateDataHubFileResponse!
Create a new DataHub file entity
Arguments
| Name | Description |
|---|---|
inputCreateDataHubFileInput! |
createDataProduct
Type: DataProduct
Create a new Data Product
Arguments
| Name | Description |
|---|---|
inputCreateDataProductInput! | Inputs required to create a new DataProduct. |
createDocument
Type: String!
Create a new Document. Returns the urn of the newly created document. Requires the CREATE_ENTITY privilege for documents or MANAGE_DOCUMENTS platform privilege.
Arguments
| Name | Description |
|---|---|
inputCreateDocumentInput! |
createDomain
Type: String
Create a new Domain. Returns the urn of the newly created Domain. Requires the 'Create Domains' or 'Manage Domains' Platform Privilege. If a Domain with the provided ID already exists, it will be overwritten.
Arguments
| Name | Description |
|---|---|
inputCreateDomainInput! |
createDynamicFormAssignment
Type: Boolean
Creates a filter for a form to apply it to certain entities. Entities that match this filter will have a given form applied to them. This feature is ONLY supported in DataHub Cloud.
Arguments
| Name | Description |
|---|---|
inputCreateDynamicFormAssignmentInput! |
createERModelRelationship
Type: ERModelRelationship
Create a ERModelRelationship
Arguments
| Name | Description |
|---|---|
inputERModelRelationshipUpdateInput! | Input required to create a new ERModelRelationship |
createForm
Type: Form!
Create a new form based on the input
Arguments
| Name | Description |
|---|---|
inputCreateFormInput! |
createGlossaryNode
Type: String
Create a new GlossaryNode. Returns the urn of the newly created GlossaryNode. If a node with the provided ID already exists, it will be overwritten.
Arguments
| Name | Description |
|---|---|
inputCreateGlossaryEntityInput! |
createGlossaryTerm
Type: String
Create a new GlossaryTerm. Returns the urn of the newly created GlossaryTerm. If a term with the provided ID already exists, it will be overwritten.
Arguments
| Name | Description |
|---|---|
inputCreateGlossaryEntityInput! |
createGlossaryTermVersion
Type: VersionSet
Create a new version of a GlossaryTerm concept: creates the term entity and links it to the specified (or a new) VersionSet. This takes several writes, not one transaction. Inputs are validated before the first write; an unexpected server error part-way through can leave the previous term linked as the first version, or the new term created but not linked. Without previousTermUrn, the new version becomes the latest right away. With previousTermUrn, the new version starts in the DRAFT lifecycle stage (if that stage applies to glossary terms), so the previous version stays the latest visible one until the new one is published. Fails before writing anything when the id is taken, when the VersionSet already holds an unpublished version newer than its latest, or when the DRAFT stage's transition policy does not allow entering it. Returns the VersionSet.
Arguments
| Name | Description |
|---|---|
inputCreateGlossaryTermVersionInput! |
createGroup
Type: String
Create a new group. Returns the urn of the newly created group. Requires the Manage Users & Groups Platform Privilege
Arguments
| Name | Description |
|---|---|
inputCreateGroupInput! |
createIngestionExecutionRequest
Type: String
Create a request to execute an ingestion job input: Input required for creating an ingestion execution request
Arguments
| Name | Description |
|---|---|
inputCreateIngestionExecutionRequestInput! |
createIngestionSource
Type: String
Create a new ingestion source
Arguments
| Name | Description |
|---|---|
inputUpdateIngestionSourceInput! |
createInviteToken
Type: InviteToken
Create invite token
Arguments
| Name | Description |
|---|---|
inputCreateInviteTokenInput! |
createLogicalModel
Type: String
Create a new logical model (a dataset on the logical platform). Returns the new dataset URN.
Arguments
| Name | Description |
|---|---|
inputCreateLogicalModelInput! |
createNativeUserResetToken
Type: ResetToken
Generates a token that can be shared with existing native users to reset their credentials.
Arguments
| Name | Description |
|---|---|
inputCreateNativeUserResetTokenInput! |
createOwnershipType
Type: OwnershipTypeEntity
Create a Custom Ownership Type. This requires the 'Manage Ownership Types' Metadata Privilege.
Arguments
| Name | Description |
|---|---|
inputCreateOwnershipTypeInput! | Inputs required to create a new Query. |
createPolicy
Type: String
Create a policy and returns the resulting urn
Arguments
| Name | Description |
|---|---|
inputPolicyUpdateInput! |
createPost
Type: Boolean
Create a post
Arguments
| Name | Description |
|---|---|
inputCreatePostInput! |
createQuery
Type: QueryEntity
Create a new Query
Arguments
| Name | Description |
|---|---|
inputCreateQueryInput! | Inputs required to create a new Query. |
createSecret
Type: String
Create a new Secret
Arguments
| Name | Description |
|---|---|
inputCreateSecretInput! |
createServiceAccount
Type: ServiceAccount!
Creates a new service account.
Arguments
| Name | Description |
|---|---|
inputCreateServiceAccountInput! |
createStructuredProperty
Type: StructuredPropertyEntity!
Create a new structured property
Arguments
| Name | Description |
|---|---|
inputCreateStructuredPropertyInput! |
createTag
Type: String
Create a new tag. Requires the 'Manage Tags' or 'Create Tags' Platform Privilege. If a Tag with the provided ID already exists, it will be overwritten.
Arguments
| Name | Description |
|---|---|
inputCreateTagInput! | Inputs required to create a new Tag. |
createTest
Type: String
Create a new test
Arguments
| Name | Description |
|---|---|
inputCreateTestInput! |
createTestConnectionRequest
Type: String
Create a request to execute a test ingestion connection job input: Input required for creating a test connection request
Arguments
| Name | Description |
|---|---|
inputCreateTestConnectionRequestInput! |
createView
Type: DataHubView
Create a new DataHub View (Saved Filter)
Arguments
| Name | Description |
|---|---|
inputCreateViewInput! | Input required to create a new DataHub View |
deleteApplication
Type: Boolean
Delete a Application by urn.
Arguments
| Name | Description |
|---|---|
urnString! | Urn of the application to remove. |
deleteAssertion
Type: Boolean
Remove an assertion associated with an entity. Requires the 'Edit Assertions' privilege on the entity.
Arguments
| Name | Description |
|---|---|
urnString! | The assertion to remove |
deleteBusinessAttribute
Type: Boolean
Delete a Business Attribute by urn.
Arguments
| Name | Description |
|---|---|
urnString! | Urn of the business attribute to remove. |
deleteDataProduct
Type: Boolean
Delete a DataProduct by urn.
Arguments
| Name | Description |
|---|---|
urnString! | Urn of the data product to remove. |
deleteDocument
Type: Boolean!
Delete a Document. Requires the GET_ENTITY privilege for the document or MANAGE_DOCUMENTS platform privilege.
Arguments
| Name | Description |
|---|---|
urnString! |
deleteDomain
Type: Boolean
Delete a Domain
Arguments
| Name | Description |
|---|---|
urnString! | The urn of the Domain to delete |
deleteForm
Type: Boolean!
Delete a given form
Arguments
| Name | Description |
|---|---|
inputDeleteFormInput! |
deleteGlossaryEntity
Type: Boolean
Remove a glossary entity (GlossaryTerm or GlossaryNode). Return boolean whether it was successful or not.
Arguments
| Name | Description |
|---|---|
urnString! |
deleteIngestionSource
Type: String
Delete an existing ingestion source
Arguments
| Name | Description |
|---|---|
urnString! |
deleteOwnershipType
Type: Boolean
Delete a Custom Ownership Type by urn. This requires the 'Manage Ownership Types' Metadata Privilege.
Arguments
| Name | Description |
|---|---|
urnString! | Urn of the Custom Ownership Type to remove. |
deleteReferencesBoolean |
deletePageModule
Type: Boolean!
Delete a DataHub page module
Arguments
| Name | Description |
|---|---|
inputDeletePageModuleInput! |
deletePageTemplate
Type: Boolean!
Delete a DataHub page template
Arguments
| Name | Description |
|---|---|
inputDeletePageTemplateInput! |
deletePolicy
Type: String
Remove an existing policy and returns the policy urn
Arguments
| Name | Description |
|---|---|
urnString! |
deletePost
Type: Boolean
Delete a post
Arguments
| Name | Description |
|---|---|
urnString! |
deleteQuery
Type: Boolean
Delete a Query by urn. This requires the 'Edit Queries' Metadata Privilege.
Arguments
| Name | Description |
|---|---|
urnString! | Urn of the query to remove. |
deleteSecret
Type: String
Delete a Secret
Arguments
| Name | Description |
|---|---|
urnString! |
deleteServiceAccount
Type: Boolean!
Deletes a service account by URN.
Arguments
| Name | Description |
|---|---|
urnString! |
deleteStructuredProperty
Type: Boolean!
Delete an existing structured property
Arguments
| Name | Description |
|---|---|
inputDeleteStructuredPropertyInput! |
deleteTag
Type: Boolean
Delete a Tag
Arguments
| Name | Description |
|---|---|
urnString! | The urn of the Tag to delete |
deleteTest
Type: Boolean
Delete an existing test - note that this will NOT delete dangling pointers until the next execution of the test.
Arguments
| Name | Description |
|---|---|
urnString! |
deleteView
Type: Boolean
Delete a DataHub View (Saved Filter)
Arguments
| Name | Description |
|---|---|
urnString! | The urn of the View to delete |
importDocumentsFromFiles
Type: ImportDocumentsResult!
Import documents from pre-parsed file contents. The caller is responsible for text extraction (e.g. reading .md/.txt as text, converting .docx via mammoth in the browser). Requires the MANAGE_DOCUMENTS platform privilege.
Arguments
| Name | Description |
|---|---|
inputImportDocumentsFromFilesInput! |
linkAssetVersion
Type: VersionSet
Link the latest versioned entity to a Version Set
Arguments
| Name | Description |
|---|---|
inputLinkVersionInput! |
linkPhysicalChild
Type: Boolean
Link a physical child dataset to a logical parent, with optional column mappings.
Arguments
| Name | Description |
|---|---|
inputLinkPhysicalChildInput! |
moveDataProduct
Type: Boolean
Moves a data product to be parented under another data product.
Arguments
| Name | Description |
|---|---|
inputMoveDataProductInput! |
moveDocument
Type: Boolean!
Move a Document to a different parent (or to root level if no parent is specified). Requires the EDIT_ENTITY_DOCS or EDIT_ENTITY privilege for the document, or MANAGE_DOCUMENTS platform privilege.
Arguments
| Name | Description |
|---|---|
inputMoveDocumentInput! |
moveDomain
Type: Boolean
Moves a domain to be parented under another domain.
Arguments
| Name | Description |
|---|---|
inputMoveDomainInput! |
patchEntities
Type: [PatchEntityResult!]!
Arguments
| Name | Description |
|---|---|
input[PatchEntityInput!]! |
patchEntity
Type: PatchEntityResult!
Arguments
| Name | Description |
|---|---|
inputPatchEntityInput! |
raiseIncident
Type: String
Create a new incident for a resource (asset)
Arguments
| Name | Description |
|---|---|
inputRaiseIncidentInput! | Input required to create a new incident |
removeBusinessAttribute
Type: Boolean
Remove Business Attribute
Arguments
| Name | Description |
|---|---|
inputAddBusinessAttributeInput! |
removeGroup
Type: Boolean
Remove a group. Requires Manage Users & Groups Platform Privilege
Arguments
| Name | Description |
|---|---|
urnString! |
removeGroupMembers
Type: Boolean
Remove members from a group
Arguments
| Name | Description |
|---|---|
inputRemoveGroupMembersInput! |
removeLink
Type: Boolean
Remove a link, or institutional memory, from a particular Entity
Arguments
| Name | Description |
|---|---|
inputRemoveLinkInput! |
removeOwner
Type: Boolean
Remove an owner from a particular Entity
Arguments
| Name | Description |
|---|---|
inputRemoveOwnerInput! |
removeRelatedTerms
Type: Boolean
Remove multiple related Terms for a Glossary Term
Arguments
| Name | Description |
|---|---|
inputRelatedTermsInput! |
removeStructuredProperties
Type: StructuredProperties!
Upsert structured properties onto a given asset
Arguments
| Name | Description |
|---|---|
inputRemoveStructuredPropertiesInput! |
removeTag
Type: Boolean
Remove a tag from a particular Entity or subresource
Arguments
| Name | Description |
|---|---|
inputTagAssociationInput! |
removeTerm
Type: Boolean
Remove a glossary term from a particular Entity or subresource
Arguments
| Name | Description |
|---|---|
inputTermAssociationInput! |
removeUser
Type: Boolean
Remove a user. Requires Manage Users & Groups Platform Privilege
Arguments
| Name | Description |
|---|---|
urnString! |
reportAssertionResult
Type: Boolean!
Report result for an assertion
Arguments
| Name | Description |
|---|---|
urnString! | Urn of custom assertion. |
resultAssertionResultInput! | Input for reporting result of the assertion |
reportOperation
Type: String
Report a new operation for an asset
Arguments
| Name | Description |
|---|---|
inputReportOperationInput! | Input required to report an operation |
revokeAccessToken
Type: Boolean!
Revokes access tokens.
Arguments
| Name | Description |
|---|---|
tokenIdString! |
rollbackIngestion
Type: String
Rollback a specific ingestion execution run based on its runId
Arguments
| Name | Description |
|---|---|
inputRollbackIngestionInput! |
setDomain
Type: Boolean
Sets the Domain for a Dataset, Chart, Dashboard, Data Flow (Pipeline), or Data Job (Task). Returns true if the Domain was successfully added, or already exists. Requires the Edit Domains privilege for the Entity.
Arguments
| Name | Description |
|---|---|
entityUrnString! | |
domainUrnString! |
setLifecycleStage
Type: Boolean!
Set or clear the lifecycle stage on any entity that has a Status aspect. Call listLifecycleStages first and choose an applicable stage with userAssignable=true. Pass null for lifecycleStageUrn to clear the stage (publish/activate the entity). Returns a BAD_REQUEST error when the destination stage's allowedPreviousStages excludes the entity's current stage.
Arguments
| Name | Description |
|---|---|
urnString! | |
lifecycleStageUrnString |
setLogicalParent
Type: Boolean
Set or unset an entity's logical parent
Arguments
| Name | Description |
|---|---|
inputSetLogicalParentInput! |
setTagColor
Type: Boolean
Set the hex color associated with an existing Tag
Arguments
| Name | Description |
|---|---|
urnString! | |
colorHexString! |
submitFormPrompt
Type: Boolean
Submit a response to a prompt from a form collecting metadata on different entities. Provide the urn of the entity you're submitting a form response as well as the required input.
Arguments
| Name | Description |
|---|---|
urnString! | |
inputSubmitFormPromptInput! |
unlinkAssetVersion
Type: VersionSet
Unlink a versioned entity from a Version Set
Arguments
| Name | Description |
|---|---|
inputUnlinkVersionInput! |
unlinkPhysicalChild
Type: Boolean
Unlink a physical child dataset from its logical parent.
Arguments
| Name | Description |
|---|---|
inputUnlinkPhysicalChildInput! |
unsetDomain
Type: Boolean
Sets the Domain for a Dataset, Chart, Dashboard, Data Flow (Pipeline), or Data Job (Task). Returns true if the Domain was successfully removed, or was already removed. Requires the Edit Domains privilege for an asset.
Arguments
| Name | Description |
|---|---|
entityUrnString! |
updateApplicationsSettings
Type: Boolean!
Update the applications settings.
Arguments
| Name | Description |
|---|---|
inputUpdateApplicationsSettingsInput! |
updateAssetSettings
Type: AssetSettings!
Update an asset's settings
Arguments
| Name | Description |
|---|---|
inputUpdateAssetSettingsInput! |
updateBusinessAttribute
Type: BusinessAttribute
Update Business Attribute
Arguments
| Name | Description |
|---|---|
urnString! | The urn identifier for the Business Attribute to update. |
inputUpdateBusinessAttributeInput! | Inputs required to create a new Business Attribute. |
updateChart
Type: Chart
Update the metadata about a particular Chart
Arguments
| Name | Description |
|---|---|
urnString! | |
inputChartUpdateInput! |
updateCorpGroupProperties
Type: CorpGroup
Update a particular Corp Group's editable properties
Arguments
| Name | Description |
|---|---|
urnString! | |
inputCorpGroupUpdateInput! |
updateCorpUserLocaleSettings
Type: Boolean
Update the locale settings for a user.
Arguments
| Name | Description |
|---|---|
inputUpdateCorpUserLocaleSettingsInput! |
updateCorpUserProperties
Type: CorpUser
Update a particular Corp User's editable properties
Arguments
| Name | Description |
|---|---|
urnString! | |
inputCorpUserUpdateInput! |
updateCorpUserViewsSettings
Type: Boolean
Update the View-related settings for a user.
Arguments
| Name | Description |
|---|---|
inputUpdateCorpUserViewsSettingsInput! |
updateDashboard
Type: Dashboard
Update the metadata about a particular Dashboard
Arguments
| Name | Description |
|---|---|
urnString! | |
inputDashboardUpdateInput! |
updateDataFlow
Type: DataFlow
Update the metadata about a particular Data Flow (Pipeline)
Arguments
| Name | Description |
|---|---|
urnString! | |
inputDataFlowUpdateInput! |
updateDataJob
Type: DataJob
Update the metadata about a particular Data Job (Task)
Arguments
| Name | Description |
|---|---|
urnString! | |
inputDataJobUpdateInput! |
updateDataProduct
Type: DataProduct
Update a Data Product
Arguments
| Name | Description |
|---|---|
urnString! | The urn identifier for the Data Product to update. |
inputUpdateDataProductInput! | Inputs required to create a new DataProduct. |
updateDataset
Type: Dataset
Update the metadata about a particular Dataset
Arguments
| Name | Description |
|---|---|
urnString! | |
inputDatasetUpdateInput! |
updateDatasets
Type: [Dataset]
Update the metadata about a batch of Datasets
Arguments
| Name | Description |
|---|---|
input[BatchDatasetUpdateInput!]! |
updateDeprecation
Type: Boolean
Sets the Deprecation status for a Metadata Entity. Requires the Edit Deprecation status privilege for an entity.
Arguments
| Name | Description |
|---|---|
inputUpdateDeprecationInput! | Input required to set deprecation for an Entity. |
updateDescription
Type: Boolean
Incubating. Updates the description of a resource. Currently only supports Dataset Schema Fields, Containers
Arguments
| Name | Description |
|---|---|
inputDescriptionUpdateInput! |
updateDisplayProperties
Type: Boolean
Update a particular entity's display properties
Arguments
| Name | Description |
|---|---|
urnString! | |
inputDisplayPropertiesUpdateInput! |
updateDocPropagationSettings
Type: Boolean!
Update the doc propagation settings.
Arguments
| Name | Description |
|---|---|
inputUpdateDocPropagationSettingsInput! |
updateDocumentContents
Type: Boolean!
Update the title or text of an existing Document. Requires the EDIT_ENTITY_DOCS or EDIT_ENTITY privilege for the document, or MANAGE_DOCUMENTS platform privilege.
Arguments
| Name | Description |
|---|---|
inputUpdateDocumentContentsInput! |
updateDocumentRelatedEntities
Type: Boolean!
Update the related entities (assets and documents) for a Document. Requires the EDIT_ENTITY_DOCS or EDIT_ENTITY privilege for the document, or MANAGE_DOCUMENTS platform privilege.
Arguments
| Name | Description |
|---|---|
inputUpdateDocumentRelatedEntitiesInput! |
updateDocumentSettings
Type: Boolean!
Update the settings of a Document (e.g., visibility in sidebar). Requires the EDIT_ENTITY_DOCS or EDIT_ENTITY privilege for the document, or MANAGE_DOCUMENTS platform privilege.
Arguments
| Name | Description |
|---|---|
inputUpdateDocumentSettingsInput! |
updateDocumentStatus
Type: Boolean!
Update the status of a Document (published/unpublished). Requires the EDIT_ENTITY_DOCS or EDIT_ENTITY privilege for the document, or MANAGE_DOCUMENTS platform privilege.
Arguments
| Name | Description |
|---|---|
inputUpdateDocumentStatusInput! |
updateDocumentSubType
Type: Boolean!
Update the sub-type of a Document (e.g., "FAQ", "Tutorial", "Runbook"). Requires the EDIT_ENTITY_DOCS or EDIT_ENTITY privilege for the document, or MANAGE_DOCUMENTS platform privilege.
Arguments
| Name | Description |
|---|---|
inputUpdateDocumentSubTypeInput! |
updateEmbed
Type: Boolean
Update the Embed information for a Dataset, Dashboard, or Chart.
Arguments
| Name | Description |
|---|---|
inputUpdateEmbedInput! |
updateERModelRelationship
Type: Boolean
Update a ERModelRelationship
Arguments
| Name | Description |
|---|---|
urnString! | The urn of the ERModelRelationship to update |
inputERModelRelationshipUpdateInput! | Input required to update an existing DataHub View |
updateForm
Type: Form!
Update an existing form based on the input
Arguments
| Name | Description |
|---|---|
inputUpdateFormInput! |
updateGlobalViewsSettings
Type: Boolean!
Update the global settings related to the Views feature. Requires the 'Manage Global Views' Platform Privilege.
Arguments
| Name | Description |
|---|---|
inputUpdateGlobalViewsSettingsInput! |
updateIncident
Type: Boolean
Patch an existing data incident. Omitted fields, and null scalar fields, remain unchanged. An empty assigneeUrns list clears assignees; priority cannot be cleared by this mutation. Use upsertIncident to apply the editor's complete field snapshot, which can clear priority.
Arguments
| Name | Description |
|---|---|
urnString! | The urn for an existing incident |
inputUpdateIncidentInput! | Input required to update an existing incident |
updateIncidentStatus
Type: Boolean
Update the status of an existing incident for a resource (asset)
Arguments
| Name | Description |
|---|---|
urnString! | The urn for an existing incident |
inputIncidentStatusInput! | Input required to update the state of an existing incident |
updateIngestionSource
Type: String
Update an existing ingestion source
Arguments
| Name | Description |
|---|---|
urnString! | |
inputUpdateIngestionSourceInput! |
updateLineage
Type: Boolean
Update lineage for an entity
Arguments
| Name | Description |
|---|---|
inputUpdateLineageInput! |
updateLink
Type: Boolean
Update a link, or institutional memory, for a particular asset. A combo of link label and url create a unique identifier for which link to update.
Arguments
| Name | Description |
|---|---|
inputUpdateLinkInput! |
updateLogicalModelSchema
Type: Boolean
Replace a logical model's columns. For a breaking change (a removed, renamed, or retyped column), only the physical-child column mappings that reference the changed column are cleared; a child keeps its link and its remaining mappings as long as at least one survives. Adds and reorders are non-breaking and never affect mappings.
Arguments
| Name | Description |
|---|---|
inputUpdateLogicalModelSchemaInput! |
updateName
Type: Boolean
Updates the name of the entity.
Arguments
| Name | Description |
|---|---|
inputUpdateNameInput! |
updateNotebook
Type: Notebook
Update the metadata about a particular Notebook
Arguments
| Name | Description |
|---|---|
urnString! | |
inputNotebookUpdateInput! |
updateOwnershipType
Type: OwnershipTypeEntity
Update an existing Query. This requires the 'Manage Ownership Types' Metadata Privilege.
Arguments
| Name | Description |
|---|---|
urnString! | The urn identifier for the custom ownership type to update. |
inputUpdateOwnershipTypeInput! | Inputs required to update an existing Custom Ownership Type. |
updateParentNode
Type: Boolean
Updates the parent node of a resource. Currently only GlossaryNodes and GlossaryTerms have parentNodes.
Arguments
| Name | Description |
|---|---|
inputUpdateParentNodeInput! |
updatePolicy
Type: String
Update an existing policy and returns the resulting urn
Arguments
| Name | Description |
|---|---|
urnString! | |
inputPolicyUpdateInput! |
updatePost
Type: Boolean
Update or edit a post
Arguments
| Name | Description |
|---|---|
inputUpdatePostInput! |
updateQuery
Type: QueryEntity
Update an existing Query
Arguments
| Name | Description |
|---|---|
urnString! | The urn identifier for the query to update. |
inputUpdateQueryInput! | Inputs required to update a Query. |
updateSecret
Type: String
Update a Secret
Arguments
| Name | Description |
|---|---|
inputUpdateSecretInput! |
updateServiceAccountDefaultView
Type: Boolean!
Sets or clears the default view for a service account. Requires the MANAGE_SERVICE_ACCOUNTS platform privilege. Pass null for defaultView to clear the current default.
Arguments
| Name | Description |
|---|---|
inputUpdateServiceAccountDefaultViewInput! |
updateStructuredProperty
Type: StructuredPropertyEntity!
Update an existing structured property
Arguments
| Name | Description |
|---|---|
inputUpdateStructuredPropertyInput! |
updateTag
Type: Tag
Update the information about a particular Entity Tag
Arguments
| Name | Description |
|---|---|
urnString! | |
inputTagUpdateInput! |
updateTest
Type: String
Update an existing test
Arguments
| Name | Description |
|---|---|
urnString! | |
inputUpdateTestInput! |
updateUserHomePageSettings
Type: Boolean
Update the HomePage-related settings for a user.
Arguments
| Name | Description |
|---|---|
inputUpdateUserHomePageSettingsInput! |
updateUserSetting
Type: Boolean
Update a user setting
Arguments
| Name | Description |
|---|---|
inputUpdateUserSettingInput! |
updateUserStatus
Type: String
Change the status of a user. Requires Manage Users & Groups Platform Privilege
Arguments
| Name | Description |
|---|---|
urnString! | |
statusCorpUserStatus! |
updateView
Type: DataHubView
Delete a DataHub View (Saved Filter)
Arguments
| Name | Description |
|---|---|
urnString! | The urn of the View to update |
inputUpdateViewInput! | Input required to update an existing DataHub View |
upsertConnection
Type: DataHubConnection!
Upsert a particular connection. This requires the 'Manage Connections' platform privilege.
Arguments
| Name | Description |
|---|---|
inputUpsertDataHubConnectionInput! |
upsertCustomAssertion
Type: Assertion!
Upsert a Custom Assertion.
Updates fully replace assertionInfo / customAssertion (same contract as native freshness / volume / field / SQL / schema assertion monitor upserts). Callers must resend any fields they want to keep; omitted optional fields are cleared.
Arguments
| Name | Description |
|---|---|
urnString | Urn of custom assertion. If not provided, one will be generated. |
inputUpsertCustomAssertionInput! | Input for upserting a custom assertion. |
upsertDataContract
Type: DataContract!
Create or update a data contract for a given dataset. Requires the "Edit Data Contract" privilege for the provided dataset.
Arguments
| Name | Description |
|---|---|
urnString | |
inputUpsertDataContractInput! |
upsertIncident
Type: Boolean
Overwrite the Incident. Nullable fields are cleared when omitted or set to null. Use updateIncident when omitted fields must remain unchanged.
Arguments
| Name | Description |
|---|---|
urnString! | The urn for an existing incident |
inputUpsertIncidentInput! | Complete editable incident state |
upsertLink
Type: Boolean
Upsert a link, or institutional memory, for a particular asset. A combo of link label and url create a unique identifier to update a link, or add a new link if no links with label/url combo are found.
Arguments
| Name | Description |
|---|---|
inputUpsertLinkInput! |
upsertPageModule
Type: DataHubPageModule!
Create or update a DataHub page module
Arguments
| Name | Description |
|---|---|
inputUpsertPageModuleInput! |
upsertPageTemplate
Type: DataHubPageTemplate!
Batch update the state for a set of steps.
Arguments
| Name | Description |
|---|---|
inputUpsertPageTemplateInput! |
upsertStructuredProperties
Type: StructuredProperties!
Upsert structured properties onto a given asset
Arguments
| Name | Description |
|---|---|
inputUpsertStructuredPropertiesInput! |
verifyForm
Type: Boolean
Verifies a form on an entity when all of the required questions on the form are complete and the form is of type VERIFICATION.
Arguments
| Name | Description |
|---|---|
inputVerifyFormInput! |