Input objects

AcceptRoleInput

Input provided when accepting a DataHub role using an invite token

Arguments

Name	Description
inviteToken String!	The token needed to accept the role

ActorFilterInput

Input required when creating or updating an Access Policies Determines which actors the Policy applies to

Arguments

Name	Description
users [String!]	A disjunctive set of users to apply the policy to
groups [String!]	A disjunctive set of groups to apply the policy to
resourceOwners Boolean!	Whether the filter should return TRUE for owners of a particular resource Only applies to policies of type METADATA, which have a resource associated with them
resourceOwnersTypes [String!]	Set of OwnershipTypes to apply the policy to (if resourceOwners field is set to True)
allUsers Boolean!	Whether the filter should apply to all users
allGroups Boolean!	Whether the filter should apply to all groups

AddBusinessAttributeInput

Input required to attach Business Attribute If businessAttributeUrn is null, then it will remove the business attribute from the resource

Arguments

Name	Description
businessAttributeUrn String!	The urn of the business attribute to add
resourceUrn [ResourceRefInput!]!	resource urns to add the business attribute to

AddGroupMembersInput

Input required to add members to an external DataHub group

Arguments

Name	Description
groupUrn String!	The group to add members to
userUrns [String!]!	The members to add to the group

AddLinkInput

Input provided when adding the association between a Metadata Entity and a Link

Arguments

Name	Description
linkUrl String!	The url of the link to add or remove
label String!	A label to attach to the link
resourceUrn String!	The urn of the resource or entity to attach the link to, for example a dataset urn

AddNativeGroupMembersInput

Input required to add members to a native DataHub group

Arguments

Name	Description
groupUrn String!	The group to add members to
userUrns [String!]!	The members to add to the group

AddOwnerInput

Input provided when adding the association between a Metadata Entity and an user or group owner

Arguments

Name	Description
ownerUrn String!	The primary key of the Owner to add or remove
ownerEntityType OwnerEntityType!	The owner type, either a user or group
type OwnershipType	Deprecated: No longer supported The ownership type for the new owner. If none is provided, then a new NONE will be added. Deprecated - Use ownershipTypeUrn field instead.
ownershipTypeUrn String	The urn of the ownership type entity.
resourceUrn String!	The urn of the resource or entity to attach or remove the owner from, for example a dataset urn

AddOwnersInput

Input provided when adding multiple associations between a Metadata Entity and an user or group owner

Arguments

Name	Description
owners [OwnerInput!]!	The primary key of the Owner to add or remove
resourceUrn String!	The urn of the resource or entity to attach or remove the owner from, for example a dataset urn

AddTagsInput

Input provided when adding tags to an asset

Arguments

Name	Description
tagUrns [String!]!	The primary key of the Tags
resourceUrn String!	The target Metadata Entity to add or remove the Tag to
subResourceType SubResourceType	An optional type of a sub resource to attach the Tag to
subResource String	An optional sub resource identifier to attach the Tag to

AddTermsInput

Input provided when adding Terms to an asset

Arguments

Name	Description
termUrns [String!]!	The primary key of the Glossary Term to add or remove
resourceUrn String!	The target Metadata Entity to add or remove the Glossary Term from
subResourceType SubResourceType	An optional type of a sub resource to attach the Glossary Term to
subResource String	An optional sub resource identifier to attach the Glossary Term to

AggregateAcrossEntitiesInput

Input arguments for a full text search query across entities to get aggregations

Arguments

Name	Description
types [EntityType!]	Entity types to be searched. If this is not provided, all entities will be searched.
query String!	The query string
facets [String]	The list of facets to get aggregations for. If list is empty or null, get aggregations for all facets Sub-aggregations can be specified with the unicode character ␞ (U+241E) as a delimiter between the subtypes. e.g. _entityType␞owners
orFilters [AndFilterInput!]	A list of disjunctive criterion for the filter. (or operation to combine filters)
viewUrn String	Optional - A View to apply when generating results
searchFlags SearchFlags	Flags controlling search options

AllowedValueInput

An input entry for an allowed value for a structured property

Arguments

Name	Description
stringValue String	The allowed string value if the value is of type string Either this or numberValue is required.
numberValue Float	The allowed number value if the value is of type number. Either this or stringValue is required.
description String	The description of this allowed value

AndFilterInput

A list of disjunctive criterion for the filter. (or operation to combine filters)

Arguments

Name	Description
and [FacetFilterInput!]	A list of and criteria the filter applies to the query

AspectParams

Params to configure what list of aspects should be fetched by the aspects property

Arguments

Name	Description
autoRenderOnly Boolean	Only fetch auto render aspects
aspectNames [String!]	Fetch using aspect names If absent, returns all aspects matching other inputs

AssertionResultErrorInput

Input for reporting an Error during Assertion Run

Arguments

Name	Description
type AssertionResultErrorType!	The type of error encountered
message String!	The error message with details of error encountered

AssertionResultInput

Input for reporting result of the assertion

Arguments

Name	Description
timestampMillis Long	Optional: Provide a timestamp associated with the run event. If not provided, one will be generated for you based on the current time.
type AssertionResultType!	The final result of assertion, e.g. either SUCCESS or FAILURE.
properties [StringMapEntryInput!]	Additional metadata representing about the native results of the assertion. These will be displayed alongside the result. It should be used to capture additional context that is useful for the user.
externalUrl String	Native platform URL of the Assertion Run Event
error AssertionResultErrorInput	Error details, if type is ERROR

AutoCompleteInput

Input for performing an auto completion query against a single Metadata Entity

Arguments

Name	Description
type EntityType	Entity type to be autocompleted against
query String!	The raw query string
field String	An optional entity field name to autocomplete on
limit Int	The maximum number of autocomplete results to be returned
filters [FacetFilterInput!]	Faceted filters applied to autocomplete results
orFilters [AndFilterInput!]	A list of disjunctive criterion for the filter. (or operation to combine filters)

AutoCompleteMultipleInput

Input for performing an auto completion query against a a set of Metadata Entities

Arguments

Name	Description
types [EntityType!]	Entity types to be autocompleted against Optional, if none supplied, all searchable types will be autocompleted against
query String!	The raw query string
field String	An optional field to autocomplete against
limit Int	The maximum number of autocomplete results
filters [FacetFilterInput!]	Faceted filters applied to autocomplete results
orFilters [AndFilterInput!]	A list of disjunctive criterion for the filter. (or operation to combine filters)
viewUrn String	Optional - A View to apply when generating results

BatchAddOwnersInput

Input provided when adding owners to a batch of assets

Arguments

Name	Description
owners [OwnerInput!]!	The primary key of the owners
ownershipTypeUrn String	The ownership type to remove, optional. By default will remove regardless of ownership type.
resources [ResourceRefInput]!	The target assets to attach the owners to

BatchAddTagsInput

Input provided when adding tags to a batch of assets

Arguments

Name	Description
tagUrns [String!]!	The primary key of the Tags
resources [ResourceRefInput!]!	The target assets to attach the tags to

BatchAddTermsInput

Input provided when adding glossary terms to a batch of assets

Arguments

Name	Description
termUrns [String!]!	The primary key of the Glossary Terms
resources [ResourceRefInput]!	The target assets to attach the glossary terms to

BatchAssignFormInput

Input for batch assigning a form to different entities

Arguments

Name	Description
formUrn String!	The urn of the form being assigned to entities
entityUrns [String!]!	The entities that this form is being assigned to

BatchAssignRoleInput

Input provided when batch assigning a role to a list of users

Arguments

Name	Description
roleUrn String	The urn of the role to assign to the actors. If undefined, will remove the role.
actors [String!]!	The urns of the actors to assign the role to

BatchDatasetUpdateInput

Arguments provided to batch update Dataset entities

Arguments

Name	Description
urn String!	Primary key of the Dataset to which the update will be applied
update DatasetUpdateInput!	Arguments provided to update the Dataset

BatchGetStepStatesInput

Input arguments required for fetching step states

Arguments

Name	Description
ids [String!]!	The unique ids for the steps to retrieve

BatchRemoveFormInput

Input for batch removing a form from different entities

Arguments

Name	Description
formUrn String!	The urn of the form being removed from entities
entityUrns [String!]!	The entities that this form is being removed from

BatchRemoveOwnersInput

Input provided when removing owners from a batch of assets

Arguments

Name	Description
ownerUrns [String!]!	The primary key of the owners
ownershipTypeUrn String	The ownership type to remove, optional. By default will remove regardless of ownership type.
resources [ResourceRefInput]!	The target assets to remove the owners from

BatchRemoveTagsInput

Input provided when removing tags from a batch of assets

Arguments

Name	Description
tagUrns [String!]!	The primary key of the Tags
resources [ResourceRefInput]!	The target assets to remove the tags from

BatchRemoveTermsInput

Input provided when removing glossary terms from a batch of assets

Arguments

Name	Description
termUrns [String!]!	The primary key of the Glossary Terms
resources [ResourceRefInput]!	The target assets to remove the glossary terms from

BatchSetDataProductInput

Input properties required for batch setting a DataProduct on other entities

Arguments

Name	Description
dataProductUrn String	The urn of the data product you are setting on a group of resources. If this is null, the Data Product will be unset for the given resources.
resourceUrns [String!]!	The urns of the entities the given data product should be set on

BatchSetDomainInput

Input provided when adding tags to a batch of assets

Arguments

Name	Description
domainUrn String	The primary key of the Domain, or null if the domain will be unset
resources [ResourceRefInput!]!	The target assets to attach the Domain

BatchUpdateDeprecationInput

Input provided when updating the deprecation status for a batch of assets.

Arguments

Name	Description
deprecated Boolean!	Whether the Entity is marked as deprecated.
decommissionTime Long	Optional - The time user plan to decommission this entity
note String	Optional - Additional information about the entity deprecation plan
resources [ResourceRefInput]!	The target assets to attach the tags to

BatchUpdateSoftDeletedInput

Input provided when updating the soft-deleted status for a batch of assets

Arguments

Name	Description
urns [String!]!	The urns of the assets to soft delete
deleted Boolean!	Whether to mark the asset as soft-deleted (hidden)

BatchUpdateStepStatesInput

Input arguments required for updating step states

Arguments

Name	Description
states [StepStateInput!]!	Set of step states. If the id does not exist, it will be created.

BrowseInput

Input required for browse queries

Arguments

Name	Description
type EntityType!	The browse entity type
path [String!]	The browse path
start Int	The starting point of paginated results
count Int	The number of elements included in the results
filters [FacetFilterInput!]	Deprecated: Use `orFilters`- they are more expressive Deprecated in favor of the more expressive orFilters field Facet filters to apply to search results. These will be 'AND'-ed together.
orFilters [AndFilterInput!]	A list of disjunctive criterion for the filter. (or operation to combine filters)

BrowsePathsInput

Inputs for fetching the browse paths for a Metadata Entity

Arguments

Name	Description
type EntityType!	The browse entity type
urn String!	The entity urn

BrowseV2Input

Input required for browse queries

Arguments

Name	Description
type EntityType	The browse entity type - deprecated use types instead
types [EntityType!]	The browse entity type - deprecated use types instead. If not provided, all types will be used.
path [String!]	The browse path V2 - a list with each entry being part of the browse path V2
start Int	The starting point of paginated results
count Int	The number of elements included in the results
orFilters [AndFilterInput!]	A list of disjunctive criterion for the filter. (or operation to combine filters)
viewUrn String	Optional - A View to apply when generating results
query String	The search query string
searchFlags SearchFlags	Flags controlling search options

BusinessAttributeInfoInput

Arguments

Name	Description
name String!	name of the business attribute
description String	description of business attribute
type SchemaFieldDataType	Platform independent field type of the field

CancelIngestionExecutionRequestInput

Input for cancelling an execution request input

Arguments

Name	Description
ingestionSourceUrn String!	Urn of the ingestion source
executionRequestUrn String!	Urn of the specific execution request to cancel

ChartEditablePropertiesUpdate

Update to writable Chart fields

Arguments

Name	Description
description String!	Writable description aka documentation for a Chart

ChartUpdateInput

Arguments provided to update a Chart Entity

Arguments

Name	Description
ownership OwnershipUpdate	Update to ownership
globalTags GlobalTagsUpdate	Deprecated, use tags field instead Update to global tags
tags GlobalTagsUpdate	Update to tags
editableProperties ChartEditablePropertiesUpdate	Update to editable properties

ContainerEntitiesInput

Input required to fetch the entities inside of a container.

Arguments

Name	Description
query String	Optional query filter for particular entities inside the container
start Int	The offset of the result set
count Int	The number of entities to include in result set
filters [FacetFilterInput!]	Optional Facet filters to apply to the result set

CorpGroupUpdateInput

Arguments provided to update a CorpGroup Entity

Arguments

Name	Description
description String	DataHub description of the group
slack String	Slack handle for the group
email String	Email address for the group
pictureLink String	A URL which points to a picture which user wants to set as a profile photo

CorpUserUpdateInput

Arguments provided to update a CorpUser Entity

Arguments

Name	Description
displayName String	Display name to show on DataHub
title String	Title to show on DataHub
aboutMe String	About me section of the user
teams [String!]	Teams that the user belongs to
skills [String!]	Skills that the user possesses
pictureLink String	A URL which points to a picture which user wants to set as a profile photo
slack String	The slack handle of the user
phone String	Phone number for the user
email String	Email address for the user
platformUrns [String!]	The platforms that the user frequently works with
personaUrn String	The user's persona urn"

CreateAccessTokenInput

Arguments

Name	Description
type AccessTokenType!	The type of the Access Token.
actorUrn String!	The actor associated with the Access Token.
duration AccessTokenDuration!	The duration for which the Access Token is valid.
name String!	The name of the token to be generated.
description String	Description of the token if defined.

CreateBusinessAttributeInput

Input required for creating a BusinessAttribute.

Arguments

Name	Description
id String	Optional! A custom id to use as the primary key identifier. If not provided, a random UUID will be generated as the id.
name String!	name of the business attribute
description String	description of business attribute
type SchemaFieldDataType	Platform independent field type of the field

CreateDataProductInput

Input required for creating a DataProduct.

Arguments

Name	Description
properties CreateDataProductPropertiesInput!	Properties about the Query
domainUrn String!	The primary key of the Domain
id String	An optional id for the new data product

CreateDataProductPropertiesInput

Input properties required for creating a DataProduct

Arguments

Name	Description
name String!	A display name for the DataProduct
description String	An optional description for the DataProduct

CreateDomainInput

Input required to create a new Domain.

Arguments

Name	Description
id String	Optional! A custom id to use as the primary key identifier for the domain. If not provided, a random UUID will be generated as the id.
name String!	Display name for the Domain
description String	Optional description for the Domain
parentDomain String	Optional parent domain urn for the domain

CreateDynamicFormAssignmentInput

Input for batch assigning a form to different entities

Arguments

Name	Description
formUrn String!	The urn of the form being assigned to entities that match some criteria
orFilters [AndFilterInput!]!	A list of disjunctive criterion for the filter. (or operation to combine filters). Entities that match this filter will have this form applied to them. Currently, we only support a set of fields to filter on and they are: (1) platform (2) subType (3) container (4) _entityType (5) domain

CreateFormInput

Input for batch removing a form from different entities

Arguments

Name	Description
id String	Advanced: Optionally provide an ID to create a form urn from
name String!	The name of the form being created
description String	The optional description of the form being created
type FormType	The type of this form, whether it's verification or completion. Default is completion.
prompts [CreatePromptInput!]	The type of this form, whether it's verification or completion. Default is completion.
actors FormActorAssignmentInput	Information on how this form should be assigned to users/groups

CreateGlossaryEntityInput

Input required to create a new Glossary Entity - a Node or a Term.

Arguments

Name	Description
id String	Optional! A custom id to use as the primary key identifier for the domain. If not provided, a random UUID will be generated as the id.
name String!	Display name for the Node or Term
description String	Description for the Node or Term
parentNode String	Optional parent node urn for the Glossary Node or Term

CreateGroupInput

Input for creating a new group

Arguments

Name	Description
id String	Optional! A custom id to use as the primary key identifier for the group. If not provided, a random UUID will be generated as the id.
name String!	The display name of the group
description String	The description of the group

CreateIngestionExecutionRequestInput

Input for creating an execution request input

Arguments

Name	Description
ingestionSourceUrn String!	Urn of the ingestion source to execute

CreateInviteTokenInput

Input provided when creating an invite token

Arguments

Name	Description
roleUrn String	The urn of the role to create the invite token for

CreateNativeUserResetTokenInput

Input required to generate a password reset token for a native user.

Arguments

Name	Description
userUrn String!	The urn of the user to reset the password of

CreateOwnershipTypeInput

Arguments

Name	Description
name String!	The name of the Custom Ownership Type
description String!	The description of the Custom Ownership Type

CreatePostInput

Input provided when creating a Post

Arguments

Name	Description
postType PostType!	The type of post
content UpdatePostContentInput!	The content of the post
resourceUrn String	Optional target URN for the post
subResourceType SubResourceType	An optional type of a sub resource to attach the Tag to
subResource String	Optional target subresource for the post

CreatePromptInput

Input for creating form prompts

Arguments

Name	Description
id String	Advanced: Optionally provide an ID to this prompt. All prompt IDs must be globally unique.
title String!	The title of the prompt
description String	The optional description of the prompt
type FormPromptType!	The type of the prompt.
structuredPropertyParams StructuredPropertyParamsInput	The params required if this prompt type is STRUCTURED_PROPERTY or FIELDS_STRUCTURED_PROPERTY
required Boolean	Whether this prompt will be required or not. Default is false.

CreateQueryInput

Input required for creating a Query. Requires the 'Edit Queries' privilege for all query subjects.

Arguments

Name	Description
properties CreateQueryPropertiesInput!	Properties about the Query
subjects [CreateQuerySubjectInput!]!	Subjects for the query

CreateQueryPropertiesInput

Input properties required for creating a Query

Arguments

Name	Description
name String	An optional display name for the Query
description String	An optional description for the Query
statement QueryStatementInput!	The Query contents

CreateQuerySubjectInput

Input required for creating a Query. For now, only datasets are supported.

Arguments

Name	Description
datasetUrn String!	The urn of the dataset that is the subject of the query

CreateSecretInput

Input arguments for creating a new Secret

Arguments

Name	Description
name String!	The name of the secret for reference in ingestion recipes
value String!	The value of the secret, to be encrypted and stored
description String	An optional description for the secret

CreateStructuredPropertyInput

Input for creating a new structured property entity

Arguments

Name	Description
id String	(Advanced) An optional unique ID to use when creating the urn of this entity
qualifiedName String!	The unique fully qualified name of this structured property, dot delimited.
displayName String	The optional display name for this property
description String	The optional description for this property
immutable Boolean	Whether the property will be mutable once it is applied or not. Default is false.
valueType String!	The urn of the value type that this structured property accepts. For example: urn:li:dataType:datahub.string or urn:li:dataType:datahub.date
typeQualifier TypeQualifierInput	The optional input for specifying specific entity types as values
allowedValues [AllowedValueInput!]	The optional input for specifying a list of allowed values
cardinality PropertyCardinality	The optional input for specifying if one or multiple values can be applied. Default is one value (single cardinality)
entityTypes [String!]!	The list of entity types that this property can be applied to. For example: ["urn:li:entityType:datahub.dataset"]

CreateTagInput

Input required to create a new Tag

Arguments

Name	Description
id String	Optional! A custom id to use as the primary key identifier for the Tag. If not provided, a random UUID will be generated as the id.
name String!	Display name for the Tag
description String	Optional description for the Tag

CreateTestConnectionRequestInput

Input for creating a test connection request

Arguments

Name	Description
recipe String!	A JSON-encoded recipe
version String	Advanced: The version of the ingestion framework to use

CreateTestInput

Arguments

Name	Description
id String	Advanced: a custom id for the test.
name String!	The name of the Test
category String!	The category of the Test (user defined)
description String	Description of the test
definition TestDefinitionInput!	The test definition

CreateViewInput

Input provided when creating a DataHub View

Arguments

Name	Description
viewType DataHubViewType!	The type of View
name String!	The name of the View
description String	An optional description of the View
definition DataHubViewDefinitionInput!	The view definition itself

DashboardEditablePropertiesUpdate

Update to writable Dashboard fields

Arguments

Name	Description
description String!	Writable description aka documentation for a Dashboard

DashboardUpdateInput

Arguments provided to update a Dashboard Entity

Arguments

Name	Description
ownership OwnershipUpdate	Update to ownership
globalTags GlobalTagsUpdate	Deprecated, use tags field instead Update to global tags
tags GlobalTagsUpdate	Update to tags
editableProperties DashboardEditablePropertiesUpdate	Update to editable properties

DataFlowEditablePropertiesUpdate

Update to writable Data Flow fields

Arguments

Name	Description
description String!	Writable description aka documentation for a Data Flow

DataFlowUpdateInput

Arguments provided to update a Data Flow aka Pipeline Entity

Arguments

Name	Description
ownership OwnershipUpdate	Update to ownership
globalTags GlobalTagsUpdate	Deprecated, use tags field instead Update to global tags
tags GlobalTagsUpdate	Update to tags
editableProperties DataFlowEditablePropertiesUpdate	Update to editable properties

DataHubJsonConnectionInput

The details of a JSON Connection

Arguments

Name	Description
blob String!	The JSON blob containing the specific connection details.

DataHubViewDefinitionInput

Input required for creating a DataHub View Definition

Arguments

Name	Description
entityTypes [EntityType!]!	A set of entity types that the view applies for. If left empty, then ALL entities will be in scope.
filter DataHubViewFilterInput!	A set of filters to apply.

DataHubViewFilterInput

Input required for creating a DataHub View Definition

Arguments

Name	Description
operator LogicalOperator!	The operator used to combine the filters.
filters [FacetFilterInput!]!	A set of filters combined via an operator. If left empty, then no filters will be applied.

DataJobEditablePropertiesUpdate

Update to writable Data Job fields

Arguments

Name	Description
description String!	Writable description aka documentation for a Data Job

DataJobUpdateInput

Arguments provided to update a Data Job aka Task Entity

Arguments

Name	Description
ownership OwnershipUpdate	Update to ownership
globalTags GlobalTagsUpdate	Deprecated, use tags field instead Update to global tags
tags GlobalTagsUpdate	Update to tags
editableProperties DataJobEditablePropertiesUpdate	Update to editable properties

DataProductEntitiesInput

Input required to fetch the entities inside of a Data Product.

Arguments

Name	Description
query String	Optional query filter for particular entities inside the Data Product
start Int	The offset of the result set
count Int	The number of entities to include in result set
filters [FacetFilterInput!]	Optional Facet filters to apply to the result set

DataQualityContractInput

Input required to create a data quality contract

Arguments

Name	Description
assertionUrn String!	The assertion monitoring this part of the data contract. Assertion must be of type Dataset, Volume, Field / Column, or Custom SQL.

DatasetDeprecationUpdate

An update for the deprecation information for a Metadata Entity

Arguments

Name	Description
deprecated Boolean!	Whether the dataset is deprecated
decommissionTime Long	The time user plan to decommission this dataset
note String!	Additional information about the dataset deprecation plan

DatasetEditablePropertiesUpdate

Update to writable Dataset fields

Arguments

Name	Description
description String!	Writable description aka documentation for a Dataset
name String	Editable name of the Dataset

DatasetFilterInput

Input required to create or update a DatasetFilter

Arguments

Name	Description
type DatasetFilterType!	Type of partition
sql String	The raw query if using a SQL FilterType

DatasetUpdateInput

Arguments provided to update a Dataset Entity

Arguments

Name	Description
ownership OwnershipUpdate	Update to ownership
deprecation DatasetDeprecationUpdate	Update to deprecation status
institutionalMemory InstitutionalMemoryUpdate	Update to institutional memory, ie documentation
globalTags GlobalTagsUpdate	Deprecated, use tags field instead Update to global tags
tags GlobalTagsUpdate	Update to tags
editableSchemaMetadata EditableSchemaMetadataUpdate	Update to editable schema metadata of the dataset
editableProperties DatasetEditablePropertiesUpdate	Update to editable properties

DeleteFormInput

Input for deleting a form

Arguments

Name	Description
urn String!	The urn of the form that is being deleted

DeleteStructuredPropertyInput

Input for deleting a form

Arguments

Name	Description
urn String!	The urn of the structured properties that is being deleted

DescriptionUpdateInput

Incubating. Updates the description of a resource. Currently supports DatasetField descriptions only

Arguments

Name	Description
description String!	The new description
resourceUrn String!	The primary key of the resource to attach the description to, eg dataset urn
subResourceType SubResourceType	An optional sub resource type
subResource String	A sub resource identifier, eg dataset field path

DomainEntitiesInput

Input required to fetch the entities inside of a Domain.

Arguments

Name	Description
query String	Optional query filter for particular entities inside the domain
start Int	The offset of the result set
count Int	The number of entities to include in result set
filters [FacetFilterInput!]	Optional Facet filters to apply to the result set

EditableSchemaFieldInfoUpdate

Update to writable schema field metadata

Arguments

Name	Description
fieldPath String!	Flattened name of a field identifying the field the editable info is applied to
description String	Edited description of the field
globalTags GlobalTagsUpdate	Tags associated with the field

EditableSchemaMetadataUpdate

Update to editable schema metadata of the dataset

Arguments

Name	Description
editableSchemaFieldInfo [EditableSchemaFieldInfoUpdate!]!	Update to writable schema field metadata

EntityCountInput

Input for the get entity counts endpoint

Arguments

Name	Description
types [EntityType!]
viewUrn String	Optional - A View to apply when generating results

EntityRequestContext

Context that defines an entity page requesting recommendations

Arguments

Name	Description
type EntityType!	Type of the enity being displayed
urn String!	Urn of the entity being displayed

EntityTypeToPlatforms

Arguments

Name	Description
entityType EntityType!	Entity type to ignore as hops, if no platform is applied applies to all entities of this type.
platforms [String!]	List of platforms to ignore as hops, empty implies all. Must be a valid platform urn

ERModelRelationshipEditablePropertiesUpdate

Update to writable Dataset fields

Arguments

Name	Description
name String	Display name of the ERModelRelationship
description String!	Writable description for ERModelRelationship

ERModelRelationshipPropertiesInput

Details about the ERModelRelationship

Arguments

Name	Description
name String!	Details about the ERModelRelationship
source String!	Details about the ERModelRelationship
destination String!	Details about the ERModelRelationship
relationshipFieldmappings [RelationshipFieldMappingInput!]	Details about the ERModelRelationship
created Boolean	optional flag about the ERModelRelationship is getting create
createdAt Long	optional field to prevent created time while the ERModelRelationship is getting update
createdBy String	optional field to prevent create actor while the ERModelRelationship is getting update

ERModelRelationshipUpdateInput

Input required to create/update a new ERModelRelationship

Arguments

Name	Description
properties ERModelRelationshipPropertiesInput	Details about the ERModelRelationship
editableProperties ERModelRelationshipEditablePropertiesUpdate	Update to editable properties

FacetFilterInput

Facet filters to apply to search results

Arguments

Name	Description
field String!	Name of field to filter by
value String	Deprecated: Prefer `values` for single elements Value of the field to filter by. Deprecated in favor of values, which should accept a single element array for a value
values [String!]	Values, one of which the intended field should match.
negated Boolean	If the filter should or should not be matched
condition FilterOperator	Condition for the values. How to If unset, assumed to be equality

FilterInput

A set of filter criteria

Arguments

Name	Description
and [FacetFilterInput!]!	A list of conjunctive filters

FormActorAssignmentInput

Input for assigning a form to actors

Arguments

Name	Description
owners Boolean	Whether this form will be applied to owners of associated entities or not. Default is true.
users [String!]	The optional list of user urns to assign this form to
groups [String!]	The optional list of group urns to assign this form to

FormActorAssignmentUpdateInput

Update input for assigning a form to actors

Arguments

Name	Description
owners Boolean	Whether this form will be applied to owners of associated entities or not. Default is true.
usersToAdd [String!]	The optional list of user urns to assign this form to
usersToRemove [String!]	The users being removed from being assigned to this form
groupsToAdd [String!]	The optional list of group urns to assign this form to
groupsToRemove [String!]	The groups being removed from being assigned to this form

FreshnessContractInput

Input required to create an Freshness contract

Arguments

Name	Description
assertionUrn String!	The assertion monitoring this part of the data contract. Assertion must be of type Freshness.

GetAccessTokenInput

Input required to fetch a new Access Token.

Arguments

Name	Description
type AccessTokenType!	The type of the Access Token.
actorUrn String!	The actor associated with the Access Token.
duration AccessTokenDuration!	The duration for which the Access Token is valid.

GetGrantedPrivilegesInput

Input for getting granted privileges

Arguments

Name	Description
actorUrn String!	Urn of the actor
resourceSpec ResourceSpec	Spec to identify resource. If empty, gets privileges granted to the actor

GetInviteTokenInput

Input provided when getting an invite token

Arguments

Name	Description
roleUrn String	The urn of the role to get the invite token for

GetQuickFiltersInput

Input for getting Quick Filters

Arguments

Name	Description
viewUrn String	Optional - A View to apply when generating results

GetRootGlossaryEntitiesInput

Input required when getting Business Glossary entities

Arguments

Name	Description
start Int!	The starting offset of the result set returned
count Int!	The number of Glossary Entities in the returned result set

GetSchemaBlameInput

Input for getting schema changes computed at a specific version.

Arguments

Name	Description
datasetUrn String!	The dataset urn
version String	Changes after this version are not shown. If not provided, this is the latestVersion.

GetSchemaVersionListInput

Input for getting list of schema versions.

Arguments

Name	Description
datasetUrn String!	The dataset urn

GetSecretValuesInput

Input arguments for retrieving the plaintext values of a set of secrets

Arguments

Name	Description
secrets [String!]!	A list of secret names

GlobalTagsUpdate

Deprecated, use addTag or removeTag mutation instead Update to the Tags associated with a Metadata Entity

Arguments

Name	Description
tags [TagAssociationUpdate!]	The new set of tags

GroupingCriterion

A single grouping criterion for grouping search results

Arguments

Name	Description
baseEntityType EntityType	The base entity type that needs to be grouped e.g. schemaField Omitting this field will result in all base entities being grouped into the groupingEntityType.
groupingEntityType EntityType!	The type of entity being grouped into e.g. dataset, domain, etc.

GroupingSpec

A grouping specification for search results.

Arguments

Name	Description
groupingCriteria [GroupingCriterion!]	A list of grouping criteria for grouping search results. There is no implied order in the grouping criteria.

IncidentSourceInput

Input required to create an incident source

Arguments

Name	Description
type IncidentSourceType!	The type of the incident source

InstitutionalMemoryMetadataUpdate

An institutional memory to add to a Metadata Entity TODO Add a USER or GROUP actor enum

Arguments

Name	Description
url String!	Link to a document or wiki page or another internal resource
description String	Description of the resource
author String!	The corp user urn of the author of the metadata
createdAt Long	The time at which this metadata was created

InstitutionalMemoryUpdate

An update for the institutional memory information for a Metadata Entity

Arguments

Name	Description
elements [InstitutionalMemoryMetadataUpdate!]!	The individual references in the institutional memory

LineageEdge

Arguments

Name	Description
downstreamUrn String!	Urn of the source entity. This urn is downstream of the destinationUrn.
upstreamUrn String!	Urn of the destination entity. This urn is upstream of the destinationUrn

LineageFlags

Flags to control lineage behavior

Arguments

Name	Description
entitiesExploredPerHopLimit Int	Limits the number of results explored per hop, still gets all edges each time a hop happens
startTimeMillis Long	An optional starting time to filter on
endTimeMillis Long	An optional ending time to filter on
ignoreAsHops [EntityTypeToPlatforms!]	Map of entity types to platforms to ignore when counting hops during graph walk. Note: this can potentially cause a large amount of additional hops to occur and should be used with caution.

LineageInput

Input for the list lineage property of an Entity

Arguments

Name	Description
direction LineageDirection!	The direction of the relationship, either incoming or outgoing from the source entity
start Int	The starting offset of the result set
count Int	The number of results to be returned
separateSiblings Boolean	Optional flag to not merge siblings in the response. They are merged by default.
startTimeMillis Long	An optional starting time to filter on
endTimeMillis Long	An optional ending time to filter on

ListAccessTokenInput

Input arguments for listing access tokens

Arguments

Name	Description
start Int	The starting offset of the result set
count Int	The number of results to be returned
filters [FacetFilterInput!]	Facet filters to apply to search results

ListBusinessAttributesInput

Input provided when listing Business Attribute

Arguments

Name	Description
start Int	The starting offset of the result set returned
count Int	The maximum number of Business Attributes to be returned in the result set
query String	Optional search query

ListDomainsInput

Input required when listing DataHub Domains

Arguments

Name	Description
start Int	The starting offset of the result set returned
count Int	The maximum number of Domains to be returned in the result set
query String	Optional search query
parentDomain String	Optional parent domain

ListGlobalViewsInput

Input provided when listing DataHub Global Views

Arguments

Name	Description
start Int	The starting offset of the result set returned
count Int	The maximum number of Views to be returned in the result set
query String	Optional search query

ListGroupsInput

Input required when listing DataHub Groups

Arguments

Name	Description
start Int	The starting offset of the result set returned
count Int	The maximum number of Policies to be returned in the result set
query String	Optional search query

ListIngestionSourcesInput

Input arguments for listing Ingestion Sources

Arguments

Name	Description
start Int	The starting offset of the result set
count Int	The number of results to be returned
query String	An optional search query
filters [FacetFilterInput!]	Optional Facet filters to apply to the result set

ListMyViewsInput

Input provided when listing DataHub Views

Arguments

Name	Description
start Int	The starting offset of the result set returned
count Int	The maximum number of Views to be returned in the result set
query String	Optional search query
viewType DataHubViewType	Optional - List the type of View to filter for.

ListOwnershipTypesInput

Input required for listing custom ownership types entities

Arguments

Name	Description
start Int	The starting offset of the result set returned, default is 0
count Int	The maximum number of Custom Ownership Types to be returned in the result set, default is 20
query String	Optional search query
filters [FacetFilterInput!]	Optional Facet filters to apply to the result set

ListPoliciesInput

Input required when listing DataHub Access Policies

Arguments

Name	Description
start Int	The starting offset of the result set returned
count Int	The maximum number of Policies to be returned in the result set
query String	Optional search query
orFilters [AndFilterInput!]	A list of disjunctive criterion for the filter. (or operation to combine filters)

ListPostsInput

Input provided when listing existing posts

Arguments

Name	Description
start Int	The starting offset of the result set returned
count Int	The maximum number of Roles to be returned in the result set
query String	Optional search query

ListQueriesInput

Input required for listing query entities

Arguments

Name	Description
start Int	The starting offset of the result set returned
count Int	The maximum number of Queries to be returned in the result set
query String	A raw search query
source QuerySource	An optional source for the query
datasetUrn String	An optional Urn for the parent dataset that the query is associated with.

ListRecommendationsInput

Input arguments for fetching UI recommendations

Arguments

Name	Description
userUrn String!	Urn of the actor requesting recommendations
requestContext RecommendationRequestContext	Context provider by the caller requesting recommendations
limit Int	Max number of modules to return
viewUrn String	Optional - A View to apply when generating results

ListRolesInput

Input provided when listing existing roles

Arguments

Name	Description
start Int	The starting offset of the result set returned
count Int	The maximum number of Roles to be returned in the result set
query String	Optional search query

ListSecretsInput

Input for listing DataHub Secrets

Arguments

Name	Description
start Int	The starting offset of the result set
count Int	The number of results to be returned
query String	An optional search query

ListTestsInput

Input required when listing DataHub Tests

Arguments

Name	Description
start Int	The starting offset of the result set returned
count Int	The maximum number of Domains to be returned in the result set
query String	Optional query string to match on

ListUsersInput

Input required when listing DataHub Users

Arguments

Name	Description
start Int	The starting offset of the result set returned
count Int	The maximum number of Policies to be returned in the result set
query String	Optional search query

MetadataAnalyticsInput

Input to fetch metadata analytics charts

Arguments

Name	Description
entityType EntityType	Entity type to fetch analytics for (If empty, queries across all entities)
domain String	Urn of the domain to fetch analytics for (If empty or GLOBAL, queries across all domains)
query String	Search query to filter down result (If empty, does not apply any search query)

MoveDomainInput

Input for updating the parent domain of a domain.

Arguments

Name	Description
parentDomain String	The new parent domain urn. If parentDomain is null, this will remove the parent from this entity
resourceUrn String!	The primary key of the resource to update the parent domain for

NotebookEditablePropertiesUpdate

Update to writable Notebook fields

Arguments

Name	Description
description String!	Writable description aka documentation for a Notebook

NotebookUpdateInput

Arguments provided to update a Notebook Entity

Arguments

Name	Description
ownership OwnershipUpdate	Update to ownership
tags GlobalTagsUpdate	Update to tags
editableProperties NotebookEditablePropertiesUpdate	Update to editable properties

OwnerInput

Input provided when adding an owner to an asset

Arguments

Name	Description
ownerUrn String!	The primary key of the Owner to add or remove
ownerEntityType OwnerEntityType!	The owner type, either a user or group
type OwnershipType	Deprecated: No longer supported The ownership type for the new owner. If none is provided, then a new NONE will be added. Deprecated - Use ownershipTypeUrn field instead.
ownershipTypeUrn String	The urn of the ownership type entity.

OwnershipUpdate

An update for the ownership information for a Metadata Entity

Arguments

Name	Description
owners [OwnerUpdate!]!	The updated list of owners

OwnerUpdate

An owner to add to a Metadata Entity TODO Add a USER or GROUP actor enum

Arguments

Name	Description
owner String!	The owner URN, either a corpGroup or corpuser
type OwnershipType	Deprecated: No longer supported The owner type. Deprecated - Use ownershipTypeUrn field instead.
ownershipTypeUrn String	The urn of the ownership type entity.

PlatformInput

Input representing A Data Platform

Arguments

Name	Description
urn String	Urn of platform
name String	Name of platform

PolicyMatchCriterionInput

Criterion to define relationship between field and values

Arguments

Name	Description
field String!	The name of the field that the criterion refers to e.g. entity_type, entity_urn, domain
values [String!]!	Values. Matches criterion if any one of the values matches condition (OR-relationship)
condition PolicyMatchCondition!	The name of the field that the criterion refers to

PolicyMatchFilterInput

Filter object that encodes a complex filter logic with OR + AND

Arguments

Name	Description
criteria [PolicyMatchCriterionInput!]	List of criteria to apply

PolicyUpdateInput

Input provided when creating or updating an Access Policy

Arguments

Name	Description
type PolicyType!	The Policy Type
name String!	The Policy name
state PolicyState!	The Policy state
description String	A Policy description
resources ResourceFilterInput	The set of resources that the Policy privileges apply to
privileges [String!]!	The set of privileges that the Policy grants
actors ActorFilterInput!	The set of actors that the Policy privileges are granted to

PropertyValueInput

Input for collecting structured property values to apply to entities

Arguments

Name	Description
stringValue String	The string value for this structured property
numberValue Float	The number value for this structured property

QueryStatementInput

Input required for creating a Query Statement

Arguments

Name	Description
value String!	The query text
language QueryLanguage!	The query language

RaiseIncidentInput

Input required to create a new incident in the 'Active' state.

Arguments

Name	Description
type IncidentType!	The type of incident
customType String	A custom type of incident. Present only if type is 'CUSTOM'
title String	An optional title associated with the incident
description String	An optional description associated with the incident
resourceUrn String!	The resource (dataset, dashboard, chart, dataFlow, etc) that the incident is associated with.
source IncidentSourceInput	The source of the incident, i.e. how it was generated
priority Int	An optional priority for the incident. Lower value indicates a higher priority.

RecommendationRequestContext

Context that defines the page requesting recommendations i.e. for search pages, the query/filters. for entity pages, the entity urn and tab

Arguments

Name	Description
scenario ScenarioType!	Scenario in which the recommendations will be displayed
searchRequestContext SearchRequestContext	Additional context for defining the search page requesting recommendations
entityRequestContext EntityRequestContext	Additional context for defining the entity page requesting recommendations

RelatedTermsInput

Input provided when adding Terms to an asset

Arguments

Name	Description
urn String!	The Glossary Term urn to add or remove this relationship to/from
termUrns [String!]!	The primary key of the Glossary Term to add or remove
relationshipType TermRelationshipType!	The type of relationship we're adding or removing to/from for a Glossary Term

RelationshipFieldMappingInput

Details about the ERModelRelationship

Arguments

Name	Description
sourceField String	Details about the ERModelRelationship
destinationField String	Details about the ERModelRelationship

RelationshipsInput

Input for the list relationships field of an Entity

Arguments

Name	Description
types [String!]!	The types of relationships to query, representing an OR
direction RelationshipDirection!	The direction of the relationship, either incoming or outgoing from the source entity
start Int	The starting offset of the result set
count Int	The number of results to be returned
includeSoftDelete Boolean	Whether to include soft-deleted, related, entities

RemoveGroupMembersInput

Input required to remove members from an external DataHub group

Arguments

Name	Description
groupUrn String!	The group to remove members from
userUrns [String!]!	The members to remove from the group

RemoveLinkInput

Input provided when removing the association between a Metadata Entity and a Link

Arguments

Name	Description
linkUrl String!	The url of the link to add or remove, which uniquely identifies the Link
resourceUrn String!	The urn of the resource or entity to attach the link to, for example a dataset urn

RemoveNativeGroupMembersInput

Input required to remove members from a native DataHub group

Arguments

Name	Description
groupUrn String!	The group to remove members from
userUrns [String!]!	The members to remove from the group

RemoveOwnerInput

Input provided when removing the association between a Metadata Entity and an user or group owner

Arguments

Name	Description
ownerUrn String!	The primary key of the Owner to add or remove
ownershipTypeUrn String	The ownership type to remove, optional. By default will remove regardless of ownership type.
resourceUrn String!	The urn of the resource or entity to attach or remove the owner from, for example a dataset urn

RemoveStructuredPropertiesInput

Input for removing structured properties on a given asset

Arguments

Name	Description
assetUrn String!	The urn of the asset that we are removing properties from
structuredPropertyUrns [String!]!	The list of structured properties you want to remove from this asset

ReportOperationInput

Input provided to report an asset operation

Arguments

Name	Description
urn String!	The urn of the asset (e.g. dataset) to report the operation for
operationType OperationType!	The type of operation that was performed. Required
customOperationType String	A custom type of operation. Required if operation type is CUSTOM.
sourceType OperationSourceType!	The source or reporter of the operation
customProperties [StringMapEntryInput!]	A list of key-value parameters to include
partition String	An optional partition identifier
numAffectedRows Long	Optional: The number of affected rows
timestampMillis Long	Optional: Provide a timestamp associated with the operation. If not provided, one will be generated for you based on the current time.

ResourceFilterInput

Input required when creating or updating an Access Policies Determines which resources the Policy applies to

Arguments

Name	Description
type String	The type of the resource the policy should apply to Not required because in the future we want to support filtering by type OR by domain
resources [String!]	A list of specific resource urns to apply the filter to
allResources Boolean	Whether of not to apply the filter to all resources of the type
filter PolicyMatchFilterInput	Whether of not to apply the filter to all resources of the type

ResourceRefInput

Reference to a resource to apply an action to

Arguments

Name	Description
resourceUrn String!	The urn of the resource being referenced
subResourceType SubResourceType	An optional type of a sub resource to attach the Tag to
subResource String	An optional sub resource identifier to attach the Tag to

ResourceSpec

Spec to identify resource

Arguments

Name	Description
resourceType EntityType!	Resource type
resourceUrn String!	Resource urn

RollbackIngestionInput

Input for rolling back an ingestion execution

Arguments

Name	Description
runId String!	An ingestion run ID

SchemaContractInput

Input required to create a schema contract

Arguments

Name	Description
assertionUrn String!	The assertion monitoring this part of the data contract. Assertion must be of type Data Schema.

ScrollAcrossEntitiesInput

Input arguments for a full text search query across entities, specifying a starting pointer. Allows paging beyond 10k results

Arguments

Name	Description
types [EntityType!]	Entity types to be searched. If this is not provided, all entities will be searched.
query String!	The query string
scrollId String	The starting point of paginated results, an opaque ID the backend understands as a pointer
keepAlive String	The amount of time to keep the point in time snapshot alive, takes a time unit based string ex: 5m or 30s
count Int	The number of elements included in the results
orFilters [AndFilterInput!]	A list of disjunctive criterion for the filter. (or operation to combine filters)
viewUrn String	Optional - A View to apply when generating results
searchFlags SearchFlags	Flags controlling search options

ScrollAcrossLineageInput

Input arguments for a search query over the results of a multi-hop graph query, uses scroll API

Arguments

Name	Description
urn String	Urn of the source node
direction LineageDirection!	The direction of the relationship, either incoming or outgoing from the source entity
types [EntityType!]	Entity types to be searched. If this is not provided, all entities will be searched.
query String	The query string
scrollId String	The starting point of paginated results, an opaque ID the backend understands as a pointer
keepAlive String	The amount of time to keep the point in time snapshot alive, takes a time unit based string ex: 5m or 30s
count Int	The number of elements included in the results
orFilters [AndFilterInput!]	A list of disjunctive criterion for the filter. (or operation to combine filters)
startTimeMillis Long	An optional starting time to filter on
endTimeMillis Long	An optional ending time to filter on
searchFlags SearchFlags	Flags controlling search options
lineageFlags LineageFlags	Flags controlling the lineage query

SearchAcrossEntitiesInput

Input arguments for a full text search query across entities

Arguments

Name	Description
types [EntityType!]	Entity types to be searched. If this is not provided, all entities will be searched.
query String!	The query string
start Int	The starting point of paginated results
count Int	The number of elements included in the results
filters [FacetFilterInput!]	Deprecated: Use `orFilters`- they are more expressive Deprecated in favor of the more expressive orFilters field Facet filters to apply to search results. These will be 'AND'-ed together.
orFilters [AndFilterInput!]	A list of disjunctive criterion for the filter. (or operation to combine filters)
viewUrn String	Optional - A View to apply when generating results
searchFlags SearchFlags	Flags controlling search options
sortInput SearchSortInput	Optional - Information on how to sort this search result

SearchAcrossLineageInput

Input arguments for a search query over the results of a multi-hop graph query

Arguments

Name	Description
urn String	Urn of the source node
direction LineageDirection!	The direction of the relationship, either incoming or outgoing from the source entity
types [EntityType!]	Entity types to be searched. If this is not provided, all entities will be searched.
query String	The query string
start Int	The starting point of paginated results
count Int	The number of elements included in the results
filters [FacetFilterInput!]	Deprecated: Use `orFilters`- they are more expressive Deprecated in favor of the more expressive orFilters field Facet filters to apply to search results. These will be 'AND'-ed together.
orFilters [AndFilterInput!]	A list of disjunctive criterion for the filter. (or operation to combine filters)
startTimeMillis Long	Deprecated: Use LineageFlags instead An optional starting time to filter on
endTimeMillis Long	Deprecated: Use LineageFlags instead An optional ending time to filter on
searchFlags SearchFlags	Flags controlling search options
lineageFlags LineageFlags	Flags controlling the lineage query

SearchFlags

Set of flags to control search behavior

Arguments

Name	Description
skipCache Boolean	Whether to skip cache
maxAggValues Int	The maximum number of values in an facet aggregation
fulltext Boolean	Structured or unstructured fulltext query
skipHighlighting Boolean	Whether to skip highlighting
skipAggregates Boolean	Whether to skip aggregates/facets
getSuggestions Boolean	Whether to request for search suggestions on the _entityName virtualized field
groupingSpec GroupingSpec	Additional grouping specifications to apply to the search results Grouping specifications will control how search results are grouped together in the response. This is currently being used to group schema fields (columns) as datasets, and in the future will be used to group other entities as well. Note: This is an experimental feature and is subject to change.
includeSoftDeleted Boolean	Whether to include soft deleted entities
includeRestricted Boolean	Whether to include restricted entities
customHighlightingFields [String!]	fields to include for custom Highlighting

SearchInput

Input arguments for a full text search query

Arguments

Name	Description
type EntityType!	The Metadata Entity type to be searched against
query String!	The raw query string
start Int	The offset of the result set
count Int	The number of entities to include in result set
filters [FacetFilterInput!]	Deprecated: Use `orFilters`- they are more expressive Deprecated in favor of the more expressive orFilters field Facet filters to apply to search results. These will be 'AND'-ed together.
orFilters [AndFilterInput!]	A list of disjunctive criterion for the filter. (or operation to combine filters)
searchFlags SearchFlags	Flags controlling search options

SearchRequestContext

Context that defines a search page requesting recommendatinos

Arguments

Name	Description
query String!	Search query
filters [FacetFilterInput!]	Faceted filters applied to search results

SearchSortInput

Input required in order to sort search results

Arguments

Name	Description
sortCriterion SortCriterion	Deprecated: Use sortCriteria instead A criterion to sort search results on
sortCriteria [SortCriterion!]	A list of values to sort search results on

SortCriterion

A single sorting criterion for sorting search.

Arguments

Name	Description
field String!	A field upon which we'll do sorting on.
sortOrder SortOrder!	The order in which we will be sorting

StepStateInput

The input required to update the state of a step

Arguments

Name	Description
id String!	The globally unique id for the step
properties [StringMapEntryInput]!	The new properties for the step

StringMapEntryInput

String map entry input

Arguments

Name	Description
key String!	The key of the map entry
value String	The value fo the map entry

StructuredPropertyInputParams

A prompt shown to the user to collect metadata about an entity

Arguments

Name	Description
structuredPropertyUrn String!	The urn of the structured property being applied to an entity
values [PropertyValueInput!]!	The list of values you want to apply on this structured property to an entity

StructuredPropertyParamsInput

Input for a structured property type prompt

Arguments

Name	Description
urn String!	The urn of the structured property for a given form prompt

SubmitFormPromptInput

Input for responding to a singular prompt in a form

Arguments

Name	Description
promptId String!	The unique ID of the prompt this input is responding to
formUrn String!	The urn of the form that this prompt is a part of
type FormPromptType!	The type of prompt that this input is responding to
fieldPath String	The fieldPath on a schema field that this prompt submission is association with. This should be provided when the prompt is type FIELDS_STRUCTURED_PROPERTY
structuredPropertyParams StructuredPropertyInputParams	The structured property required for the prompt on this entity

TagAssociationInput

Input provided when updating the association between a Metadata Entity and a Tag

Arguments

Name	Description
tagUrn String!	The primary key of the Tag to add or remove
resourceUrn String!	The target Metadata Entity to add or remove the Tag to
subResourceType SubResourceType	An optional type of a sub resource to attach the Tag to
subResource String	An optional sub resource identifier to attach the Tag to

TagAssociationUpdate

Deprecated, use addTag or removeTag mutation instead A tag update to be applied

Arguments

Name	Description
tag TagUpdateInput!	The tag being applied

TagUpdateInput

Deprecated, use addTag or removeTag mutations instead An update for a particular Tag entity

Arguments

Name	Description
urn String!	The primary key of the Tag
name String!	The display name of a Tag
description String	Description of the tag
ownership OwnershipUpdate	Ownership metadata of the tag

TermAssociationInput

Input provided when updating the association between a Metadata Entity and a Glossary Term

Arguments

Name	Description
termUrn String!	The primary key of the Glossary Term to add or remove
resourceUrn String!	The target Metadata Entity to add or remove the Glossary Term from
subResourceType SubResourceType	An optional type of a sub resource to attach the Glossary Term to
subResource String	An optional sub resource identifier to attach the Glossary Term to

TestDefinitionInput

Arguments

Name	Description
json String	The string representation of the Test Deprecated! JSON representation is no longer supported.

TypeQualifierInput

Input for specifying specific entity types as values

Arguments

Name	Description
allowedTypes [String!]	The list of allowed entity types as urns (ie. ["urn:li:entityType:datahub.corpuser"])

UpdateBusinessAttributeInput

Input required to update Business Attribute

Arguments

Name	Description
name String	name of the business attribute
description String	business attribute description
type SchemaFieldDataType	type

UpdateCorpUserViewsSettingsInput

Input required to update a users settings.

Arguments

Name	Description
defaultView String	The URN of the View that serves as this user's personal default. If not provided, any existing default view will be removed.

UpdateDataProductInput

Input properties required for update a DataProduct

Arguments

Name	Description
name String	A display name for the DataProduct
description String	An optional description for the DataProduct

UpdateDeprecationInput

Input provided when setting the Deprecation status for an Entity.

Arguments

Name	Description
urn String!	The urn of the Entity to set deprecation for.
deprecated Boolean!	Whether the Entity is marked as deprecated.
decommissionTime Long	Optional - The time user plan to decommission this entity
note String	Optional - Additional information about the entity deprecation plan

UpdateDocPropagationSettingsInput

Input required to update doc propagation settings.

Arguments

Name	Description
docColumnPropagation Boolean	The default doc propagation setting for the platform.

UpdateEmbedInput

Input required to set or clear information related to rendering a Data Asset inside of DataHub.

Arguments

Name	Description
urn String!	The URN associated with the Data Asset to update. Only dataset, dashboard, and chart urns are currently supported.
renderUrl String	Set or clear a URL used to render an embedded asset.

UpdateFormInput

Input for updating a form

Arguments

Name	Description
urn String!	The urn of the form being updated
name String	The new name of the form
description String	The new description of the form
type FormType	The new type of the form
promptsToAdd [CreatePromptInput!]	The new prompts being added to this form
promptsToRemove [String!]	The IDs of the prompts to remove from this form
actors FormActorAssignmentUpdateInput	Information on how this form should be assigned to users/groups

UpdateGlobalViewsSettingsInput

Input required to update Global View Settings.

Arguments

Name	Description
defaultView String	The URN of the View that serves as the Global, or organization-wide, default. If this field is not provided, the existing Global Default will be cleared.

UpdateIncidentStatusInput

Input required to update status of an existing incident

Arguments

Name	Description
state IncidentState!	The new state of the incident
message String	An optional message associated with the new state

UpdateIngestionSourceConfigInput

Input parameters for creating / updating an Ingestion Source

Arguments

Name	Description
recipe String!	A JSON-encoded recipe
version String	The version of DataHub Ingestion Framework to use when executing the recipe.
executorId String!	The id of the executor to use for executing the recipe
debugMode Boolean	Whether or not to run ingestion in debug mode
extraArgs [StringMapEntryInput!]	Extra arguments for the ingestion run.

UpdateIngestionSourceInput

Input arguments for creating / updating an Ingestion Source

Arguments

Name	Description
name String!	A name associated with the ingestion source
type String!	The type of the source itself, e.g. mysql, bigquery, bigquery-usage. Should match the recipe.
description String	An optional description associated with the ingestion source
schedule UpdateIngestionSourceScheduleInput	An optional schedule for the ingestion source. If not provided, the source is only available for run on-demand.
config UpdateIngestionSourceConfigInput!	A set of type-specific ingestion source configurations

UpdateIngestionSourceScheduleInput

Input arguments for creating / updating the schedule of an Ingestion Source

Arguments

Name	Description
interval String!	The cron-formatted interval describing when the job should be executed
timezone String!	The name of the timezone in which the cron interval should be scheduled (e.g. America/Los Angeles)

UpdateLineageInput

Input required in order to upsert lineage edges

Arguments

Name	Description
edgesToAdd [LineageEdge]!	New lineage edges to upsert
edgesToRemove [LineageEdge]!	Lineage edges to remove. Takes precedence over edgesToAdd - so edges existing both edgesToAdd and edgesToRemove will be removed.

UpdateMediaInput

Input provided for filling in a post content

Arguments

Name	Description
type MediaType!	The type of media
location String!	The location of the media (a URL)

UpdateNameInput

Input for updating the name of an entity

Arguments

Name	Description
name String!	The new name
urn String!	The primary key of the resource to update the name for

UpdateOwnershipTypeInput

Arguments

Name	Description
name String	The name of the Custom Ownership Type
description String	The description of the Custom Ownership Type

UpdateParentNodeInput

Input for updating the parent node of a resource. Currently only GlossaryNodes and GlossaryTerms have parentNodes.

Arguments

Name	Description
parentNode String	The new parent node urn. If parentNode is null, this will remove the parent from this entity
resourceUrn String!	The primary key of the resource to update the parent node for

UpdatePostContentInput

Input provided for filling in a post content

Arguments

Name	Description
contentType PostContentType!	The type of post content
title String!	The title of the post
description String	Optional content of the post
link String	Optional link that the post is associated with
media UpdateMediaInput	Optional media contained in the post

UpdatePostInput

Input provided when creating a Post

Arguments

Name	Description
urn String!	The urn of the post to edit or update
postType PostType!	The type of post
content UpdatePostContentInput!	The content of the post

UpdateQueryInput

Input required for updating an existing Query. Requires the 'Edit Queries' privilege for all query subjects.

Arguments

Name	Description
properties UpdateQueryPropertiesInput	Properties about the Query
subjects [UpdateQuerySubjectInput!]	Subjects for the query

UpdateQueryPropertiesInput

Input properties required for creating a Query. Any non-null fields will be updated if provided.

Arguments

Name	Description
name String	An optional display name for the Query
description String	An optional description for the Query
statement QueryStatementInput	The Query contents

UpdateQuerySubjectInput

Input required for creating a Query. For now, only datasets are supported.

Arguments

Name	Description
datasetUrn String!	The urn of the dataset that is the subject of the query

UpdateSecretInput

Input arguments for updating a Secret

Arguments

Name	Description
urn String!	The primary key of the Secret to update
name String!	The name of the secret for reference in ingestion recipes
value String!	The value of the secret, to be encrypted and stored
description String	An optional description for the secret

UpdateStructuredPropertyInput

Input for updating an existing structured property entity

Arguments

Name	Description
urn String!	The urn of the structured property being updated
displayName String	The optional display name for this property
description String	The optional description for this property
immutable Boolean	Whether the property will be mutable once it is applied or not. Default is false.
typeQualifier UpdateTypeQualifierInput	The optional input for specifying specific entity types as values
newAllowedValues [AllowedValueInput!]	Append to the list of allowed values for this property. For backwards compatibility, this is append only.
setCardinalityAsMultiple Boolean	Set to true if you want to change the cardinality of this structured property to multiple. Cannot change from multiple to single for backwards compatibility reasons.
newEntityTypes [String!]	Append to the list of entity types that this property can be applied to. For backwards compatibility, this is append only.

UpdateTestInput

Arguments

Name	Description
name String!	The name of the Test
category String!	The category of the Test (user defined)
description String	Description of the test
definition TestDefinitionInput!	The test definition

UpdateTypeQualifierInput

Input for updating specifying specific entity types as values

Arguments

Name	Description
newAllowedTypes [String!]	Append to the list of allowed entity types as urns for this property (ie. ["urn:li:entityType:datahub.corpuser"]) For backwards compatibility, this is append only.

UpdateUserSettingInput

Input for updating a user setting

Arguments

Name	Description
name UserSetting!	The name of the setting
value Boolean!	The new value of the setting

UpdateViewInput

Input provided when updating a DataHub View

Arguments

Name	Description
name String	The name of the View
description String	An optional description of the View
definition DataHubViewDefinitionInput	The view definition itself

UpsertCustomAssertionInput

Input for upserting a Custom Assertion.

Arguments

Name	Description
entityUrn String!	The entity targeted by this assertion.
type String!	The type of the custom assertion.
description String!	The description of this assertion.
fieldPath String	The dataset field targeted by this assertion, if any.
platform PlatformInput!	The external Platform associated with the assertion
externalUrl String	Native platform URL of the Assertion
logic String	Logic comprising a raw, unstructured assertion. for example - custom SQL query for the assertion.

UpsertDataContractInput

Input required to upsert a Data Contract entity for an asset

Arguments

Name	Description
entityUrn String!	The urn of the related entity. Dataset is the only entity type supported today.
freshness [FreshnessContractInput!]	The Freshness / Freshness portion of the contract. If not provided, this will be set to none. For Dataset Contracts, it is expected that there will not be more than 1 Freshness contract. If there are, only the first will be displayed.
schema [SchemaContractInput!]	The schema / structural portion of the contract. If not provided, this will be set to none. For Dataset Contracts, it is expected that there will not be more than 1 Schema contract. If there are, only the first will be displayed.
dataQuality [DataQualityContractInput!]	The data quality portion of the contract. If not provided, this will be set to none.
state DataContractState	The state of the data contract. If not provided, it will be in ACTIVE mode by default.
id String	Optional ID of the contract you want to create. Only applicable if this is a create operation. If not provided, a random id will be generated for you.

UpsertDataHubConnectionInput

Input required to upsert a new DataHub connection.

Arguments

Name	Description
id String	An optional ID to use when creating the URN of the connection. If none is provided, a random UUID will be generated automatically.
type DataHubConnectionDetailsType!	The type or format of connection
platformUrn String!	Urn of the associated platform
json DataHubJsonConnectionInput	A JSON-encoded connection. This must be present when type is JSON.
name String	An optional name for this connection entity

UpsertStructuredPropertiesInput

Input for upserting structured properties on a given asset

Arguments

Name	Description
assetUrn String!	The urn of the asset that we are updating
structuredPropertyInputParams [StructuredPropertyInputParams!]!	The list of structured properties you want to upsert on this asset

VerifyFormInput

Input for verifying forms on entities

Arguments

Name	Description
formUrn String!	The urn of the form being verified on an entity
entityUrn String!	The urn of the entity that is having a form verified on it