Mutations
acceptRole
Type: Boolean
Accept role using invite token
Arguments
Name | Description |
---|---|
inputAcceptRoleInput! |
addGroupMembers
Type: Boolean
Add members to a group
Arguments
Name | Description |
---|---|
inputAddGroupMembersInput! |
addLink
Type: Boolean
Add a link, or institutional memory, from a particular Entity
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! |
batchAssignRole
Type: Boolean
Batch assign roles to users
Arguments
Name | Description |
---|---|
inputBatchAssignRoleInput! |
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! |
batchSetDomain
Type: Boolean
Set domain for multiple Entities
Arguments
Name | Description |
---|---|
inputBatchSetDomainInput! |
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! |
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! |
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! |
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! |
createNativeUserResetToken
Type: ResetToken
Generates a token that can be shared with existing native users to reset their credentials.
Arguments
Name | Description |
---|---|
inputCreateNativeUserResetTokenInput! |
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! |
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 |
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 |
deleteDomain
Type: Boolean
Delete a Domain
Arguments
Name | Description |
---|---|
urnString! | The urn of the Domain to delete |
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! |
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! |
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 |
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! |
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! |
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! |
setTagColor
Type: Boolean
Set the hex color associated with an existing Tag
Arguments
Name | Description |
---|---|
urnString! | |
colorHexString! |
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! |
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! |
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! |
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! |
updateEmbed
Type: Boolean
Update the Embed information for a Dataset, Dashboard, or Chart.
Arguments
Name | Description |
---|---|
inputUpdateEmbedInput! |
updateGlobalViewsSettings
Type: Boolean!
Update the global settings related to the Views feature. Requires the 'Manage Global Views' Platform Privilege.
Arguments
Name | Description |
---|---|
inputUpdateGlobalViewsSettingsInput! |
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! |
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! |
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! |
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. |
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! |
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 updat an existing DataHub View |