Skip to main content

Interfaces

Aspect​

A versioned aspect, or single group of related metadata, associated with an Entity and having a unique version

Implemented by

Fields

NameDescription
version
Long

The version of the aspect, where zero represents the latest version

BrowsableEntity​

A Metadata Entity which is browsable, or has browse paths.

Implemented by

Fields

NameDescription
browsePaths
[BrowsePath!]

The browse paths corresponding to an entity. If no Browse Paths have been generated before, this will be null.

EditableProperties​

Editable properties aspect with a description that can be set in the UI

Implemented by

Fields

NameDescription
description
String

Description of the entity, edited in the UI

Entity​

A top level Metadata Entity

Implemented by

Fields

NameDescription
urn
String!

A primary key of the Metadata Entity

type
EntityType!

A standard Entity Type

relationships
EntityRelationshipsResult

List of relationships between the source Entity and some destination entities with a given types

Arguments

NameDescription
input
RelationshipsInput!

EntityProperties​

Properties aspect shared by entities with a name and description

Implemented by

Fields

NameDescription
name
String

Name of the entity

description
String

Description of the entity

EntityWithRelationships​

Deprecated, use relationships field instead

Implements

Implemented by

Fields

NameDescription
urn
String!

A primary key associated with the Metadata Entity

type
EntityType!

A standard Entity Type

relationships
EntityRelationshipsResult

Granular API for querying edges extending from this entity

Arguments

NameDescription
input
RelationshipsInput!
lineage
EntityLineageResult

Edges extending from this entity grouped by direction in the lineage graph

Arguments

NameDescription
input
LineageInput!

HasAccess​

An entity with access roles

Implemented by

Fields

NameDescription
access
Access

Roles and the properties to access the entity

HasAiContext​

An entity that can have AI context

Implemented by

Fields

NameDescription
aiContext
AiContext

AI context of the entity

HasApplications​

An entity that can belong to applications

Implemented by

Fields

NameDescription
applications
[ApplicationAssociation!]

The applications associated with the entity

HasBrowsePathV2​

An entity with a browse path

Implemented by

Fields

NameDescription
browsePathV2
BrowsePathV2

The browse path V2 corresponding to the entity

HasContainer​

An entity that can live inside a container

Implemented by

Fields

NameDescription
container
Container

The parent container the entity belongs to

HasCustomProperties​

An aspect with custom properties

Implemented by

Fields

NameDescription
customProperties
[CustomPropertiesEntry!]

Custom properties of the entity

HasDataPlatformInstance​

An entity that can belong to a data platform instance

Implemented by

Fields

NameDescription
dataPlatformInstance
DataPlatformInstance

The specific instance of the data platform that the entity belongs to

HasDeprecation​

An entity that can be deprecated

Implemented by

Fields

NameDescription
deprecation
Deprecation

The deprecation status of the entity

HasDescription​

An entity with a top-level description field

Implemented by

Fields

NameDescription
description
String

The description of the entity

HasDisplayProperties​

An entity with display properties

Implemented by

Fields

NameDescription
displayProperties
DisplayProperties

Display properties of the entity, such as its color and icon

HasDocumentation​

An entity that can have documentation

Implemented by

Fields

NameDescription
documentation
Documentation

Documentation of the entity from various sources

HasDomain​

An entity that can belong to a domain

Implemented by

Fields

NameDescription
domain
DomainAssociation

The domain the entity belongs to

HasEditableProperties​

An entity with an editable description

Implemented by

Fields

NameDescription
editableProperties
EditableProperties

Properties of the entity edited in the UI

HasEmbed​

An entity that can be embedded

Implemented by

Fields

NameDescription
embed
Embed

Embed information about the entity

HasExecutionRuns​

Implemented by

Fields

NameDescription
runs
DataProcessInstanceResult

History of runs of this task

Arguments

NameDescription
start
Int
count
Int

HasExists​

An entity that can report whether it exists

Implemented by

Fields

NameDescription
exists
Boolean

Whether or not this entity exists on DataHub

HasExternalUrl​

An aspect with a link to the entity in its source system

Implemented by

Fields

NameDescription
externalUrl
String

URL of the entity in its source system

HasForms​

An entity that can have forms assigned

Implemented by

Fields

NameDescription
forms
Forms

The forms associated with the entity

HasGlossaryTerms​

An entity that can have glossary terms

Implemented by

Fields

NameDescription
glossaryTerms
GlossaryTerms

Glossary terms associated with the entity

HasHealth​

An entity with health signals

Implemented by

Fields

NameDescription
health
[Health!]

Experimental! The resolved health statuses of the entity

HasIncidents​

An entity that can have incidents

Implemented by

Fields

NameDescription
incidents
EntityIncidentsResult

Incidents associated with the entity

Arguments

NameDescription
state
IncidentState

Optional incident state to filter by, defaults to any state.

stage
IncidentStage

Optional incident stage to filter by, defaults to any stage.

priority
IncidentPriority

Optional incident priority to filter by, defaults to any priority.

assigneeUrns
[String!]

Optional assignee urns for an incident.

start
Int

Optional start offset, defaults to 0.

count
Int

Optional number of results to return, defaults to 20.

HasInstitutionalMemory​

An entity that can have links attached

Implemented by

Fields

NameDescription
institutionalMemory
InstitutionalMemory

References to internal resources related to the entity

HasLastIngested​

An entity populated by ingestion

Implemented by

Fields

NameDescription
lastIngested
Long

The timestamp for the last time the entity was ingested

HasLogicalParent​

Implemented by

Fields

NameDescription
logicalParent
Entity

If this entity represents a physical asset, this is its logical parent, from which metadata can propagate.

HasName​

An entity with a top-level name field

Implemented by

Fields

NameDescription
name
String!

The name of the entity. Not always the display name, e.g. for Dataset this is the name from its key

HasOwnership​

An entity that can have owners

Implemented by

Fields

NameDescription
ownership
Ownership

Ownership metadata of the entity

HasParentContainers​

An entity with a container hierarchy

Implemented by

Fields

NameDescription
parentContainers
ParentContainersResult

Recursively get the lineage of containers for the entity

HasPlatform​

An entity that belongs to a data platform

Implemented by

Fields

NameDescription
platform
DataPlatform

The platform the entity belongs to

HasPrivileges​

An entity whose privileges for the current user can be resolved. Resolving privileges runs around 17 authorization checks per entity, so avoid selecting it through this interface in queries that return many entities, such as search results or lineage.

Implemented by

Fields

NameDescription
privileges
EntityPrivileges

Privileges given to the current user for the entity

HasProperties​

An entity whose properties aspect has a name and description

Implemented by

Fields

NameDescription
properties
EntityProperties

Properties of the entity

HasRawAspects​

An entity whose raw aspects can be fetched

Implemented by

Fields

NameDescription
aspects
[RawAspect]

Experimental API. For fetching extra entities that do not have custom UI code yet

Arguments

NameDescription
input
AspectParams

HasRelatedDocuments​

An entity that can have related context documents

Implemented by

Fields

NameDescription
relatedDocuments
RelatedDocumentsResult

Get context documents related to this entity

Arguments

NameDescription
input
RelatedDocumentsInput!

HasStatus​

An entity that can be soft deleted

Implemented by

Fields

NameDescription
status
Status

The status of the entity

HasStructuredProperties​

An entity that can have structured properties

Implemented by

Fields

NameDescription
structuredProperties
StructuredProperties

Structured properties applied to the entity

HasSubTypes​

An entity that can have sub types

Implemented by

Fields

NameDescription
subTypes
SubTypes

Sub types of the entity

HasTags​

An entity that can have tags

Implemented by

Fields

NameDescription
tags
GlobalTags

Tags applied to the entity

SupportsVersions​

Implemented by

Fields

NameDescription
versionProperties
VersionProperties

Indicates that this entity is versioned and provides information about the version.

TimeSeriesAspect​

A time series aspect, or a group of related metadata associated with an Entity and corresponding to a particular timestamp

Implemented by

Fields

NameDescription
timestampMillis
Long!

The timestamp associated with the time series aspect in milliseconds