Skip to main content
Version: 1.6.0

Mutations

acceptRole​

Type: Boolean

Accept role using invite token

Arguments

NameDescription
input
AcceptRoleInput!

addBusinessAttribute​

Type: Boolean

Add Business Attribute

Arguments

NameDescription
input
AddBusinessAttributeInput!

addGroupMembers​

Type: Boolean

Add members to a group

Arguments

NameDescription
input
AddGroupMembersInput!

Type: Boolean

Add a link, or institutional memory, for a particular asset

Arguments

NameDescription
input
AddLinkInput!

addOwner​

Type: Boolean

Add an owner to a particular Entity

Arguments

NameDescription
input
AddOwnerInput!

addOwners​

Type: Boolean

Add multiple owners to a particular Entity

Arguments

NameDescription
input
AddOwnersInput!

addRelatedTerms​

Type: Boolean

Add multiple related Terms to a Glossary Term to establish relationships

Arguments

NameDescription
input
RelatedTermsInput!

addTag​

Type: Boolean

Add a tag to a particular Entity or subresource

Arguments

NameDescription
input
TagAssociationInput!

addTags​

Type: Boolean

Add multiple tags to a particular Entity or subresource

Arguments

NameDescription
input
AddTagsInput!

addTerm​

Type: Boolean

Add a glossary term to a particular Entity or subresource

Arguments

NameDescription
input
TermAssociationInput!

addTerms​

Type: Boolean

Add multiple glossary terms to a particular Entity or subresource

Arguments

NameDescription
input
AddTermsInput!

batchAddOwners​

Type: Boolean

Add owners to multiple Entities

Arguments

NameDescription
input
BatchAddOwnersInput!

batchAddTags​

Type: Boolean

Add tags to multiple Entities or subresources

Arguments

NameDescription
input
BatchAddTagsInput!

batchAddTerms​

Type: Boolean

Add glossary terms to multiple Entities or subresource

Arguments

NameDescription
input
BatchAddTermsInput!

batchAddToDataProducts​

Type: Boolean

Adds multiple assets to multiple data products (additive - preserves existing memberships). Available when multipleDataProductsPerAsset feature flag is enabled.

Arguments

NameDescription
input
BatchSetDataProductsInput!

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

NameDescription
input
BatchAssignFormInput!

batchAssignRole​

Type: Boolean

Batch assign roles to users

Arguments

NameDescription
input
BatchAssignRoleInput!

batchRemoveForm​

Type: Boolean!

Remove a form from a given list of entities.

Arguments

NameDescription
input
BatchRemoveFormInput!

batchRemoveFromDataProducts​

Type: Boolean

Removes multiple assets from multiple data products (does not affect other memberships). Available when multipleDataProductsPerAsset feature flag is enabled.

Arguments

NameDescription
input
BatchSetDataProductsInput!

Input for batch removing assets from data products

batchRemoveOwners​

Type: Boolean

Remove owners from multiple Entities

Arguments

NameDescription
input
BatchRemoveOwnersInput!

batchRemoveTags​

Type: Boolean

Remove tags from multiple Entities or subresource

Arguments

NameDescription
input
BatchRemoveTagsInput!

batchRemoveTerms​

Type: Boolean

Remove glossary terms from multiple Entities or subresource

Arguments

NameDescription
input
BatchRemoveTermsInput!

batchSetApplication​

Type: Boolean

Batch set or unset a Application to a list of entities

Arguments

NameDescription
input
BatchSetApplicationInput!

Input for batch setting application

batchSetDataProduct​

Type: Boolean

Batch set or unset a DataProduct to a list of entities

Arguments

NameDescription
input
BatchSetDataProductInput!

Input for batch setting data product

batchSetDomain​

Type: Boolean

Set domain for multiple Entities

Arguments

NameDescription
input
BatchSetDomainInput!

batchUnsetApplication​

Type: Boolean

Batch unset a specific Application from a list of entities

Arguments

NameDescription
input
BatchUnsetApplicationInput!

Input for batch unsetting application

batchUpdateDeprecation​

Type: Boolean

Updates the deprecation status for a batch of assets.

Arguments

NameDescription
input
BatchUpdateDeprecationInput!

batchUpdateSoftDeleted​

Type: Boolean

Updates the soft deleted status for a batch of assets

Arguments

NameDescription
input
BatchUpdateSoftDeletedInput!

batchUpdateStepStates​

Type: BatchUpdateStepStatesResult!

Batch update the state for a set of steps.

Arguments

NameDescription
input
BatchUpdateStepStatesInput!

cancelIngestionExecutionRequest​

Type: String

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

Arguments

NameDescription
input
CancelIngestionExecutionRequestInput!

createAccessToken​

Type: AccessToken

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

Arguments

NameDescription
input
CreateAccessTokenInput!

createApplication​

Type: Application

Create a new Application

Arguments

NameDescription
input
CreateApplicationInput!

Inputs required to create a new Application.

createBusinessAttribute​

Type: BusinessAttribute

Create Business Attribute Api

Arguments

NameDescription
input
CreateBusinessAttributeInput!

Inputs required to create a new BusinessAttribute.

createDataHubFile​

Type: CreateDataHubFileResponse!

Create a new DataHub file entity

Arguments

NameDescription
input
CreateDataHubFileInput!

createDataProduct​

Type: DataProduct

Create a new Data Product

Arguments

NameDescription
input
CreateDataProductInput!

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

NameDescription
input
CreateDocumentInput!

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

NameDescription
input
CreateDomainInput!

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

NameDescription
input
CreateDynamicFormAssignmentInput!

createERModelRelationship​

Type: ERModelRelationship

Create a ERModelRelationship

Arguments

NameDescription
input
ERModelRelationshipUpdateInput!

Input required to create a new ERModelRelationship

createForm​

Type: Form!

Create a new form based on the input

Arguments

NameDescription
input
CreateFormInput!

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

NameDescription
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

NameDescription
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

NameDescription
input
CreateGroupInput!

createIngestionExecutionRequest​

Type: String

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

Arguments

NameDescription
input
CreateIngestionExecutionRequestInput!

createIngestionSource​

Type: String

Create a new ingestion source

Arguments

NameDescription
input
UpdateIngestionSourceInput!

createInviteToken​

Type: InviteToken

Create invite token

Arguments

NameDescription
input
CreateInviteTokenInput!

createNativeUserResetToken​

Type: ResetToken

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

Arguments

NameDescription
input
CreateNativeUserResetTokenInput!

createOwnershipType​

Type: OwnershipTypeEntity

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

Arguments

NameDescription
input
CreateOwnershipTypeInput!

Inputs required to create a new Query.

createPolicy​

Type: String

Create a policy and returns the resulting urn

Arguments

NameDescription
input
PolicyUpdateInput!

createPost​

Type: Boolean

Create a post

Arguments

NameDescription
input
CreatePostInput!

createQuery​

Type: QueryEntity

Create a new Query

Arguments

NameDescription
input
CreateQueryInput!

Inputs required to create a new Query.

createSecret​

Type: String

Create a new Secret

Arguments

NameDescription
input
CreateSecretInput!

createServiceAccount​

Type: ServiceAccount!

Creates a new service account.

Arguments

NameDescription
input
CreateServiceAccountInput!

createStructuredProperty​

Type: StructuredPropertyEntity!

Create a new structured property

Arguments

NameDescription
input
CreateStructuredPropertyInput!

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

NameDescription
input
CreateTagInput!

Inputs required to create a new Tag.

createTest​

Type: String

Create a new test

Arguments

NameDescription
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

NameDescription
input
CreateTestConnectionRequestInput!

createView​

Type: DataHubView

Create a new DataHub View (Saved Filter)

Arguments

NameDescription
input
CreateViewInput!

Input required to create a new DataHub View

deleteApplication​

Type: Boolean

Delete a Application by urn.

Arguments

NameDescription
urn
String!

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

NameDescription
urn
String!

The assertion to remove

deleteBusinessAttribute​

Type: Boolean

Delete a Business Attribute by urn.

Arguments

NameDescription
urn
String!

Urn of the business attribute to remove.

deleteDataProduct​

Type: Boolean

Delete a DataProduct by urn.

Arguments

NameDescription
urn
String!

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

NameDescription
urn
String!

deleteDomain​

Type: Boolean

Delete a Domain

Arguments

NameDescription
urn
String!

The urn of the Domain to delete

deleteERModelRelationship​

Type: Boolean

Delete a ERModelRelationship

Arguments

NameDescription
urn
String!

The urn of the ERModelRelationship to delete

deleteForm​

Type: Boolean!

Delete a given form

Arguments

NameDescription
input
DeleteFormInput!

deleteGlossaryEntity​

Type: Boolean

Remove a glossary entity (GlossaryTerm or GlossaryNode). Return boolean whether it was successful or not.

Arguments

NameDescription
urn
String!

deleteIngestionSource​

Type: String

Delete an existing ingestion source

Arguments

NameDescription
urn
String!

deleteOwnershipType​

Type: Boolean

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

Arguments

NameDescription
urn
String!

Urn of the Custom Ownership Type to remove.

deleteReferences
Boolean

deletePageModule​

Type: Boolean!

Delete a DataHub page module

Arguments

NameDescription
input
DeletePageModuleInput!

deletePageTemplate​

Type: Boolean!

Delete a DataHub page template

Arguments

NameDescription
input
DeletePageTemplateInput!

deletePolicy​

Type: String

Remove an existing policy and returns the policy urn

Arguments

NameDescription
urn
String!

deletePost​

Type: Boolean

Delete a post

Arguments

NameDescription
urn
String!

deleteQuery​

Type: Boolean

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

Arguments

NameDescription
urn
String!

Urn of the query to remove.

deleteSecret​

Type: String

Delete a Secret

Arguments

NameDescription
urn
String!

deleteServiceAccount​

Type: Boolean!

Deletes a service account by URN.

Arguments

NameDescription
urn
String!

deleteStructuredProperty​

Type: Boolean!

Delete an existing structured property

Arguments

NameDescription
input
DeleteStructuredPropertyInput!

deleteTag​

Type: Boolean

Delete a Tag

Arguments

NameDescription
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

NameDescription
urn
String!

deleteView​

Type: Boolean

Delete a DataHub View (Saved Filter)

Arguments

NameDescription
urn
String!

The urn of the View to delete

linkAssetVersion​

Type: VersionSet

Link the latest versioned entity to a Version Set

Arguments

NameDescription
input
LinkVersionInput!

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

NameDescription
input
MoveDocumentInput!

moveDomain​

Type: Boolean

Moves a domain to be parented under another domain.

Arguments

NameDescription
input
MoveDomainInput!

patchEntities​

Type: [PatchEntityResult!]!

Arguments

NameDescription
input
[PatchEntityInput!]!

patchEntity​

Type: PatchEntityResult!

Arguments

NameDescription
input
PatchEntityInput!

raiseIncident​

Type: String

Create a new incident for a resource (asset)

Arguments

NameDescription
input
RaiseIncidentInput!

Input required to create a new incident

removeBusinessAttribute​

Type: Boolean

Remove Business Attribute

Arguments

NameDescription
input
AddBusinessAttributeInput!

removeGroup​

Type: Boolean

Remove a group. Requires Manage Users & Groups Platform Privilege

Arguments

NameDescription
urn
String!

removeGroupMembers​

Type: Boolean

Remove members from a group

Arguments

NameDescription
input
RemoveGroupMembersInput!

Type: Boolean

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

Arguments

NameDescription
input
RemoveLinkInput!

removeOwner​

Type: Boolean

Remove an owner from a particular Entity

Arguments

NameDescription
input
RemoveOwnerInput!

removeRelatedTerms​

Type: Boolean

Remove multiple related Terms for a Glossary Term

Arguments

NameDescription
input
RelatedTermsInput!

removeStructuredProperties​

Type: StructuredProperties!

Upsert structured properties onto a given asset

Arguments

NameDescription
input
RemoveStructuredPropertiesInput!

removeTag​

Type: Boolean

Remove a tag from a particular Entity or subresource

Arguments

NameDescription
input
TagAssociationInput!

removeTerm​

Type: Boolean

Remove a glossary term from a particular Entity or subresource

Arguments

NameDescription
input
TermAssociationInput!

removeUser​

Type: Boolean

Remove a user. Requires Manage Users & Groups Platform Privilege

Arguments

NameDescription
urn
String!

reportAssertionResult​

Type: Boolean!

Report result for an assertion

Arguments

NameDescription
urn
String!

Urn of custom assertion.

result
AssertionResultInput!

Input for reporting result of the assertion

reportOperation​

Type: String

Report a new operation for an asset

Arguments

NameDescription
input
ReportOperationInput!

Input required to report an operation

revokeAccessToken​

Type: Boolean!

Revokes access tokens.

Arguments

NameDescription
tokenId
String!

rollbackIngestion​

Type: String

Rollback a specific ingestion execution run based on its runId

Arguments

NameDescription
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

NameDescription
entityUrn
String!
domainUrn
String!

setLifecycleStage​

Type: Boolean!

Set or clear the lifecycle stage on any entity that has a Status aspect. Pass null for lifecycleStageUrn to clear the stage (publish/activate the entity). Transition rules defined on the destination stage are enforced server-side.

Arguments

NameDescription
urn
String!
lifecycleStageUrn
String

setLogicalParent​

Type: Boolean

Set or unset an entity's logical parent

Arguments

NameDescription
input
SetLogicalParentInput!

setTagColor​

Type: Boolean

Set the hex color associated with an existing Tag

Arguments

NameDescription
urn
String!
colorHex
String!

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

NameDescription
urn
String!
input
SubmitFormPromptInput!

unlinkAssetVersion​

Type: VersionSet

Unlink a versioned entity from a Version Set

Arguments

NameDescription
input
UnlinkVersionInput!

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

NameDescription
entityUrn
String!

updateApplication​

Type: Application

Update a Application

Arguments

NameDescription
urn
String!

The urn identifier for the Application to update.

input
UpdateApplicationInput!

Inputs required to create a new Application.

updateApplicationsSettings​

Type: Boolean!

Update the applications settings.

Arguments

NameDescription
input
UpdateApplicationsSettingsInput!

updateAssetSettings​

Type: AssetSettings!

Update an asset's settings

Arguments

NameDescription
input
UpdateAssetSettingsInput!

updateBusinessAttribute​

Type: BusinessAttribute

Update Business Attribute

Arguments

NameDescription
urn
String!

The urn identifier for the Business Attribute to update.

input
UpdateBusinessAttributeInput!

Inputs required to create a new Business Attribute.

updateChart​

Type: Chart

Update the metadata about a particular Chart

Arguments

NameDescription
urn
String!
input
ChartUpdateInput!

updateCorpGroupProperties​

Type: CorpGroup

Update a particular Corp Group's editable properties

Arguments

NameDescription
urn
String!
input
CorpGroupUpdateInput!

updateCorpUserProperties​

Type: CorpUser

Update a particular Corp User's editable properties

Arguments

NameDescription
urn
String!
input
CorpUserUpdateInput!

updateCorpUserViewsSettings​

Type: Boolean

Update the View-related settings for a user.

Arguments

NameDescription
input
UpdateCorpUserViewsSettingsInput!

updateDashboard​

Type: Dashboard

Update the metadata about a particular Dashboard

Arguments

NameDescription
urn
String!
input
DashboardUpdateInput!

updateDataFlow​

Type: DataFlow

Update the metadata about a particular Data Flow (Pipeline)

Arguments

NameDescription
urn
String!
input
DataFlowUpdateInput!

updateDataJob​

Type: DataJob

Update the metadata about a particular Data Job (Task)

Arguments

NameDescription
urn
String!
input
DataJobUpdateInput!

updateDataProduct​

Type: DataProduct

Update a Data Product

Arguments

NameDescription
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

NameDescription
urn
String!
input
DatasetUpdateInput!

updateDatasets​

Type: [Dataset]

Update the metadata about a batch of Datasets

Arguments

NameDescription
input
[BatchDatasetUpdateInput!]!

updateDeprecation​

Type: Boolean

Sets the Deprecation status for a Metadata Entity. Requires the Edit Deprecation status privilege for an entity.

Arguments

NameDescription
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

NameDescription
input
DescriptionUpdateInput!

updateDisplayProperties​

Type: Boolean

Update a particular entity's display properties

Arguments

NameDescription
urn
String!
input
DisplayPropertiesUpdateInput!

updateDocPropagationSettings​

Type: Boolean!

Update the doc propagation settings.

Arguments

NameDescription
input
UpdateDocPropagationSettingsInput!

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

NameDescription
input
UpdateDocumentContentsInput!

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

NameDescription
input
UpdateDocumentRelatedEntitiesInput!

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

NameDescription
input
UpdateDocumentSettingsInput!

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

NameDescription
input
UpdateDocumentStatusInput!

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

NameDescription
input
UpdateDocumentSubTypeInput!

updateEmbed​

Type: Boolean

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

Arguments

NameDescription
input
UpdateEmbedInput!

updateERModelRelationship​

Type: Boolean

Update a ERModelRelationship

Arguments

NameDescription
urn
String!

The urn of the ERModelRelationship to update

input
ERModelRelationshipUpdateInput!

Input required to update an existing DataHub View

updateForm​

Type: Form!

Update an existing form based on the input

Arguments

NameDescription
input
UpdateFormInput!

updateGlobalViewsSettings​

Type: Boolean!

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

Arguments

NameDescription
input
UpdateGlobalViewsSettingsInput!

updateIncident​

Type: Boolean

Update an existing data incident. Any fields that are omitted will simply not be updated.

Arguments

NameDescription
urn
String!

The urn for an existing incident

input
UpdateIncidentInput!

Input required to update an existing incident

updateIncidentStatus​

Type: Boolean

Update the status of an existing incident for a resource (asset)

Arguments

NameDescription
urn
String!

The urn for an existing incident

input
IncidentStatusInput!

Input required to update the state of an existing incident

updateIngestionSource​

Type: String

Update an existing ingestion source

Arguments

NameDescription
urn
String!
input
UpdateIngestionSourceInput!

updateLineage​

Type: Boolean

Update lineage for an entity

Arguments

NameDescription
input
UpdateLineageInput!

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

NameDescription
input
UpdateLinkInput!

updateName​

Type: Boolean

Updates the name of the entity.

Arguments

NameDescription
input
UpdateNameInput!

updateNotebook​

Type: Notebook

Update the metadata about a particular Notebook

Arguments

NameDescription
urn
String!
input
NotebookUpdateInput!

updateOwnershipType​

Type: OwnershipTypeEntity

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

Arguments

NameDescription
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

NameDescription
input
UpdateParentNodeInput!

updatePolicy​

Type: String

Update an existing policy and returns the resulting urn

Arguments

NameDescription
urn
String!
input
PolicyUpdateInput!

updatePost​

Type: Boolean

Update or edit a post

Arguments

NameDescription
input
UpdatePostInput!

updateQuery​

Type: QueryEntity

Update an existing Query

Arguments

NameDescription
urn
String!

The urn identifier for the query to update.

input
UpdateQueryInput!

Inputs required to update a Query.

updateSecret​

Type: String

Update a Secret

Arguments

NameDescription
input
UpdateSecretInput!

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

NameDescription
input
UpdateServiceAccountDefaultViewInput!

updateStructuredProperty​

Type: StructuredPropertyEntity!

Update an existing structured property

Arguments

NameDescription
input
UpdateStructuredPropertyInput!

updateTag​

Type: Tag

Update the information about a particular Entity Tag

Arguments

NameDescription
urn
String!
input
TagUpdateInput!

updateTest​

Type: String

Update an existing test

Arguments

NameDescription
urn
String!
input
UpdateTestInput!

updateUserHomePageSettings​

Type: Boolean

Update the HomePage-related settings for a user.

Arguments

NameDescription
input
UpdateUserHomePageSettingsInput!

updateUserSetting​

Type: Boolean

Update a user setting

Arguments

NameDescription
input
UpdateUserSettingInput!

updateUserStatus​

Type: String

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

Arguments

NameDescription
urn
String!
status
CorpUserStatus!

updateView​

Type: DataHubView

Delete a DataHub View (Saved Filter)

Arguments

NameDescription
urn
String!

The urn of the View to update

input
UpdateViewInput!

Input required to update an existing DataHub View

upsertConnection​

Type: DataHubConnection!

Upsert a particular connection. This requires the 'Manage Connections' platform privilege.

Arguments

NameDescription
input
UpsertDataHubConnectionInput!

upsertCustomAssertion​

Type: Assertion!

Upsert a Custom Assertion

Arguments

NameDescription
urn
String

Urn of custom assertion. If not provided, one will be generated.

input
UpsertCustomAssertionInput!

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

NameDescription
urn
String
input
UpsertDataContractInput!

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

NameDescription
input
UpsertLinkInput!

upsertPageModule​

Type: DataHubPageModule!

Create or update a DataHub page module

Arguments

NameDescription
input
UpsertPageModuleInput!

upsertPageTemplate​

Type: DataHubPageTemplate!

Batch update the state for a set of steps.

Arguments

NameDescription
input
UpsertPageTemplateInput!

upsertStructuredProperties​

Type: StructuredProperties!

Upsert structured properties onto a given asset

Arguments

NameDescription
input
UpsertStructuredPropertiesInput!

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

NameDescription
input
VerifyFormInput!