Atlan APIs use certain common terms and properties that are based on our product fundamentals. To help you get oriented, here are the common concepts in our API documentation. (For a deeper dive into product terminology, head over to our Product Documentation)
In Atlan we refer to every record of metadata as an "asset". These include tables, columns, databases, schemas, BI dashboards, and so on.
We use the phrase "data assets" to refer to the subset of assets related to the storage of data:
In Atlan, lineage is create through a process. A process contains the query transformation that forms the downstream asset from the upstream asset. Therefore, creating a process between upstream and downstream assets will form a lineage between them. Jump to Create processes API to create lineage.
In Atlan, every asset has two kinds of identifiers:
guidproperty is a globally unique alpha-numeric string. You can find the GUID of an asset in the URL when you view an asset in Atlan.
For example: when viewing a table on Atlan, the URL on the browser is something like
https://tenant.atlan.com/assets/17f0356e-75f6-4e0b-8b05-32cebe8cd953/overview. In this example,
17f0356e-75f6-4e0b-8b05-32cebe8cd953is the GUID of the table.
qualifiedNameproperty is a unique, concatenated string identifying the asset. For data assets, these are the concatenation of the parent object's
qualifiedNameand the name of the child object.
For example: the
qualifiedNameof a table in Snowflake will be something like
In our APIs, we identify the type of data requested or returned by the
typeName is used for not just identifying assets such as tables or columns, but also attached metadata objects to these assets like readme and glossary terms.
Accepted values for
typeName in Atlan are:
Column: Identifies a column
Table: Identifies a table
View: Identifies a view
Schema: Identifies a schema
Database: Identifies a database
Process: Identifies a process that forms lineage
Readme: Identifies a readme which is attached to an asset in Atlan
AtlasGlossary: Identifies a glossary in Atlan
AtlasGlossaryCategory: Identifies a glossary category in Atlan
AtlasGlossaryTerm: Identifies a glossary term in Atlan
and so on.
Note: typeName for Classification is a hashed value in Atlan