Mutations

acceptRole

Type: Boolean

Accept role using invite token

Arguments

Name	Description
input AcceptRoleInput!

addGroupMembers

Type: Boolean

Add members to a group

Arguments

Name	Description
input AddGroupMembersInput!

addLink

Type: Boolean

Add a link, or institutional memory, from a particular Entity

Arguments

Name	Description
input AddLinkInput!

addOwner

Type: Boolean

Add an owner to a particular Entity

Arguments

Name	Description
input AddOwnerInput!

addOwners

Type: Boolean

Add multiple owners to a particular Entity

Arguments

Name	Description
input AddOwnersInput!

addRelatedTerms

Type: Boolean

Add multiple related Terms to a Glossary Term to establish relationships

Arguments

Name	Description
input RelatedTermsInput!

addTag

Type: Boolean

Add a tag to a particular Entity or subresource

Arguments

Name	Description
input TagAssociationInput!

addTags

Type: Boolean

Add multiple tags to a particular Entity or subresource

Arguments

Name	Description
input AddTagsInput!

addTerm

Type: Boolean

Add a glossary term to a particular Entity or subresource

Arguments

Name	Description
input TermAssociationInput!

addTerms

Type: Boolean

Add multiple glossary terms to a particular Entity or subresource

Arguments

Name	Description
input AddTermsInput!

batchAddOwners

Type: Boolean

Add owners to multiple Entities

Arguments

Name	Description
input BatchAddOwnersInput!

batchAddTags

Type: Boolean

Add tags to multiple Entities or subresources

Arguments

Name	Description
input BatchAddTagsInput!

batchAddTerms

Type: Boolean

Add glossary terms to multiple Entities or subresource

Arguments

Name	Description
input BatchAddTermsInput!

batchAssignRole

Type: Boolean

Batch assign roles to users

Arguments

Name	Description
input BatchAssignRoleInput!

batchRemoveOwners

Type: Boolean

Remove owners from multiple Entities

Arguments

Name	Description
input BatchRemoveOwnersInput!

batchRemoveTags

Type: Boolean

Remove tags from multiple Entities or subresource

Arguments

Name	Description
input BatchRemoveTagsInput!

batchRemoveTerms

Type: Boolean

Remove glossary terms from multiple Entities or subresource

Arguments

Name	Description
input BatchRemoveTermsInput!

batchSetDataProduct

Type: Boolean

Batch set or unset a DataProduct to a list of entities

Arguments

Name	Description
input BatchSetDataProductInput!	Input for batch setting data product

batchSetDomain

Type: Boolean

Set domain for multiple Entities

Arguments

Name	Description
input BatchSetDomainInput!

batchUpdateDeprecation

Type: Boolean

Updates the deprecation status for a batch of assets.

Arguments

Name	Description
input BatchUpdateDeprecationInput!

batchUpdateSoftDeleted

Type: Boolean

Updates the soft deleted status for a batch of assets

Arguments

Name	Description
input BatchUpdateSoftDeletedInput!

batchUpdateStepStates

Type: BatchUpdateStepStatesResult!

Batch update the state for a set of steps.

Arguments

Name	Description
input BatchUpdateStepStatesInput!

cancelIngestionExecutionRequest

Type: String

Cancel a running execution request, provided the urn of the original execution request

Arguments

Name	Description
input CancelIngestionExecutionRequestInput!

createAccessToken

Type: AccessToken

Generates an access token for DataHub APIs for a particular user & of a particular type

Arguments

Name	Description
input CreateAccessTokenInput!

createDataProduct

Type: DataProduct

Create a new Data Product

Arguments

Name	Description
input CreateDataProductInput!	Inputs required to create a new DataProduct.

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
input CreateDomainInput!

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
input CreateGlossaryEntityInput!

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
input CreateGlossaryEntityInput!

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
input CreateGroupInput!

createIngestionExecutionRequest

Type: String

Create a request to execute an ingestion job input: Input required for creating an ingestion execution request

Arguments

Name	Description
input CreateIngestionExecutionRequestInput!

createIngestionSource

Type: String

Create a new ingestion source

Arguments

Name	Description
input UpdateIngestionSourceInput!

createInviteToken

Type: InviteToken

Create invite token

Arguments

Name	Description
input CreateInviteTokenInput!

createNativeUserResetToken

Type: ResetToken

Generates a token that can be shared with existing native users to reset their credentials.

Arguments

Name	Description
input CreateNativeUserResetTokenInput!

createOwnershipType

Type: OwnershipTypeEntity

Create a Custom Ownership Type. This requires the 'Manage Ownership Types' Metadata Privilege.

Arguments

Name	Description
input CreateOwnershipTypeInput!	Inputs required to create a new Query.

createPolicy

Type: String

Create a policy and returns the resulting urn

Arguments

Name	Description
input PolicyUpdateInput!

createPost

Type: Boolean

Create a post

Arguments

Name	Description
input CreatePostInput!

createQuery

Type: QueryEntity

Create a new Query

Arguments

Name	Description
input CreateQueryInput!	Inputs required to create a new Query.

createSecret

Type: String

Create a new Secret

Arguments

Name	Description
input CreateSecretInput!

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
input CreateTagInput!	Inputs required to create a new Tag.

createTest

Type: String

Create a new test

Arguments

Name	Description
input CreateTestInput!

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
input CreateTestConnectionRequestInput!

createView

Type: DataHubView

Create a new DataHub View (Saved Filter)

Arguments

Name	Description
input CreateViewInput!	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
urn String!	The assertion to remove

deleteDataProduct

Type: Boolean

Delete a DataProduct by urn.

Arguments

Name	Description
urn String!	Urn of the data product to remove.

deleteDomain

Type: Boolean

Delete a Domain

Arguments

Name	Description
urn String!	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
urn String!

deleteIngestionSource

Type: String

Delete an existing ingestion source

Arguments

Name	Description
urn String!

deleteOwnershipType

Type: Boolean

Delete a Custom Ownership Type by urn. This requires the 'Manage Ownership Types' Metadata Privilege.

Arguments

Name	Description
urn String!	Urn of the Custom Ownership Type to remove.
deleteReferences Boolean

deletePolicy

Type: String

Remove an existing policy and returns the policy urn

Arguments

Name	Description
urn String!

deletePost

Type: Boolean

Delete a post

Arguments

Name	Description
urn String!

deleteQuery

Type: Boolean

Delete a Query by urn. This requires the 'Edit Queries' Metadata Privilege.

Arguments

Name	Description
urn String!	Urn of the query to remove.

deleteSecret

Type: String

Delete a Secret

Arguments

Name	Description
urn String!

deleteTag

Type: Boolean

Delete a Tag

Arguments

Name	Description
urn String!	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
urn String!

deleteView

Type: Boolean

Delete a DataHub View (Saved Filter)

Arguments

Name	Description
urn String!	The urn of the View to delete

removeGroup

Type: Boolean

Remove a group. Requires Manage Users & Groups Platform Privilege

Arguments

Name	Description
urn String!

removeGroupMembers

Type: Boolean

Remove members from a group

Arguments

Name	Description
input RemoveGroupMembersInput!

removeLink

Type: Boolean

Remove a link, or institutional memory, from a particular Entity

Arguments

Name	Description
input RemoveLinkInput!

removeOwner

Type: Boolean

Remove an owner from a particular Entity

Arguments

Name	Description
input RemoveOwnerInput!

removeRelatedTerms

Type: Boolean

Remove multiple related Terms for a Glossary Term

Arguments

Name	Description
input RelatedTermsInput!

removeTag

Type: Boolean

Remove a tag from a particular Entity or subresource

Arguments

Name	Description
input TagAssociationInput!

removeTerm

Type: Boolean

Remove a glossary term from a particular Entity or subresource

Arguments

Name	Description
input TermAssociationInput!

removeUser

Type: Boolean

Remove a user. Requires Manage Users & Groups Platform Privilege

Arguments

Name	Description
urn String!

reportOperation

Type: String

Report a new operation for an asset

Arguments

Name	Description
input ReportOperationInput!	Input required to report an operation

revokeAccessToken

Type: Boolean!

Revokes access tokens.

Arguments

Name	Description
tokenId String!

rollbackIngestion

Type: String

Rollback a specific ingestion execution run based on its runId

Arguments

Name	Description
input RollbackIngestionInput!

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
entityUrn String!
domainUrn String!

setTagColor

Type: Boolean

Set the hex color associated with an existing Tag

Arguments

Name	Description
urn String!
colorHex String!

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
entityUrn String!

updateChart

Type: Chart

Update the metadata about a particular Chart

Arguments

Name	Description
urn String!
input ChartUpdateInput!

updateCorpGroupProperties

Type: CorpGroup

Update a particular Corp Group's editable properties

Arguments

Name	Description
urn String!
input CorpGroupUpdateInput!

updateCorpUserProperties

Type: CorpUser

Update a particular Corp User's editable properties

Arguments

Name	Description
urn String!
input CorpUserUpdateInput!

updateCorpUserViewsSettings

Type: Boolean

Update the View-related settings for a user.

Arguments

Name	Description
input UpdateCorpUserViewsSettingsInput!

updateDashboard

Type: Dashboard

Update the metadata about a particular Dashboard

Arguments

Name	Description
urn String!
input DashboardUpdateInput!

updateDataFlow

Type: DataFlow

Update the metadata about a particular Data Flow (Pipeline)

Arguments

Name	Description
urn String!
input DataFlowUpdateInput!

updateDataJob

Type: DataJob

Update the metadata about a particular Data Job (Task)

Arguments

Name	Description
urn String!
input DataJobUpdateInput!

updateDataProduct

Type: DataProduct

Update a Data Product

Arguments

Name	Description
urn String!	The urn identifier for the Data Product to update.
input UpdateDataProductInput!	Inputs required to create a new DataProduct.

updateDataset

Type: Dataset

Update the metadata about a particular Dataset

Arguments

Name	Description
urn String!
input DatasetUpdateInput!

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
input UpdateDeprecationInput!	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
input DescriptionUpdateInput!

updateEmbed

Type: Boolean

Update the Embed information for a Dataset, Dashboard, or Chart.

Arguments

Name	Description
input UpdateEmbedInput!

updateGlobalViewsSettings

Type: Boolean!

Update the global settings related to the Views feature. Requires the 'Manage Global Views' Platform Privilege.

Arguments

Name	Description
input UpdateGlobalViewsSettingsInput!

updateIngestionSource

Type: String

Update an existing ingestion source

Arguments

Name	Description
urn String!
input UpdateIngestionSourceInput!

updateLineage

Type: Boolean

Update lineage for an entity

Arguments

Name	Description
input UpdateLineageInput!

updateName

Type: Boolean

Updates the name of the entity.

Arguments

Name	Description
input UpdateNameInput!

updateNotebook

Type: Notebook

Update the metadata about a particular Notebook

Arguments

Name	Description
urn String!
input NotebookUpdateInput!

updateOwnershipType

Type: OwnershipTypeEntity

Update an existing Query. This requires the 'Manage Ownership Types' Metadata Privilege.

Arguments

Name	Description
urn String!	The urn identifier for the custom ownership type to update.
input UpdateOwnershipTypeInput!	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
input UpdateParentNodeInput!

updatePolicy

Type: String

Update an existing policy and returns the resulting urn

Arguments

Name	Description
urn String!
input PolicyUpdateInput!

updateQuery

Type: QueryEntity

Update an existing Query

Arguments

Name	Description
urn String!	The urn identifier for the query to update.
input UpdateQueryInput!	Inputs required to update a Query.

updateTag

Type: Tag

Update the information about a particular Entity Tag

Arguments

Name	Description
urn String!
input TagUpdateInput!

updateTest

Type: String

Update an existing test

Arguments

Name	Description
urn String!
input UpdateTestInput!

updateUserSetting

Type: Boolean

Update a user setting

Arguments

Name	Description
input UpdateUserSettingInput!

updateUserStatus

Type: String

Change the status of a user. Requires Manage Users & Groups Platform Privilege

Arguments

Name	Description
urn String!
status CorpUserStatus!

updateView

Type: DataHubView

Delete a DataHub View (Saved Filter)

Arguments

Name	Description
urn String!	The urn of the View to update
input UpdateViewInput!	Input required to updat an existing DataHub View