Atlan API
2.0.0

Atlan is a modern data workspace that makes collaboration among diverse users (like managers, analysts and engineers) easier, increasing efficiency and agility in data projects ✨

Atlan is built on an OpenAPI architecture, hence everything that is visible on the product is powered by APIs. We are gradually opening up more APIs for our users. If you are looking for an API that you don't see here, please reach out to us.

This is the documentation for version 2.0.0 of the API. Last update on Dec 21, 2022.

Base URL

https://tenant.atlan.com

SDKs

We are also experimenting with a new Developer Portal — exploring common use cases in more detail and showing how to use our SDKs (currently under development). We'd love your thoughts on how you use (or avoid) one site or the other, or even use them in combination. Just give your Atlan contact a shout with any feedback!

Important notes

This site only contains documentation about the APIs, and is not built from the APIs themselves.

All changes noted in the API Changelog are changes to this documentation, and not to the underlying APIs of Atlan.

For clarity:

We may occasionally make mistakes in the documentation 🙈
When we discover these, we go back to correct them as quickly as we can 🧑‍💻
The site may show these as breaking changes in the API 🚨, but in reality we're only fixing broken documentation 📚
(Without fixing documentation where it's wrong, what you see in the documentation wouldn't actually work)
For the avoidance of doubt: the APIs themselves are not changing 😅

How we've organized the documentation

In most cases, our API does not have separate endpoints for different types of assets. For example, we do not have different endpoints for data sources and business intelligence objects.

Instead, we have many endpoints that you can use to manage many different types of assets.

So we have organized the documentation into two general areas:

The tags you see along the left provide succinct examples of common operations. These use case examples provide the minimal set of information required to be complete.
The very last Canonical tag provides the full documentation of API endpoints that are used for many different use cases. Here you can find the extensive list of options that you can apply, if you want to extend beyond the common use cases.

You can also distinguish between these two approaches by looking at the URL of each endpoint:

The use case examples will all end with a #operationId. You can actually drop this from the URL, as it is not needed by the API. It is only needed by the formal specification we use to document the operations, to keep each one unique.
The canonical endpoints will have no #operationId at the end of their URL.

Terminology

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)

Key concepts

Asset — all objects that provide context to your data, such as tables, columns, databases, BI dashboards and so on.
Process — the transformations that link together upstream and downstream assets in lineage.
Unique identifiers — control how Atlan creates vs updates assets.
Type definitions — control what metadata is used to describe each different kind of asset (for example a Table vs a Column).

Authentication

Send all requests to Atlan's APIs using a bearer token in the Authorization header.

For details on creating a bearer token, see our API authentication article.

Postman

Each update we make to the documentation automatically builds an updated Postman collection at: https://atlanhq.github.io/openapi/atlan_collection.json — you can use this quickly get started with the APIs.

See our Getting started with the APIs article for more details.

Search

Operations for finding assets.

Atlan uses Elastic's Query DSL to provide an extremely powerful and flexible search capability. With that flexibility comes some complexity. We have a detailed write-up of search in our Developer Portal.

Provided below are a few common examples of the search patterns.

Operations

POST: /api/meta/search/indexsearch#findAssetByExactName
POST: /api/meta/search/indexsearch#findClassifiedAssets
POST: /api/meta/search/indexsearch#findTablesInSchema
POST: /api/meta/search/indexsearch#findChildAssets

Find asset by exact name

POST /api/meta/search/indexsearch#findAssetByExactName

Search for assets with an exact name.

Body Required

Query to run the search.

Replace the __typeName.keyword with the name of the asset type
Replace the name.keyword with the exact name of the asset to find

This example specifically searches for a glossary term with the exact name of Customer Acquisition Cost.

In addition to the default set of properties returned in a search, this request will also retrieve:

the term's glossary (anchor)
the user-provided description of the term (userDescription)
the term's certificate status (certificateStatus)
any announcement details on the term (announcementType, announcementTitle, announcementMessage)
the term's owners (ownerUsers, ownerGroups)

For the related object (the term's glossary) it will also retrieve the glossary's:

certificate status
name
description
qualified name

dsl object Required

Search query for Atlan. This uses the Elastic Query DSL, which will not be fully described here due to its complexity.
- from integer
  
  Starting point of results for paging.
  
  Default value is 0.
- size integer
  
  Maximum number of results to return (for paging).
- sort array[object] | null
  
  How the results should be sorted.
- query object | null Required
  
  Query in Elastic's Query DSL.
- post_filter object | null
  
  Optional mechanism to further filter search results. (See Elastic's post filter details.)
attributes array[string] | null

List of attribute names to include on each result. These attributes should exist on the assets being searched.
relationAttributes array[string] | null

List of attribute names to include on each relationship included in the results. These attributes should exist on at least one of the relationships that could be returned on one of the assets in the results.

Responses

• 200 object

Assets that exactly match the specified parameters. In the case of this example, only glossary terms that are in an active state with a name that exactly matches Customer Acquisition Cost.
- queryType string
  
  Type of query.
  
  Value is INDEX.
- searchParameters object
  
  Details of the query that was run. These can be used to re-run precisely the same query for paging.
  attributes array[string]
  
  List of attribute names requested to be included on each result.
  
  relationAttributes array[string]
  
  List of attribute names requested to be included on each relationship included in the results.
  
  showSearchScore boolean
  
  Default value is false.
  
  suppressLogs boolean
  
  Default value is false.
  
  allowDeletedRelations boolean
  
  Default value is false.
  
  query string
  
  Full DSL query that was received to produce these results, but encoded as a string rather than a JSON object.
- entities array[object]
  
  Details of a single result from a search.
  typeName string
  
  Name of the type definition that defines this instance.
  
  attributes object | null
  
  Attributes that can exist across all assets in Atlan.
  
  qualifiedName string
  
  Unique name for this asset. This is typically a concatenation of the asset's name onto its parent's qualifiedName.
  
  name string
  
  Human-readable name of the asset.
  
  classifications array[object] | null
  
  Instance of a classification in Atlan, with its detailed information.
  
  typeName string
  
  Name of the classification. Note that this is the static-hashed unique name of the classification, not the human-readable displayName.
  
  entityGuid string
  
  Unique identifier of the entity to which this classification is attached.
  
  propagate boolean | null
  
  Whether to propagate this classification to other entities related to the entity to which the classification is attached.
  
  removePropagationsOnEntityDelete boolean | null
  
  Whether to remove this classification from other entities to which it has been propagated when the classification is removed from this entity.
  
  entityStatus string | null
  
  Status of the entity to which this classification is attached.
  
  Values are ACTIVE or DELETED.
  
  displayText string | null
  
  Human-readable name of the entity.
  
  guid string
  
  Unique identifier of the entity instance.
  
  isIncomplete boolean | null
  
  Default value is false.
  
  createdBy string | null
  
  Username of the user who created the object.
  
  updatedBy string | null
  
  Username of the user who last updated the object.
  
  createTime integer | null
  
  Time (epoch) at which this object was created, in milliseconds.
  
  updateTime integer | null
  
  Time (epoch) at which this object was last updated, in milliseconds.
  
  version integer | null
  
  Version of this object.
  
  classificationNames array[string] | null
  
  List of classifications for this entity. Note that these are the internal hashed names used in Atlan, not the displayText of the classification.
  
  labels array[string] | null
  
  Internal use only.
  
  status string
  
  Status of the entity, either ACTIVE or DELETED.
  
  Values are ACTIVE or DELETED.
  
  meaningNames array[string] Deprecated
  
  Unused.
  
  meanings array[object] Deprecated
  
  Unused.
- approximateCount integer
  
  Approximate count of the total number of results.

POST /api/meta/search/indexsearch#findAssetByExactName

curl \
 -X POST https://tenant.atlan.com/api/meta/search/indexsearch#findAssetByExactName \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"dsl":{"from":0,"size":20,"query":{"bool":{"must":[{"match":{"__state":"ACTIVE"}},{"match":{"__typeName.keyword":"AtlasGlossaryTerm"}},{"match":{"name.keyword":"Customer Acquisition Cost"}}]}}},"attributes":["anchor","userDescription","certificateStatus","announcementMessage","announcementTitle","announcementType","ownerUsers","ownerGroups"],"relationAttributes":["certificateStatus","name","description","qualifiedName"]}'

Request example

{
  "dsl": {
    "from": 0,
    "size": 20,
    "query": {
      "bool": {
        "must": [
          {
            "match": {
              "__state": "ACTIVE"
            }
          },
          {
            "match": {
              "__typeName.keyword": "AtlasGlossaryTerm"
            }
          },
          {
            "match": {
              "name.keyword": "Customer Acquisition Cost"
            }
          }
        ]
      }
    }
  },
  "attributes": [
    "anchor",
    "userDescription",
    "certificateStatus",
    "announcementMessage",
    "announcementTitle",
    "announcementType",
    "ownerUsers",
    "ownerGroups"
  ],
  "relationAttributes": [
    "certificateStatus",
    "name",
    "description",
    "qualifiedName"
  ]
}

Response example (200)

{
  "searchParameters": {
    "attributes": [
      "anchor",
      "userDescription",
      "certificateStatus",
      "announcementMessage",
      "announcementTitle",
      "announcementType",
      "ownerUsers",
      "ownerGroups"
    ],
    "relationAttributes": [
      "certificateStatus",
      "name",
      "description",
      "qualifiedName"
    ],
    "query": "{\"from\":0,\"size\":20,\"query\":{\"bool\":{\"must\":[{\"match\": {\"__state\":\"ACTIVE\"}},{\"match\":{\"__typeName.keyword\": \"AtlasGlossaryTerm\"}},{\"match\":{\"name.keyword\": \"Customer Acquisition Cost\"}}]}}}"
  },
  "entities": [
    {
      "typeName": "AtlasGlossaryTerm",
      "attributes": {
        "certificateStatus": "VERIFIED",
        "ownerGroups": [],
        "userDescription": "The average amount spent in order to acquire a customer. CAC is calculated by dividing the total amount spent on acquisition activities by the total number of customers acquired during a certain time period. The acquisition activity costs cover various efforts including business development and marketing, as well as salaries, external consultancy fees, and technology costs.",
        "qualifiedName": "qIJpoOZHEQjIv460a4DTy@vdLN8ETB3KiDLTzoDcT6j",
        "anchor": {
          "guid": "97eb9009-f355-4700-9bfa-0d202051d9e2",
          "typeName": "AtlasGlossary",
          "attributes": {
            "certificateStatus": "VERIFIED",
            "name": "Metrics"
          },
          "uniqueAttributes": {
            "qualifiedName": "vdLN8ETB3KiDLTzoDcT6j"
          }
        },
        "name": "Customer Acquisition Cost",
        "announcementTitle": "Calculation moved to complex method from Jan 2022 onwards",
        "announcementMessage": "Please refer to the readme for detailed differences between the calculation methods.",
        "ownerUsers": [
          "jdoe"
        ]
      },
      "guid": "af6a32d4-936b-4a59-9917-7082c56ba443",
      "status": "ACTIVE",
      "displayText": "Customer Acquisition Cost",
      "classificationNames": [
        "J5q2QzErHG4unHTA0C5GE0"
      ],
      "classifications": [
        {
          "typeName": "J5q2QzErHG4unHTA0C5GE0",
          "entityGuid": "af6a32d4-936b-4a59-9917-7082c56ba443",
          "entityStatus": "ACTIVE",
          "propagate": true,
          "removePropagationsOnEntityDelete": true
        }
      ],
      "meaningNames": [],
      "meanings": [],
      "isIncomplete": false,
      "labels": [],
      "createdBy": "jsmith",
      "updatedBy": "jdoe",
      "createTime": 1646914776550,
      "updateTime": 1651168541536
    }
  ],
  "approximateCount": 1
}

Find classified assets

POST /api/meta/search/indexsearch#findClassifiedAssets

Search for assets that have at least one classification.

Body Required

Query to run the search.

Replace the value for __typeName.keyword with the name of the asset type
Replace the value for qualifiedName with the partial qualified name of the assets (you could also remove the qualifiedName condition entirely to look for all assets that have classifications)
The range condition ensures that only columns that have been changed (e.g. classified) after a certain date and time are returned. This could also be removed, but shows an example of how to retrieve a "delta" since some specific point in time.

This example specifically searches for:

all columns in any table under the ATLAN_SAMPLE_DATA.FOOD_BEVERAGE schema on Snowflake (the prefix condition acts as a "starts-with" comparison)
that have at least one classification (handled by checking for the existence of the __classificationNames property)
that have been modified on or after 7 March 2022 14:28:38.537 (handled by the range condition)
and sorts the results in a consistent (but undefined) order (for paging) (handled by the sort by _doc)

In addition to the default set of properties returned in a search, this request will also retrieve:

the names of propagated classifications for each column (if any)

dsl object Required

Search query for Atlan. This uses the Elastic Query DSL, which will not be fully described here due to its complexity.
- from integer
  
  Starting point of results for paging.
  
  Default value is 0.
- size integer
  
  Maximum number of results to return (for paging).
- sort array[object] | null
  
  How the results should be sorted.
- query object | null Required
  
  Query in Elastic's Query DSL.
- post_filter object | null
  
  Optional mechanism to further filter search results. (See Elastic's post filter details.)
attributes array[string] | null

List of attribute names to include on each result. These attributes should exist on the assets being searched.
relationAttributes array[string] | null

List of attribute names to include on each relationship included in the results. These attributes should exist on at least one of the relationships that could be returned on one of the assets in the results.

Responses

• 200 object

Assets that exactly match the specified parameters. In the case of this example, only columns in the ATLAN_SAMPLE_DATA.FOOD_BEVERAGE schema of Snowflake that have at least one classification and were modified on or after a particular date and time.
- queryType string
  
  Type of query.
  
  Value is INDEX.
- searchParameters object
  
  Details of the query that was run. These can be used to re-run precisely the same query for paging.
  attributes array[string]
  
  List of attribute names requested to be included on each result.
  
  relationAttributes array[string]
  
  List of attribute names requested to be included on each relationship included in the results.
  
  showSearchScore boolean
  
  Default value is false.
  
  suppressLogs boolean
  
  Default value is false.
  
  allowDeletedRelations boolean
  
  Default value is false.
  
  query string
  
  Full DSL query that was received to produce these results, but encoded as a string rather than a JSON object.
- entities array[object]
  
  Details of a single result from a search.
  typeName string
  
  Name of the type definition that defines this instance.
  
  attributes object | null
  
  Attributes that can exist across all assets in Atlan.
  
  qualifiedName string
  
  Unique name for this asset. This is typically a concatenation of the asset's name onto its parent's qualifiedName.
  
  name string
  
  Human-readable name of the asset.
  
  classifications array[object] | null
  
  Instance of a classification in Atlan, with its detailed information.
  
  typeName string
  
  Name of the classification. Note that this is the static-hashed unique name of the classification, not the human-readable displayName.
  
  entityGuid string
  
  Unique identifier of the entity to which this classification is attached.
  
  propagate boolean | null
  
  Whether to propagate this classification to other entities related to the entity to which the classification is attached.
  
  removePropagationsOnEntityDelete boolean | null
  
  Whether to remove this classification from other entities to which it has been propagated when the classification is removed from this entity.
  
  entityStatus string | null
  
  Status of the entity to which this classification is attached.
  
  Values are ACTIVE or DELETED.
  
  displayText string | null
  
  Human-readable name of the entity.
  
  guid string
  
  Unique identifier of the entity instance.
  
  isIncomplete boolean | null
  
  Default value is false.
  
  createdBy string | null
  
  Username of the user who created the object.
  
  updatedBy string | null
  
  Username of the user who last updated the object.
  
  createTime integer | null
  
  Time (epoch) at which this object was created, in milliseconds.
  
  updateTime integer | null
  
  Time (epoch) at which this object was last updated, in milliseconds.
  
  version integer | null
  
  Version of this object.
  
  classificationNames array[string] | null
  
  List of classifications for this entity. Note that these are the internal hashed names used in Atlan, not the displayText of the classification.
  
  labels array[string] | null
  
  Internal use only.
  
  status string
  
  Status of the entity, either ACTIVE or DELETED.
  
  Values are ACTIVE or DELETED.
  
  meaningNames array[string] Deprecated
  
  Unused.
  
  meanings array[object] Deprecated
  
  Unused.
- approximateCount integer
  
  Approximate count of the total number of results.

POST /api/meta/search/indexsearch#findClassifiedAssets

curl \
 -X POST https://tenant.atlan.com/api/meta/search/indexsearch#findClassifiedAssets \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"dsl":{"from":0,"size":100,"query":{"bool":{"must":[{"match":{"__state":"ACTIVE"}},{"match":{"__typeName.keyword":"Column"}},{"prefix":{"qualifiedName":"default/snowflake/1646904424/ATLAN_SAMPLE_DATA/FOOD_BEVERAGE"}},{"exists":{"field":"__classificationNames"}},{"range":{"__modificationTimestamp":{"gte":1646663318537}}}]}},"sort":[{"_doc":"asc"}]},"attributes":["__propagatedClassificationNames"]}'

Request example

{
  "dsl": {
    "from": 0,
    "size": 100,
    "query": {
      "bool": {
        "must": [
          {
            "match": {
              "__state": "ACTIVE"
            }
          },
          {
            "match": {
              "__typeName.keyword": "Column"
            }
          },
          {
            "prefix": {
              "qualifiedName": "default/snowflake/1646904424/ATLAN_SAMPLE_DATA/FOOD_BEVERAGE"
            }
          },
          {
            "exists": {
              "field": "__classificationNames"
            }
          },
          {
            "range": {
              "__modificationTimestamp": {
                "gte": 1646663318537
              }
            }
          }
        ]
      }
    },
    "sort": [
      {
        "_doc": "asc"
      }
    ]
  },
  "attributes": [
    "__propagatedClassificationNames"
  ]
}

Response example (200)

{
  "searchParameters": {
    "attributes": [
      "__propagatedClassificationNames"
    ],
    "query": "{\"from\":0,\"size\":100,\"query\":{\"bool\":{\"must\":[{\"match\": {\"__state\":\"ACTIVE\"}},{\"match\":{\"__typeName.keyword\": \"Column\"}},{\"prefix\":{\"qualifiedName\": \"default/snowflake/1646904424/ATLAN_SAMPLE_DATA/FOOD_BEVERAGE\" }},{\"exists\":{\"field\":\"__classificationNames\"}},{\"range\": {\"__modificationTimestamp\":{\"gte\":1646663318537}}}]}}, \"sort\":[{\"_doc\":\"asc\"}]}"
  },
  "entities": [
    {
      "typeName": "Column",
      "attributes": {
        "qualifiedName": "default/snowflake/1646904424/ATLAN_SAMPLE_DATA/FOOD_BEVERAGE/INSTACART_BEVERAGES_ORDER_CUSTOMER/aisle_id",
        "__propagatedClassificationNames": "||J5q2QzErHG4unHTA0C5GE0|EO7Gp8Y6xeI1JHctrlpQhB|",
        "name": "aisle_id",
        "description": "Unique ID of the sub-category"
      },
      "guid": "4663f2d6-8b12-4f65-b94c-7407af10034d",
      "status": "ACTIVE",
      "displayText": "aisle_id",
      "classificationNames": [
        "J5q2QzErHG4unHTA0C5GE0",
        "EO7Gp8Y6xeI1JHctrlpQhB"
      ],
      "classifications": [
        {
          "typeName": "J5q2QzErHG4unHTA0C5GE0",
          "entityGuid": "af6a32d4-936b-4a59-9917-7082c56ba443",
          "entityStatus": "ACTIVE",
          "propagate": true,
          "removePropagationsOnEntityDelete": true
        },
        {
          "typeName": "EO7Gp8Y6xeI1JHctrlpQhB",
          "entityGuid": "85d141c2-d383-4b4f-93a5-c3eed20988b9",
          "entityStatus": "ACTIVE",
          "propagate": true,
          "removePropagationsOnEntityDelete": true
        }
      ],
      "meaningNames": [],
      "meanings": [],
      "isIncomplete": false,
      "labels": [],
      "createdBy": "jsmith",
      "updatedBy": "jdoe",
      "createTime": 1646904643794,
      "updateTime": 1650525230506
    },
    {
      "typeName": "Column",
      "attributes": {
        "qualifiedName": "default/snowflake/1646904424/ATLAN_SAMPLE_DATA/FOOD_BEVERAGE/INSTACART_SNACKS_ORDER_CUSTOMER/CUSTOMER_NAME",
        "__propagatedClassificationNames": "|hzX4hL2bKPtRXWYCODzESy|VwN5VzRHlHVIWB4cbaxM5R |JfGBE5IoFmlJJ1r8xWkol4|EO7Gp8Y6xeI1JHctrlpQhB |J5q2QzErHG4unHTA0C5GE0|EO7Gp8Y6xeI1JHctrlpQhB|",
        "name": "CUSTOMER_NAME",
        "description": "Full name of the user"
      },
      "guid": "4ee204fc-ed37-4f32-9dd6-e393a81f2b01",
      "status": "ACTIVE",
      "displayText": "CUSTOMER_NAME",
      "classificationNames": [
        "hzX4hL2bKPtRXWYCODzESy",
        "EO7Gp8Y6xeI1JHctrlpQhB",
        "VwN5VzRHlHVIWB4cbaxM5R",
        "JfGBE5IoFmlJJ1r8xWkol4",
        "EO7Gp8Y6xeI1JHctrlpQhB",
        "J5q2QzErHG4unHTA0C5GE0",
        "EO7Gp8Y6xeI1JHctrlpQhB"
      ],
      "classifications": [
        {
          "typeName": "hzX4hL2bKPtRXWYCODzESy",
          "entityGuid": "a72189a2-f833-4ef3-bc8d-7d2c7d761c4f",
          "entityStatus": "ACTIVE",
          "propagate": true,
          "removePropagationsOnEntityDelete": true
        },
        {
          "typeName": "EO7Gp8Y6xeI1JHctrlpQhB",
          "entityGuid": "4ee204fc-ed37-4f32-9dd6-e393a81f2b01",
          "entityStatus": "ACTIVE",
          "propagate": true,
          "removePropagationsOnEntityDelete": false
        },
        {
          "typeName": "VwN5VzRHlHVIWB4cbaxM5R",
          "entityGuid": "a72189a2-f833-4ef3-bc8d-7d2c7d761c4f",
          "entityStatus": "ACTIVE",
          "propagate": true,
          "removePropagationsOnEntityDelete": true
        },
        {
          "typeName": "JfGBE5IoFmlJJ1r8xWkol4",
          "entityGuid": "a72189a2-f833-4ef3-bc8d-7d2c7d761c4f",
          "entityStatus": "ACTIVE",
          "propagate": true,
          "removePropagationsOnEntityDelete": true
        },
        {
          "typeName": "EO7Gp8Y6xeI1JHctrlpQhB",
          "entityGuid": "aea9c165-859d-44b9-991f-b8624f60f57a",
          "entityStatus": "ACTIVE",
          "propagate": true,
          "removePropagationsOnEntityDelete": true
        },
        {
          "typeName": "J5q2QzErHG4unHTA0C5GE0",
          "entityGuid": "a72189a2-f833-4ef3-bc8d-7d2c7d761c4f",
          "entityStatus": "ACTIVE",
          "propagate": true,
          "removePropagationsOnEntityDelete": true
        },
        {
          "typeName": "EO7Gp8Y6xeI1JHctrlpQhB",
          "entityGuid\"": "d1181026-9050-4748-ae0a-236e511df26f",
          "entityStatus": "ACTIVE",
          "propagate": true,
          "removePropagationsOnEntityDelete": true
        }
      ],
      "meaningNames": [
        "Name of Person"
      ],
      "meanings": [
        {
          "termGuid": "aea9c165-859d-44b9-991f-b8624f60f57a",
          "relationGuid": "84eaf158-8bdf-4a3d-b096-1a9d43df8f38",
          "displayText": "Name of Person",
          "confidence": 0
        }
      ],
      "isIncomplete": false,
      "labels": [],
      "createdBy": "jsmith",
      "updatedBy": "jdoe",
      "createTime": 1646904620363,
      "updateTime": 1650524555809
    }
  ],
  "approximateCount": 2
}

Find assets by type

POST /api/meta/search/indexsearch#findTablesInSchema

Search for all assets with a given type.

Body Required

Query to run the search.

Replace the __typeName.keyword with the name of the asset type
Provide additional criteria to narrow your results (in this example, the qualifiedName prefix)

This example specifically searches for all tables within the ATLAN_SAMPLE_DATA.FOOD_BEVERAGE schema. Note that you should specify additional limiting criteria: in general you want a search to return less than 10,000 results or the overall result set may be truncated.

In addition to the default set of properties returned in a search, this request will also retrieve:

the table's columns
the table's certificate status

For the related object (the table's columns) it will also retrieve the columns':

name
data type

dsl object Required

Search query for Atlan. This uses the Elastic Query DSL, which will not be fully described here due to its complexity.
- from integer
  
  Starting point of results for paging.
  
  Default value is 0.
- size integer
  
  Maximum number of results to return (for paging).
- sort array[object] | null
  
  How the results should be sorted.
- query object | null Required
  
  Query in Elastic's Query DSL.
- post_filter object | null
  
  Optional mechanism to further filter search results. (See Elastic's post filter details.)
attributes array[string] | null

List of attribute names to include on each result. These attributes should exist on the assets being searched.
relationAttributes array[string] | null

List of attribute names to include on each relationship included in the results. These attributes should exist on at least one of the relationships that could be returned on one of the assets in the results.

Responses

• 200 object

Assets that exactly match the specified parameters. In the case of this example, all tables in the ATLAN_SAMPLE_DATA.FOOD_BEVERAGE schema and all of their columns (including name and data type of each column).
- queryType string
  
  Type of query.
  
  Value is INDEX.
- searchParameters object
  
  Details of the query that was run. These can be used to re-run precisely the same query for paging.
  attributes array[string]
  
  List of attribute names requested to be included on each result.
  
  relationAttributes array[string]
  
  List of attribute names requested to be included on each relationship included in the results.
  
  showSearchScore boolean
  
  Default value is false.
  
  suppressLogs boolean
  
  Default value is false.
  
  allowDeletedRelations boolean
  
  Default value is false.
  
  query string
  
  Full DSL query that was received to produce these results, but encoded as a string rather than a JSON object.
- entities array[object]
  
  Details of a single result from a search.
  typeName string
  
  Name of the type definition that defines this instance.
  
  attributes object | null
  
  Attributes that can exist across all assets in Atlan.
  
  qualifiedName string
  
  Unique name for this asset. This is typically a concatenation of the asset's name onto its parent's qualifiedName.
  
  name string
  
  Human-readable name of the asset.
  
  classifications array[object] | null
  
  Instance of a classification in Atlan, with its detailed information.
  
  typeName string
  
  Name of the classification. Note that this is the static-hashed unique name of the classification, not the human-readable displayName.
  
  entityGuid string
  
  Unique identifier of the entity to which this classification is attached.
  
  propagate boolean | null
  
  Whether to propagate this classification to other entities related to the entity to which the classification is attached.
  
  removePropagationsOnEntityDelete boolean | null
  
  Whether to remove this classification from other entities to which it has been propagated when the classification is removed from this entity.
  
  entityStatus string | null
  
  Status of the entity to which this classification is attached.
  
  Values are ACTIVE or DELETED.
  
  displayText string | null
  
  Human-readable name of the entity.
  
  guid string
  
  Unique identifier of the entity instance.
  
  isIncomplete boolean | null
  
  Default value is false.
  
  createdBy string | null
  
  Username of the user who created the object.
  
  updatedBy string | null
  
  Username of the user who last updated the object.
  
  createTime integer | null
  
  Time (epoch) at which this object was created, in milliseconds.
  
  updateTime integer | null
  
  Time (epoch) at which this object was last updated, in milliseconds.
  
  version integer | null
  
  Version of this object.
  
  classificationNames array[string] | null
  
  List of classifications for this entity. Note that these are the internal hashed names used in Atlan, not the displayText of the classification.
  
  labels array[string] | null
  
  Internal use only.
  
  status string
  
  Status of the entity, either ACTIVE or DELETED.
  
  Values are ACTIVE or DELETED.
  
  meaningNames array[string] Deprecated
  
  Unused.
  
  meanings array[object] Deprecated
  
  Unused.
- approximateCount integer
  
  Approximate count of the total number of results.

POST /api/meta/search/indexsearch#findTablesInSchema

curl \
 -X POST https://tenant.atlan.com/api/meta/search/indexsearch#findTablesInSchema \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"dsl":{"from":0,"size":100,"query":{"bool":{"must":[{"match":{"__state":"ACTIVE"}},{"match":{"__typeName.keyword":"Table"}},{"prefix":{"qualifiedName":"default/snowflake/1646904424/ATLAN_SAMPLE_DATA/FOOD_BEVERAGE"}}]}},"sort":[{"_doc":"asc"}]},"attributes":["certificateStatus","columns"],"relationAttributes":["name","dataType"]}'

Request example

{
  "dsl": {
    "from": 0,
    "size": 100,
    "query": {
      "bool": {
        "must": [
          {
            "match": {
              "__state": "ACTIVE"
            }
          },
          {
            "match": {
              "__typeName.keyword": "Table"
            }
          },
          {
            "prefix": {
              "qualifiedName": "default/snowflake/1646904424/ATLAN_SAMPLE_DATA/FOOD_BEVERAGE"
            }
          }
        ]
      }
    },
    "sort": [
      {
        "_doc": "asc"
      }
    ]
  },
  "attributes": [
    "certificateStatus",
    "columns"
  ],
  "relationAttributes": [
    "name",
    "dataType"
  ]
}

Response example (200)

{
  "searchParameters": {
    "attributes": [
      "certificateStatus",
      "columns"
    ],
    "relationAttributes": [
      "name",
      "dataType"
    ],
    "query": "{\"from\":0,\"size\":100,\"query\":{\"bool\":{\"must\":[{\"match\": {\"__state\":\"ACTIVE\"}},{\"match\":{\"__typeName.keyword\": \"Table\"}},{\"prefix\":{\"qualifiedName\": \"default/snowflake/1646904424/ ATLAN_SAMPLE_DATA/FOOD_BEVERAGE\" }}]}},\"sort\":[{\"_doc\":\"asc\"}]}"
  },
  "entities": [
    {
      "typeName": "Table",
      "attributes": {
        "certificateStatus": "VERIFIED",
        "qualifiedName": "default/snowflake/1646904424/ATLAN_SAMPLE_DATA/ FOOD_BEVERAGE/SALES_MKT_EXPENSES",
        "columns": [
          {
            "guid": "6fd50ecc-2101-434f-891e-1cebeda516c9",
            "typeName": "Column",
            "attributes": {
              "dataType": "VARCHAR",
              "name": "MKT_CATEGORY"
            },
            "uniqueAttributes": {
              "qualifiedName": "default/snowflake/1646904424/ATLAN_SAMPLE_DATA/ FOOD_BEVERAGE/SALES_MKT_EXPENSES/MKT_CATEGORY"
            }
          },
          {
            "guid": "c9f68471-4bac-4ade-a795-ce8a7df3ead9",
            "typeName": "Column",
            "attributes": {
              "dataType": "VARCHAR",
              "name": "MKT_MEDIUM_NAME"
            },
            "uniqueAttributes": {
              "qualifiedName": "default/snowflake/1646904424/ATLAN_SAMPLE_DATA/ FOOD_BEVERAGE/SALES_MKT_EXPENSES/MKT_MEDIUM_NAME"
            }
          },
          {
            "guid": "d4d61d80-7550-4fa5-9da6-7d89b167175a",
            "typeName": "Column",
            "attributes": {
              "dataType": "NUMBER",
              "name": "MKT_SPEND"
            },
            "uniqueAttributes": {
              "qualifiedName": "default/snowflake/1646904424/ATLAN_SAMPLE_DATA/ FOOD_BEVERAGE/SALES_MKT_EXPENSES/MKT_SPEND"
            }
          },
          {
            "guid": "256bea3e-b214-4e02-ae99-f9bb9a8b7d5c",
            "typeName": "Column",
            "attributes": {
              "dataType": "NUMBER",
              "name": "MKT_MEDIUM_ID"
            },
            "uniqueAttributes": {
              "qualifiedName": "default/snowflake/1646904424/ATLAN_SAMPLE_DATA/ FOOD_BEVERAGE/SALES_MKT_EXPENSES/MKT_MEDIUM_ID"
            }
          }
        ],
        "name": "SALES_MKT_EXPENSES",
        "description": "All the expenses for the sales and marketing team"
      },
      "guid": "035c6998-ab30-4b7c-861b-fe6c36550a41",
      "status": "ACTIVE",
      "displayText": "SALES_MKT_EXPENSES",
      "classificationNames": [],
      "classifications": [],
      "meaningNames": [],
      "meanings": [],
      "isIncomplete": false,
      "labels": [],
      "createdBy": "jsmith",
      "updatedBy": "jdoe",
      "createTime": 1646904590693,
      "updateTime": 1646912069460
    }
  ],
  "approximateCount": 1
}

Find child assets by parent qualifiedName

POST /api/meta/search/indexsearch#findChildAssets

Search for child assets using prefix match on qualifiedName of the parent asset. The search result will work on the asset hierarchy based on qualifiedName. The request example shows the child assets of a table, which in this case would be columns.

Body Required

Query to run the search.
In case, prefix of say a schema is passed in prefix all underlying assets
(tables and columns in this case) would be returned

You can chose to restrict the asset type by mentioning
the specific typeName as in the example below.

dsl object Required

Search query for Atlan. This uses the Elastic Query DSL, which will not be fully described here due to its complexity.
- from integer
  
  Starting point of results for paging.
  
  Default value is 0.
- size integer
  
  Maximum number of results to return (for paging).
- sort array[object] | null
  
  How the results should be sorted.
- query object | null Required
  
  Query in Elastic's Query DSL.
- post_filter object | null
  
  Optional mechanism to further filter search results. (See Elastic's post filter details.)
attributes array[string] | null

List of attribute names to include on each result. These attributes should exist on the assets being searched.
relationAttributes array[string] | null

List of attribute names to include on each relationship included in the results. These attributes should exist on at least one of the relationships that could be returned on one of the assets in the results.

Responses

• 200 object

Assets that exactly have the prefix as the qualifiedName value would be returned. In this case since the qualifiedName is of a table, columns will be returned. Since the typeName is set to Column even with qualifiedName of a schema is passed, only underlying columns would be returned.
- queryType string
  
  Type of query.
  
  Value is INDEX.
- searchParameters object
  
  Details of the query that was run. These can be used to re-run precisely the same query for paging.
  attributes array[string]
  
  List of attribute names requested to be included on each result.
  
  relationAttributes array[string]
  
  List of attribute names requested to be included on each relationship included in the results.
  
  showSearchScore boolean
  
  Default value is false.
  
  suppressLogs boolean
  
  Default value is false.
  
  allowDeletedRelations boolean
  
  Default value is false.
  
  query string
  
  Full DSL query that was received to produce these results, but encoded as a string rather than a JSON object.
- entities array[object]
  
  Details of a single result from a search.
  typeName string
  
  Name of the type definition that defines this instance.
  
  attributes object | null
  
  Attributes that can exist across all assets in Atlan.
  
  qualifiedName string
  
  Unique name for this asset. This is typically a concatenation of the asset's name onto its parent's qualifiedName.
  
  name string
  
  Human-readable name of the asset.
  
  classifications array[object] | null
  
  Instance of a classification in Atlan, with its detailed information.
  
  typeName string
  
  Name of the classification. Note that this is the static-hashed unique name of the classification, not the human-readable displayName.
  
  entityGuid string
  
  Unique identifier of the entity to which this classification is attached.
  
  propagate boolean | null
  
  Whether to propagate this classification to other entities related to the entity to which the classification is attached.
  
  removePropagationsOnEntityDelete boolean | null
  
  Whether to remove this classification from other entities to which it has been propagated when the classification is removed from this entity.
  
  entityStatus string | null
  
  Status of the entity to which this classification is attached.
  
  Values are ACTIVE or DELETED.
  
  displayText string | null
  
  Human-readable name of the entity.
  
  guid string
  
  Unique identifier of the entity instance.
  
  isIncomplete boolean | null
  
  Default value is false.
  
  createdBy string | null
  
  Username of the user who created the object.
  
  updatedBy string | null
  
  Username of the user who last updated the object.
  
  createTime integer | null
  
  Time (epoch) at which this object was created, in milliseconds.
  
  updateTime integer | null
  
  Time (epoch) at which this object was last updated, in milliseconds.
  
  version integer | null
  
  Version of this object.
  
  classificationNames array[string] | null
  
  List of classifications for this entity. Note that these are the internal hashed names used in Atlan, not the displayText of the classification.
  
  labels array[string] | null
  
  Internal use only.
  
  status string
  
  Status of the entity, either ACTIVE or DELETED.
  
  Values are ACTIVE or DELETED.
  
  meaningNames array[string] Deprecated
  
  Unused.
  
  meanings array[object] Deprecated
  
  Unused.
- approximateCount integer
  
  Approximate count of the total number of results.

POST /api/meta/search/indexsearch#findChildAssets

curl \
 -X POST https://tenant.atlan.com/api/meta/search/indexsearch#findChildAssets \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"dsl":{"from":0,"size":1,"query":{"bool":{"must":[{"match":{"__state":"ACTIVE"}},{"match":{"__typeName.keyword":"Column"}},{"prefix":{"qualifiedName":"default/snowflake/1646904424/ATLAN_SAMPLE_DATA/FOOD_BEVERAGE"}}]}}}}'

Request example

{
  "dsl": {
    "from": 0,
    "size": 1,
    "query": {
      "bool": {
        "must": [
          {
            "match": {
              "__state": "ACTIVE"
            }
          },
          {
            "match": {
              "__typeName.keyword": "Column"
            }
          },
          {
            "prefix": {
              "qualifiedName": "default/snowflake/1646904424/ATLAN_SAMPLE_DATA/FOOD_BEVERAGE"
            }
          }
        ]
      }
    }
  }
}

Response example (200)

{
  "searchParameters": {
    "showSearchScore": false,
    "suppressLogs": false,
    "allowDeletedRelations": false,
    "query": "{\\\"from\\\":0,\\\"size\\\":1,\\\"query\\\":{\\\"bool\\\":{\\\"must\\\":[{\\\"matc h\\\":{\\\"__state\\\":\\\"ACTIVE\\\"}},{\\\"match\\\":{\\\"__typeName.key word\\\":\\\"Column\\\"}},{\\\"prefix\\\":{\\ \"qualifiedName\\\":\\\"default/snowflake/1646749526\\\"}}]}}}"
  },
  "entities": [
    {
      "typeName": "Column",
      "attributes": {
        "qualifiedName": "default/snowflake/1646749526/ATLAN_SAMPLE_DATA/FOOD_BEVERAGE/INSTACART_BEVERAGES_ORDER_CUSTOMER/aisle_id",
        "name": "aisle_id",
        "description": "Unique ID of the sub-category"
      },
      "guid": "4663f2d6-8b12-4f65-b94c-7407af10034d",
      "status": "ACTIVE",
      "displayText": "aisle_id",
      "classificationNames": [
        "J5q2QzErHG4unHTA0C5GE0",
        "EO7Gp8Y6xeI1JHctrlpQhB"
      ],
      "classifications": [
        {
          "typeName": "J5q2QzErHG4unHTA0C5GE0",
          "entityGuid": "af6a32d4-936b-4a59-9917-7082c56ba443",
          "entityStatus": "ACTIVE",
          "propagate": true,
          "removePropagationsOnEntityDelete": true
        },
        {
          "typeName": "EO7Gp8Y6xeI1JHctrlpQhB",
          "entityGuid": "85d141c2-d383-4b4f-93a5-c3eed20988b9",
          "entityStatus": "ACTIVE",
          "propagate": true,
          "removePropagationsOnEntityDelete": true
        }
      ],
      "meaningNames": [],
      "meanings": [],
      "isIncomplete": false,
      "labels": [],
      "createdBy": "jsmith",
      "updatedBy": "jdoe",
      "createTime": 1646904643794,
      "updateTime": 1650525230506
    }
  ],
  "approximateCount": 14
}

All assets

Operations on all assets (data assets, BI assets, etc).

There are certain operations that can be done across all assets in Atlan. These are listed below, rather than separately for every asset (since they will be identical). For more detailed explanations of these, and additional examples, see our Developer Portal.

Operations

GET: /api/meta/entity/guid/{guid}
DELETE: /api/meta/entity/guid/{guid}
GET: /api/meta/entity/uniqueAttribute/type/{typeName}
POST: /api/meta/entity/auditSearch
POST: /api/meta/entity/guid/{guid}/businessmetadata/displayName
POST: /api/meta/entity/bulk/classification/displayName
POST: /api/meta/entity/bulk#attachGlossaryTerm
POST: /api/meta/entity/bulk#addReadme
POST: /api/meta/entity/bulk#changeDescription
POST: /api/meta/entity/bulk#changeCertificate
POST: /api/meta/entity/bulk#changeAnnouncement
POST: /api/meta/entity/bulk#changeOwners
DELETE: /api/meta/entity/bulk#bulk_delete_assets

Get asset by GUID

GET /api/meta/entity/guid/{guid}

Retrieve details of an asset (table, schema, etc) by its GUID. By default the full details of the asset are returned, including: attributes, relationships, and classifications.

Path parameters

guid string(uuid) Required

Unique identifier of the entity to retrieve.

Query parameters

ignoreRelationships boolean

When true, will not retrieve details about the asset's relationships.
minExtInfo boolean

When true, will minimize the extra details retrieved about an asset.

Responses

• 200 object

Entity in its current state.
- entity object
  
  Instance of an entity in Atlan, with its detailed information.
  typeName string
  
  Name of the type definition that defines this instance.
  
  attributes object | null
  
  Will be further documented in sub-types of EntityHeader.
  
  classifications array[object] | null
  
  Instance of a classification in Atlan, with its detailed information.
  
  typeName string
  
  Name of the classification. Note that this is the static-hashed unique name of the classification, not the human-readable displayName.
  
  entityGuid string
  
  Unique identifier of the entity to which this classification is attached.
  
  propagate boolean | null
  
  Whether to propagate this classification to other entities related to the entity to which the classification is attached.
  
  removePropagationsOnEntityDelete boolean | null
  
  Whether to remove this classification from other entities to which it has been propagated when the classification is removed from this entity.
  
  entityStatus string | null
  
  Status of the entity to which this classification is attached.
  
  Values are ACTIVE or DELETED.
  
  displayText string | null
  
  Human-readable name of the entity.
  
  guid string
  
  Unique identifier of the entity instance.
  
  isIncomplete boolean | null
  
  Default value is false.
  
  businessAttributes object | null
  
  Map of custom metadata attributes and values defined on the entity.
  
  relationshipAttributes object
  
  Map of relationships for the entity. The specific keys of this map will vary by type, so are described in the sub-types of this schema.
  
  createdBy string | null
  
  Username of the user who created the object.
  
  updatedBy string | null
  
  Username of the user who last updated the object.
  
  createTime integer | null
  
  Time (epoch) at which this object was created, in milliseconds.
  
  updateTime integer | null
  
  Time (epoch) at which this object was last updated, in milliseconds.
  
  version integer | null
  
  Version of this object.
  
  classificationNames array[string] | null
  
  List of classifications for this entity. Note that these are the internal hashed names used in Atlan, not the displayText of the classification.
  
  labels array[string] | null
  
  Internal use only.
  
  status string
  
  Status of the entity, either ACTIVE or DELETED.
  
  Values are ACTIVE or DELETED.
  
  customAttributes object | null
  
  Internal use only.
  
  Additional properties: string
  
  pendingTasks array[string] | null
  
  Internal use only.
- referredEntities object
  
  Map of related entities keyed by the GUID of the related entity. The values will be the detailed entity object of the related entity.
- typeName string
  
  Name of the type definition that defines this instance.
- attributes object | null
  
  Attributes that can exist across all assets in Atlan.
  qualifiedName string
  
  Unique name for this asset. This is typically a concatenation of the asset's name onto its parent's qualifiedName.
  
  name string
  
  Human-readable name of the asset.
  
  displayName string | null
  
  Name used for display purposes (in user interfaces).
  
  description string | null
  
  Description of the asset, as crawled from a source.
  
  userDescription string | null
  
  Description of the asset, as provided by a user. If present, this will be used for the description in user interfaces. If not present, the description will be used.
  
  tenantId string
  
  Name of the Atlan workspace in which the table exists.
  
  certificateStatus string | null
  
  Status of the asset's certification.
  
  Values are VERIFIED, DRAFT, or DEPRECATED.
  
  certificateStatusMessage string | null
  
  Human-readable descriptive message that can optionally be submitted when the certificateStatus is changed.
  
  announcementTitle string | null
  
  Brief title for the announcement on this asset. Required when announcementType is specified.
  
  announcementMessage string | null
  
  Detailed message to include in the announcement on this asset.
  
  announcementType string | null
  
  Type of announcement on the asset.
  
  Values are information, warning, or issue.
  
  ownerUsers array[string] | null
  
  List of users who own the asset.
  
  ownerGroups array[string] | null
  
  List of groups who own the asset.
  
  adminUsers array[string] | null
  
  List of users who administer the asset. (This is only used for Connection assets?)
  
  adminGroups array[string] | null
  
  List of groups who administer the asset. (This is only used for Connection assets?)
  
  viewerUsers array[string] | null
  
  viewerGroups array[string] | null
  
  connectorName string | null
  
  Name of the connector through which this asset is accessible.
  
  connectionName string | null Deprecated
  
  Unused.
  
  connectionQualifiedName string | null
  
  Unique name of the connection through which this asset is accessible.
  
  isDiscoverable boolean
  
  isEditable boolean
  
  subType object | null
  
  viewScore number | null
  
  popularityScore number | null
  
  sourceOwners array[string] | null
  
  sourceURL string | null
  
  lastSyncWorkflowName string | null
  
  Name of the crawler that last synchronized this asset.
  
  lastSyncRunAt integer | null
  
  Time (epoch) at which the table was last crawled, in milliseconds.
  
  lastSyncRun string | null
  
  Name of the last run of the crawler that last synchronized this asset.
  
  certificateUpdatedBy string | null
  
  Name of the user who last updated the certificateStatus.
  
  certificateUpdatedAt integer | null
  
  Time (epoch) at which the certificateStatus was last updated, in milliseconds.
  
  announcementUpdatedAt integer | null
  
  Time (epoch) at which the announcement was last updated, in milliseconds.
  
  announcementUpdatedBy string | null
  
  User who last updated the announcement.
  
  sourceCreatedBy string | null
  
  sourceCreatedAt integer | null
  
  sourceUpdatedAt integer | null
  
  sourceUpdatedBy string | null
- classifications array[object] | null
  
  Instance of a classification in Atlan.
  typeName string
  
  Name of the classification. Note that this is the static-hashed unique name of the classification, not the human-readable displayName.
  
  entityGuid string
  
  Unique identifier of the entity to which this classification is attached.
  
  propagate boolean | null
  
  Whether to propagate this classification to other entities related to the entity to which the classification is attached.
  
  removePropagationsOnEntityDelete boolean | null
  
  Whether to remove this classification from other entities to which it has been propagated when the classification is removed from this entity.
- displayText string | null
  
  Human-readable name of the entity.
- guid string
  
  Unique identifier of the entity instance.
- isIncomplete boolean | null
  
  Default value is false.
- businessAttributes object | null
  
  Map of custom metadata attributes and values defined on the entity.
- relationshipAttributes object | null
  
  Map of the relationships to this asset.
  links array[object]
  
  Details to use within an asset when referring to a link (resource).
  
  typeName string
  
  Should always be Link.
  
  guid string | null
  
  Unique identifier of the related link. If the uniqueAttributes are not provided, this must be provided.
  
  uniqueAttributes object | null
  
  Attribute(s) that uniquely identify the related link. If the guid is not provided, these must be provided.
  
  qualifiedName string
  
  Unique name of the related link. Note that this is a generated unique name which is not visible in the UI.
  
  readme object
  
  Details to use within an asset when referring to a readme.
  
  typeName string
  
  Should always be Readme.
  
  guid string | null
  
  Unique identifier of the related readme. If the uniqueAttributes are not provided, this must be provided.
  
  uniqueAttributes object | null
  
  Attribute(s) that uniquely identify the related readme. If the guid is not provided, these must be provided.
  
  qualifiedName string
  
  Unique name of the related readme.
  
  meanings array[object]
  
  Details to use within an asset when referring to a term.
  
  typeName string
  
  Should always be AtlasnGlossaryTerm.
  
  guid string | null
  
  Unique identifier of the related term. If the uniqueAttributes are not provided, this must be provided.
  
  uniqueAttributes object | null
  
  Attribute(s) that uniquely identify the related term. If the guid is not provided, these must be provided.
  
  qualifiedName string
  
  Unique name of the related term. Note that in Atlan this unique name is a hashed value, not the name you see in the UI.
• 404 object

Entity does not exist, or is deleted.
- errorCode string
  
  Unique code for the type of error that occurred.
- errorMessage string
  
  Human-readable description of the error that occurred.

GET /api/meta/entity/guid/{guid}

curl \
 -X GET https://tenant.atlan.com/api/meta/entity/guid/75403887-4241-45ab-8e0e-1508e61d75e4 \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response example (200)

{
  "referredEntities": {},
  "entity": {
    "typeName": "Column",
    "attributes": {
      "popularityScore": 1.17549435e-38,
      "lastSyncRunAt": 1646904481260,
      "databaseName": "ATLAN_SAMPLE_DATA",
      "defaultValue": null,
      "precision": 0,
      "__hasLineage": null,
      "lastSyncRun": "atlan-snowflake-default-snowflake-1646904424-ghj5h",
      "queryCountUpdatedAt": 0,
      "schemaName": "FOOD_BEVERAGE",
      "adminUsers": [],
      "tableName": "INSTACART_BEVERAGES_ORDER_CUSTOMER",
      "sourceURL": null,
      "queryUserCount": 0,
      "view": null,
      "isEditable": true,
      "sourceUpdatedAt": 0,
      "viewName": null,
      "isPartition": false,
      "announcementUpdatedAt": 0,
      "announcementTitle": null,
      "subDataType": null,
      "links": [],
      "validations": null,
      "order": 3,
      "certificateStatusMessage": null,
      "sourceCreatedAt": 0,
      "isIndexed": false,
      "qualifiedName": "default/snowflake/1646904424/ATLAN_SAMPLE_DATA/FOOD_BEVERAGE/INSTACART_BEVERAGES_ORDER_CUSTOMER/user_id",
      "dataType": "NUMBER",
      "pinnedBy": null,
      "isClustered": false,
      "isNullable": true,
      "name": "user_id",
      "certificateUpdatedAt": 0,
      "connectorName": "snowflake",
      "subType": null,
      "announcementUpdatedBy": null,
      "connectionName": null,
      "numericScale": 0,
      "maxLength": 0,
      "ownerUsers": [],
      "lastSyncWorkflowName": "dev-crawler",
      "isSort": false,
      "certificateStatus": null,
      "connectionQualifiedName": "default/snowflake/1646904424",
      "sourceCreatedBy": null,
      "replicatedFrom": null,
      "displayName": null,
      "isForeign": false,
      "description": "The unique ID for each customer",
      "queryCount": 0,
      "pinnedAt": 0,
      "isDist": false,
      "ownerGroups": [],
      "certificateUpdatedBy": null,
      "isPrimary": false,
      "isDiscoverable": true,
      "announcementType": null,
      "table": {
        "guid": "85d141c2-d383-4b4f-93a5-c3eed20988b9",
        "typeName": "Table"
      },
      "schemaQualifiedName": "default/snowflake/1646904424/ATLAN_SAMPLE_DATA/FOOD_BEVERAGE",
      "viewerUsers": [],
      "viewScore": 1.17549435e-38,
      "sourceOwners": null,
      "materialisedView": null,
      "replicatedTo": null,
      "userDescription": null,
      "adminGroups": [],
      "isPinned": false,
      "databaseQualifiedName": "default/snowflake/1646904424/ATLAN_SAMPLE_DATA",
      "viewQualifiedName": null,
      "readme": null,
      "queryUserMap": null,
      "queries": [],
      "sourceUpdatedBy": null,
      "tenantId": "default",
      "tableQualifiedName": "default/snowflake/1646904424/ATLAN_SAMPLE_DATA/FOOD_BEVERAGE/INSTACART_BEVERAGES_ORDER_CUSTOMER",
      "partitionOrder": 0,
      "tablePartition": null,
      "announcementMessage": null,
      "viewerGroups": []
    },
    "guid": "75403887-4241-45ab-8e0e-1508e61d75e4",
    "isIncomplete": false,
    "status": "ACTIVE",
    "createdBy": "service-account-apikey-9471cf12-f45c-4275-b280-3e01d26f57e8",
    "updatedBy": "admin",
    "createTime": 1646904631984,
    "updateTime": 1651675109912,
    "version": 0,
    "relationshipAttributes": {
      "inputToProcesses": [],
      "view": null,
      "materialisedView": null,
      "tablePartition": null,
      "links": [],
      "readme": null,
      "queries": [],
      "meanings": [],
      "table": {
        "guid": "85d141c2-d383-4b4f-93a5-c3eed20988b9",
        "typeName": "Table",
        "entityStatus": "ACTIVE",
        "displayText": "INSTACART_BEVERAGES_ORDER_CUSTOMER",
        "relationshipType": "table_columns",
        "relationshipGuid": "080815af-5dc6-49b4-a5ec-4523096f1bae",
        "relationshipStatus": "ACTIVE",
        "relationshipAttributes": {
          "typeName": "table_columns"
        },
        "outputFromProcesses": []
      }
    },
    "classifications": [
      {
        "typeName": "J5q2QzErHG4unHTA0C5GE0",
        "entityGuid": "af6a32d4-936b-4a59-9917-7082c56ba443",
        "entityStatus": "ACTIVE",
        "propagate": true,
        "removePropagationsOnEntityDelete": true
      }
    ],
    "customAttributes": {
      "character_octet_length": "",
      "is_auto_increment": "NO",
      "is_generated": "NO",
      "extra_info": "",
      "buffer_length": "",
      "column_size": "38",
      "is_self_referencing": "NO"
    },
    "labels": []
  }
}

Response example (404)

{
  "errorCode": "ATLAS-404-00-005",
  "errorMessage": "Given instance guid abc123 is invalid/not found\n"
}

Delete asset by GUID

DELETE /api/meta/entity/guid/{guid}

Remove an asset (table, schema, etc) by its GUID. By default the asset will be soft-deleted (archived). Such assets can be recovered.

Path parameters

guid string(uuid) Required

Unique identifier of the entity to delete.

Query parameters

deleteType string

When SOFT (default), will soft-delete (archive) the asset. When HARD, will permanently remove the asset (cannot be recovered). Soft-deleted assets cannot be hard-deleted, they must first be restored to active.

Values are SOFT or HARD. Default value is SOFT.

Responses

• 200 object

Entity in its deleted state.

Note: if the entity has already been deleted, or does not exist, an empty body will be returned but still a 200 code.
- mutatedEntities object | null
  
  Assets that were deleted.
  DELETE array[object]
  
  Instance of an asset in Atlan, with its detailed information.
  
  entity object
  
  Instance of an entity in Atlan, with its detailed information.
  
  typeName string
  
  Name of the type definition that defines this instance.
  
  attributes object | null
  
  Will be further documented in sub-types of EntityHeader.
  
  classifications array[object] | null
  
  Instance of a classification in Atlan, with its detailed information.
  
  typeName string
  
  Name of the classification. Note that this is the static-hashed unique name of the classification, not the human-readable displayName.
  
  entityGuid string
  
  Unique identifier of the entity to which this classification is attached.
  
  propagate boolean | null
  
  Whether to propagate this classification to other entities related to the entity to which the classification is attached.
  
  removePropagationsOnEntityDelete boolean | null
  
  Whether to remove this classification from other entities to which it has been propagated when the classification is removed from this entity.
  
  entityStatus string | null
  
  Status of the entity to which this classification is attached.
  
  Values are ACTIVE or DELETED.
  
  displayText string | null
  
  Human-readable name of the entity.
  
  guid string
  
  Unique identifier of the entity instance.
  
  isIncomplete boolean | null
  
  Default value is false.
  
  businessAttributes object | null
  
  Map of custom metadata attributes and values defined on the entity.
  
  relationshipAttributes object
  
  Map of relationships for the entity. The specific keys of this map will vary by type, so are described in the sub-types of this schema.
  
  createdBy string | null
  
  Username of the user who created the object.
  
  updatedBy string | null
  
  Username of the user who last updated the object.
  
  createTime integer | null
  
  Time (epoch) at which this object was created, in milliseconds.
  
  updateTime integer | null
  
  Time (epoch) at which this object was last updated, in milliseconds.
  
  version integer | null
  
  Version of this object.
  
  classificationNames array[string] | null
  
  List of classifications for this entity. Note that these are the internal hashed names used in Atlan, not the displayText of the classification.
  
  labels array[string] | null
  
  Internal use only.
  
  status string
  
  Status of the entity, either ACTIVE or DELETED.
  
  Values are ACTIVE or DELETED.
  
  customAttributes object | null
  
  Internal use only.
  
  Additional properties: string
  
  pendingTasks array[string] | null
  
  Internal use only.
  
  referredEntities object
  
  Map of related entities keyed by the GUID of the related entity. The values will be the detailed entity object of the related entity.
  
  typeName string
  
  Name of the type definition that defines this instance.
  
  attributes object | null
  
  Attributes that can exist across all assets in Atlan.
  
  qualifiedName string
  
  Unique name for this asset. This is typically a concatenation of the asset's name onto its parent's qualifiedName.
  
  name string
  
  Human-readable name of the asset.
  
  displayName string | null
  
  Name used for display purposes (in user interfaces).
  
  description string | null
  
  Description of the asset, as crawled from a source.
  
  userDescription string | null
  
  Description of the asset, as provided by a user. If present, this will be used for the description in user interfaces. If not present, the description will be used.
  
  tenantId string
  
  Name of the Atlan workspace in which the table exists.
  
  certificateStatus string | null
  
  Status of the asset's certification.
  
  Values are VERIFIED, DRAFT, or DEPRECATED.
  
  certificateStatusMessage string | null
  
  Human-readable descriptive message that can optionally be submitted when the certificateStatus is changed.
  
  announcementTitle string | null
  
  Brief title for the announcement on this asset. Required when announcementType is specified.
  
  announcementMessage string | null
  
  Detailed message to include in the announcement on this asset.
  
  announcementType string | null
  
  Type of announcement on the asset.
  
  Values are information, warning, or issue.
  
  ownerUsers array[string] | null
  
  List of users who own the asset.
  
  ownerGroups array[string] | null
  
  List of groups who own the asset.
  
  adminUsers array[string] | null
  
  List of users who administer the asset. (This is only used for Connection assets?)
  
  adminGroups array[string] | null
  
  List of groups who administer the asset. (This is only used for Connection assets?)
  
  viewerUsers array[string] | null
  
  viewerGroups array[string] | null
  
  connectorName string | null
  
  Name of the connector through which this asset is accessible.
  
  connectionName string | null Deprecated
  
  Unused.
  
  connectionQualifiedName string | null
  
  Unique name of the connection through which this asset is accessible.
  
  isDiscoverable boolean
  
  isEditable boolean
  
  subType object | null
  
  viewScore number | null
  
  popularityScore number | null
  
  sourceOwners array[string] | null
  
  sourceURL string | null
  
  lastSyncWorkflowName string | null
  
  Name of the crawler that last synchronized this asset.
  
  lastSyncRunAt integer | null
  
  Time (epoch) at which the table was last crawled, in milliseconds.
  
  lastSyncRun string | null
  
  Name of the last run of the crawler that last synchronized this asset.
  
  certificateUpdatedBy string | null
  
  Name of the user who last updated the certificateStatus.
  
  certificateUpdatedAt integer | null
  
  Time (epoch) at which the certificateStatus was last updated, in milliseconds.
  
  announcementUpdatedAt integer | null
  
  Time (epoch) at which the announcement was last updated, in milliseconds.
  
  announcementUpdatedBy string | null
  
  User who last updated the announcement.
  
  sourceCreatedBy string | null
  
  sourceCreatedAt integer | null
  
  sourceUpdatedAt integer | null
  
  sourceUpdatedBy string | null
  
  classifications array[object] | null
  
  Instance of a classification in Atlan.
  
  typeName string
  
  Name of the classification. Note that this is the static-hashed unique name of the classification, not the human-readable displayName.
  
  entityGuid string
  
  Unique identifier of the entity to which this classification is attached.
  
  propagate boolean | null
  
  Whether to propagate this classification to other entities related to the entity to which the classification is attached.
  
  removePropagationsOnEntityDelete boolean | null
  
  Whether to remove this classification from other entities to which it has been propagated when the classification is removed from this entity.
  
  displayText string | null
  
  Human-readable name of the entity.
  
  guid string
  
  Unique identifier of the entity instance.
  
  isIncomplete boolean | null
  
  Default value is false.
  
  businessAttributes object | null
  
  Map of custom metadata attributes and values defined on the entity.
  
  relationshipAttributes object | null
  
  Map of the relationships to this asset.
  
  links array[object]
  
  Details to use within an asset when referring to a link (resource).
  
  typeName string
  
  Should always be Link.
  
  guid string | null
  
  Unique identifier of the related link. If the uniqueAttributes are not provided, this must be provided.
  
  uniqueAttributes object | null
  
  Attribute(s) that uniquely identify the related link. If the guid is not provided, these must be provided.
  
  qualifiedName string
  
  Unique name of the related link. Note that this is a generated unique name which is not visible in the UI.
  
  readme object
  
  Details to use within an asset when referring to a readme.
  
  typeName string
  
  Should always be Readme.
  
  guid string | null
  
  Unique identifier of the related readme. If the uniqueAttributes are not provided, this must be provided.
  
  uniqueAttributes object | null
  
  Attribute(s) that uniquely identify the related readme. If the guid is not provided, these must be provided.
  
  qualifiedName string
  
  Unique name of the related readme.
  
  meanings array[object]
  
  Details to use within an asset when referring to a term.
  
  typeName string
  
  Should always be AtlasnGlossaryTerm.
  
  guid string | null
  
  Unique identifier of the related term. If the uniqueAttributes are not provided, this must be provided.
  
  uniqueAttributes object | null
  
  Attribute(s) that uniquely identify the related term. If the guid is not provided, these must be provided.
  
  qualifiedName string
  
  Unique name of the related term. Note that in Atlan this unique name is a hashed value, not the name you see in the UI.
  
  deleteHandler string
  
  Handler used for the deletion of the asset.
  
  Values are DEFAULT, SOFT, or HARD.

DELETE /api/meta/entity/guid/{guid}

curl \
 -X DELETE https://tenant.atlan.com/api/meta/entity/guid/c47d2400-0c21-4c0d-b9fb-1d53440a75ae \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response example (200)

{
  "mutatedEntities": {
    "DELETE": [
      {
        "typeName": "AtlasGlossaryTerm",
        "attributes": {
          "popularityScore": 1.17549435e-38,
          "viewerUsers": [],
          "sourceCreatedAt": 0,
          "lastSyncRunAt": 0,
          "certificateStatus": "VERIFIED",
          "userDescription": "The average amount spent in order to acquire a customer.",
          "adminRoles": [],
          "adminGroups": [],
          "qualifiedName": "u1qWdBZPF9vfEHXFcgEER@FzCMyPR2LxkPFgr8eNGrq",
          "adminUsers": [],
          "ownerGroups": [],
          "certificateUpdatedBy": "service-account-apikey-e8d1f0bd-600e-4a8a-9248-b7c9aa1ef8c3",
          "isEditable": true,
          "sourceUpdatedAt": 0,
          "announcementUpdatedAt": 0,
          "name": "Customer Acquisition Cost",
          "certificateUpdatedAt": 1657039477745,
          "isDiscoverable": true,
          "viewerGroups": [],
          "ownerUsers": []
        },
        "guid": "c47d2400-0c21-4c0d-b9fb-1d53440a75ae",
        "status": "DELETED",
        "displayText": "Customer Acquisition Cost",
        "classificationNames": [
          "GeiqD5GfQoJ8oVzhspjQdo"
        ],
        "meaningNames": [],
        "meanings": [],
        "isIncomplete": false,
        "labels": [],
        "createdBy": "service-account-apikey-e8d1f0bd-600e-4a8a-9248-b7c9aa1ef8c3",
        "updatedBy": "service-account-apikey-e8d1f0bd-600e-4a8a-9248-b7c9aa1ef8c3",
        "createTime": 1657039477745,
        "updateTime": 1657039571112,
        "deleteHandler": "DEFAULT"
      }
    ]
  }
}

Get asset by qualified name

GET /api/meta/entity/uniqueAttribute/type/{typeName}

Retrieve details of an asset (table, schema, etc) by its qualifiedName. By default the full details of the asset are returned, including: attributes, relationships, and classifications.

Path parameters

typeName string Required

Type of the asset to retrieve.

Values are AtlasGlossary, AtlasGlossaryCategory, AtlasGlossaryTerm, Collection, Column, ColumnProcess, Connection, Database, DataSet, Folder, Infrastructure, Link, LookerDashboard, LookerExplore, LookerField, LookerFolder, LookerLook, LookerModel, LookerProject, LookerQuery, LookerTile, MaterialisedView, Namespace, PowerBIDashboard, PowerBIDataflow, PowerBIDataset, PowerBIDatasource, PowerBIPage, PowerBIReport, PowerBITile, PowerBIWorkspace, Procedure, Process, ProcessExecution, Query, Readme, S3Bucket, S3Object, SalesforceDashboard, SalesforceField, SalesforceObject, SalesforceOrganization, SalesforceReport, Schema, Table, TableauCalculatedField, TableauDashboard, TableauDatasource, TableauDatasourceField, TableauFlow, TableauMetric, TableauProject, TableauSite, TableauWorkbook, TableauWorksheet, TablePartition, or View.

Query parameters

attr:qualifiedName string Required

Full qualifiedName of the asset to retrieve.
ignoreRelationships boolean

When true, will not retrieve details about the asset's relationships.
minExtInfo boolean

When true, will minimize the extra details retrieved about an asset.

Responses

• 200 object

Entity in its current state.
- entity object
  
  Instance of an entity in Atlan, with its detailed information.
  typeName string
  
  Name of the type definition that defines this instance.
  
  attributes object | null
  
  Will be further documented in sub-types of EntityHeader.
  
  classifications array[object] | null
  
  Instance of a classification in Atlan, with its detailed information.
  
  typeName string
  
  Name of the classification. Note that this is the static-hashed unique name of the classification, not the human-readable displayName.
  
  entityGuid string
  
  Unique identifier of the entity to which this classification is attached.
  
  propagate boolean | null
  
  Whether to propagate this classification to other entities related to the entity to which the classification is attached.
  
  removePropagationsOnEntityDelete boolean | null
  
  Whether to remove this classification from other entities to which it has been propagated when the classification is removed from this entity.
  
  entityStatus string | null
  
  Status of the entity to which this classification is attached.
  
  Values are ACTIVE or DELETED.
  
  displayText string | null
  
  Human-readable name of the entity.
  
  guid string
  
  Unique identifier of the entity instance.
  
  isIncomplete boolean | null
  
  Default value is false.
  
  businessAttributes object | null
  
  Map of custom metadata attributes and values defined on the entity.
  
  relationshipAttributes object
  
  Map of relationships for the entity. The specific keys of this map will vary by type, so are described in the sub-types of this schema.
  
  createdBy string | null
  
  Username of the user who created the object.
  
  updatedBy string | null
  
  Username of the user who last updated the object.
  
  createTime integer | null
  
  Time (epoch) at which this object was created, in milliseconds.
  
  updateTime integer | null
  
  Time (epoch) at which this object was last updated, in milliseconds.
  
  version integer | null
  
  Version of this object.
  
  classificationNames array[string] | null
  
  List of classifications for this entity. Note that these are the internal hashed names used in Atlan, not the displayText of the classification.
  
  labels array[string] | null
  
  Internal use only.
  
  status string
  
  Status of the entity, either ACTIVE or DELETED.
  
  Values are ACTIVE or DELETED.
  
  customAttributes object | null
  
  Internal use only.
  
  Additional properties: string
  
  pendingTasks array[string] | null
  
  Internal use only.
- referredEntities object
  
  Map of related entities keyed by the GUID of the related entity. The values will be the detailed entity object of the related entity.
- typeName string
  
  Name of the type definition that defines this instance.
- attributes object | null
  
  Attributes that can exist across all assets in Atlan.
  qualifiedName string
  
  Unique name for this asset. This is typically a concatenation of the asset's name onto its parent's qualifiedName.
  
  name string
  
  Human-readable name of the asset.
  
  displayName string | null
  
  Name used for display purposes (in user interfaces).
  
  description string | null
  
  Description of the asset, as crawled from a source.
  
  userDescription string | null
  
  Description of the asset, as provided by a user. If present, this will be used for the description in user interfaces. If not present, the description will be used.
  
  tenantId string
  
  Name of the Atlan workspace in which the table exists.
  
  certificateStatus string | null
  
  Status of the asset's certification.
  
  Values are VERIFIED, DRAFT, or DEPRECATED.
  
  certificateStatusMessage string | null
  
  Human-readable descriptive message that can optionally be submitted when the certificateStatus is changed.
  
  announcementTitle string | null
  
  Brief title for the announcement on this asset. Required when announcementType is specified.
  
  announcementMessage string | null
  
  Detailed message to include in the announcement on this asset.
  
  announcementType string | null
  
  Type of announcement on the asset.
  
  Values are information, warning, or issue.
  
  ownerUsers array[string] | null
  
  List of users who own the asset.
  
  ownerGroups array[string] | null
  
  List of groups who own the asset.
  
  adminUsers array[string] | null
  
  List of users who administer the asset. (This is only used for Connection assets?)
  
  adminGroups array[string] | null
  
  List of groups who administer the asset. (This is only used for Connection assets?)
  
  viewerUsers array[string] | null
  
  viewerGroups array[string] | null
  
  connectorName string | null
  
  Name of the connector through which this asset is accessible.
  
  connectionName string | null Deprecated
  
  Unused.
  
  connectionQualifiedName string | null
  
  Unique name of the connection through which this asset is accessible.
  
  isDiscoverable boolean
  
  isEditable boolean
  
  subType object | null
  
  viewScore number | null
  
  popularityScore number | null
  
  sourceOwners array[string] | null
  
  sourceURL string | null
  
  lastSyncWorkflowName string | null
  
  Name of the crawler that last synchronized this asset.
  
  lastSyncRunAt integer | null
  
  Time (epoch) at which the table was last crawled, in milliseconds.
  
  lastSyncRun string | null
  
  Name of the last run of the crawler that last synchronized this asset.
  
  certificateUpdatedBy string | null
  
  Name of the user who last updated the certificateStatus.
  
  certificateUpdatedAt integer | null
  
  Time (epoch) at which the certificateStatus was last updated, in milliseconds.
  
  announcementUpdatedAt integer | null
  
  Time (epoch) at which the announcement was last updated, in milliseconds.
  
  announcementUpdatedBy string | null
  
  User who last updated the announcement.
  
  sourceCreatedBy string | null
  
  sourceCreatedAt integer | null
  
  sourceUpdatedAt integer | null
  
  sourceUpdatedBy string | null
- classifications array[object] | null
  
  Instance of a classification in Atlan.
  typeName string
  
  Name of the classification. Note that this is the static-hashed unique name of the classification, not the human-readable displayName.
  
  entityGuid string
  
  Unique identifier of the entity to which this classification is attached.
  
  propagate boolean | null
  
  Whether to propagate this classification to other entities related to the entity to which the classification is attached.
  
  removePropagationsOnEntityDelete boolean | null
  
  Whether to remove this classification from other entities to which it has been propagated when the classification is removed from this entity.
- displayText string | null
  
  Human-readable name of the entity.
- guid string
  
  Unique identifier of the entity instance.
- isIncomplete boolean | null
  
  Default value is false.
- businessAttributes object | null
  
  Map of custom metadata attributes and values defined on the entity.
- relationshipAttributes object | null
  
  Map of the relationships to this asset.
  links array[object]
  
  Details to use within an asset when referring to a link (resource).
  
  typeName string
  
  Should always be Link.
  
  guid string | null
  
  Unique identifier of the related link. If the uniqueAttributes are not provided, this must be provided.
  
  uniqueAttributes object | null
  
  Attribute(s) that uniquely identify the related link. If the guid is not provided, these must be provided.
  
  qualifiedName string
  
  Unique name of the related link. Note that this is a generated unique name which is not visible in the UI.
  
  readme object
  
  Details to use within an asset when referring to a readme.
  
  typeName string
  
  Should always be Readme.
  
  guid string | null
  
  Unique identifier of the related readme. If the uniqueAttributes are not provided, this must be provided.
  
  uniqueAttributes object | null
  
  Attribute(s) that uniquely identify the related readme. If the guid is not provided, these must be provided.
  
  qualifiedName string
  
  Unique name of the related readme.
  
  meanings array[object]
  
  Details to use within an asset when referring to a term.
  
  typeName string
  
  Should always be AtlasnGlossaryTerm.
  
  guid string | null
  
  Unique identifier of the related term. If the uniqueAttributes are not provided, this must be provided.
  
  uniqueAttributes object | null
  
  Attribute(s) that uniquely identify the related term. If the guid is not provided, these must be provided.
  
  qualifiedName string
  
  Unique name of the related term. Note that in Atlan this unique name is a hashed value, not the name you see in the UI.
• 404 object

Entity does not exist, or is deleted.
- errorCode string
  
  Unique code for the type of error that occurred.
- errorMessage string
  
  Human-readable description of the error that occurred.

GET /api/meta/entity/uniqueAttribute/type/{typeName}

curl \
 -X GET https://tenant.atlan.com/api/meta/entity/uniqueAttribute/type/Table?attr%3AqualifiedName=default%2Fsnowflake%2F1646904424%2FATLAN_SAMPLE_DATA%2FFOOD_BEVERAGE%2FINSTACART_BEVERAGES_ORDER_CUSTOMER%2Fuser_id%0A \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response example (200)

{
  "referredEntities": {},
  "entity": {
    "typeName": "Column",
    "attributes": {
      "popularityScore": 1.17549435e-38,
      "lastSyncRunAt": 1646904481260,
      "databaseName": "ATLAN_SAMPLE_DATA",
      "defaultValue": null,
      "precision": 0,
      "__hasLineage": null,
      "lastSyncRun": "atlan-snowflake-default-snowflake-1646904424-ghj5h",
      "queryCountUpdatedAt": 0,
      "schemaName": "FOOD_BEVERAGE",
      "adminUsers": [],
      "tableName": "INSTACART_BEVERAGES_ORDER_CUSTOMER",
      "sourceURL": null,
      "queryUserCount": 0,
      "view": null,
      "isEditable": true,
      "sourceUpdatedAt": 0,
      "viewName": null,
      "isPartition": false,
      "announcementUpdatedAt": 0,
      "announcementTitle": null,
      "subDataType": null,
      "links": [],
      "validations": null,
      "order": 3,
      "certificateStatusMessage": null,
      "sourceCreatedAt": 0,
      "isIndexed": false,
      "qualifiedName": "default/snowflake/1646904424/ATLAN_SAMPLE_DATA/FOOD_BEVERAGE/INSTACART_BEVERAGES_ORDER_CUSTOMER/user_id",
      "dataType": "NUMBER",
      "pinnedBy": null,
      "isClustered": false,
      "isNullable": true,
      "name": "user_id",
      "certificateUpdatedAt": 0,
      "connectorName": "snowflake",
      "subType": null,
      "announcementUpdatedBy": null,
      "connectionName": null,
      "numericScale": 0,
      "maxLength": 0,
      "ownerUsers": [],
      "lastSyncWorkflowName": "dev-crawler",
      "isSort": false,
      "certificateStatus": null,
      "connectionQualifiedName": "default/snowflake/1646904424",
      "sourceCreatedBy": null,
      "replicatedFrom": null,
      "displayName": null,
      "isForeign": false,
      "description": "The unique ID for each customer",
      "queryCount": 0,
      "pinnedAt": 0,
      "isDist": false,
      "ownerGroups": [],
      "certificateUpdatedBy": null,
      "isPrimary": false,
      "isDiscoverable": true,
      "announcementType": null,
      "table": {
        "guid": "85d141c2-d383-4b4f-93a5-c3eed20988b9",
        "typeName": "Table"
      },
      "schemaQualifiedName": "default/snowflake/1646904424/ATLAN_SAMPLE_DATA/FOOD_BEVERAGE",
      "viewerUsers": [],
      "viewScore": 1.17549435e-38,
      "sourceOwners": null,
      "materialisedView": null,
      "replicatedTo": null,
      "userDescription": null,
      "adminGroups": [],
      "isPinned": false,
      "databaseQualifiedName": "default/snowflake/1646904424/ATLAN_SAMPLE_DATA",
      "viewQualifiedName": null,
      "readme": null,
      "queryUserMap": null,
      "queries": [],
      "sourceUpdatedBy": null,
      "tenantId": "default",
      "tableQualifiedName": "default/snowflake/1646904424/ATLAN_SAMPLE_DATA/FOOD_BEVERAGE/INSTACART_BEVERAGES_ORDER_CUSTOMER",
      "partitionOrder": 0,
      "tablePartition": null,
      "announcementMessage": null,
      "viewerGroups": []
    },
    "guid": "75403887-4241-45ab-8e0e-1508e61d75e4",
    "isIncomplete": false,
    "status": "ACTIVE",
    "createdBy": "service-account-apikey-9471cf12-f45c-4275-b280-3e01d26f57e8",
    "updatedBy": "admin",
    "createTime": 1646904631984,
    "updateTime": 1651675109912,
    "version": 0,
    "relationshipAttributes": {
      "inputToProcesses": [],
      "view": null,
      "materialisedView": null,
      "tablePartition": null,
      "links": [],
      "readme": null,
      "queries": [],
      "meanings": [],
      "table": {
        "guid": "85d141c2-d383-4b4f-93a5-c3eed20988b9",
        "typeName": "Table",
        "entityStatus": "ACTIVE",
        "displayText": "INSTACART_BEVERAGES_ORDER_CUSTOMER",
        "relationshipType": "table_columns",
        "relationshipGuid": "080815af-5dc6-49b4-a5ec-4523096f1bae",
        "relationshipStatus": "ACTIVE",
        "relationshipAttributes": {
          "typeName": "table_columns"
        },
        "outputFromProcesses": []
      }
    },
    "classifications": [
      {
        "typeName": "J5q2QzErHG4unHTA0C5GE0",
        "entityGuid": "af6a32d4-936b-4a59-9917-7082c56ba443",
        "entityStatus": "ACTIVE",
        "propagate": true,
        "removePropagationsOnEntityDelete": true
      }
    ],
    "customAttributes": {
      "character_octet_length": "",
      "is_auto_increment": "NO",
      "is_generated": "NO",
      "extra_info": "",
      "buffer_length": "",
      "column_size": "38",
      "is_self_referencing": "NO"
    },
    "labels": []
  }
}

Response example (404)

{
  "errorCode": "ATLAS-404-00-005",
  "errorMessage": "Given instance guid abc123 is invalid/not found\n"
}

Get asset history

POST /api/meta/entity/auditSearch

Retrieve the actions that have been taken on the asset across its history in Atlan.

Body Required

Query to run the retrieval.

The history for an asset can be retrieved either by GUID or by qualifiedName:

To search by GUID, use the term entityId with a value of the GUID of the entity for which to retrieve history
To search by qualifiedName, use the term entityQualifiedName with the exact (case-sensitive) qualifiedName of the asset for which to retrieve history

This specific example retrieves the last 10 actions that were taken on the asset, sorted in reverse-chronological order.

(For advanced users, this interface actually uses the Elastic Query DSL. You can use more complex queries to retrieve history across more than a single asset using the same interface.)

dsl object Required

Asset history query for Atlan.
- from integer
  
  Starting point of results for paging.
  
  Default value is 0.
- size integer
  
  Maximum number of results to return (for paging).
- sort array[object] | null
  
  Mapping of properties by which to sort the results. The keys of the map are the property names, and their value is whether to sort each one in ascending or descending order.
  created object
  
  Sort by the order in which the activities occurred.
  
  order string
  
  Whether to sort in ascending or descending order.
  
  Values are asc or desc.
- query object | null Required
  
  Query for the asset history. One of entityId or entityQualifiedName must be provided.
  bool object
  
  filter object
  
  term object
  
  entityId string | null
  
  GUID of the asset for which to retrieve history.
  
  entityQualifiedName string | null
  
  Exact (case-sensitive) qualifiedName of the asset for which to retrieve history.
attributes array[string] | null

List of attribute names to include in the current version of each entry.

Responses

• 200 object

The history of the asset according to the parameters provided.

Note that each entry has an entityDetail object giving a view of the current value of the asset. When retrieving the history for a single asset, the contents of this entityDetail object will be the same in all entries.
- entityAudits array[object]
  
  Entries in the audit history of the asset.
  entityQualifiedName string
  
  Unique name for the asset, its qualifiedName.
  
  typeName string
  
  Name of the type definition that defines this asset.
  
  entityId string
  
  Unique identifier of the asset, its GUID.
  
  timestamp integer
  
  Time (epoch) at which the activity occurred, in milliseconds.
  
  created integer
  
  Time (epoch) at which the audit entry was created, in milliseconds.
  
  user string
  
  Username of the user who carried out the activity.
  
  action string
  
  Type of activity that was carried out on the asset.
  
  Values are ENTITY_CREATE, ENTITY_UPDATE, ENTITY_DELETE, ENTITY_PURGE, ENTITY_IMPORT_CREATE, ENTITY_IMPORT_UPDATE, ENTITY_IMPORT_DELETE, CLASSIFICATION_ADD, CLASSIFICATION_UPDATE, PROPAGATED_CLASSIFICATION_ADD, PROPAGATED_CLASSIFICATION_DELETE, PROPAGATED_CLASSIFICATION_UPDATE, TERM_ADD, TERM_DELETE, LABEL_ADD, LABEL_DELETE, BUSINESS_ATTRIBUTE_UPDATE, or CUSTOM_ATTRIBUTE_UPDATE.
  
  details object | null
  
  eventKey string
  
  Unique identifier for the audit entry.
  
  entity object | null
  
  type object | null
  
  detail object
  
  Detail of the action that occurred. The specific structure of the object will vary based on the action that occurred.
  
  entityDetail object
  
  Current version of the asset. Note that this is not a view of the asset as it existed or immediately after it was changed by this action, but is the current view of the asset across all actions.
  
  typeName string
  
  Name of the type definition that defines this instance.
  
  attributes object | null
  
  Attributes that can exist across all assets in Atlan.
  
  qualifiedName string
  
  Unique name for this asset.
  
  name string
  
  Human-readable name of the asset.
  
  classifications array[object] | null
  
  Instance of a classification in Atlan, with its detailed information.
  
  typeName string
  
  Name of the classification. Note that this is the static-hashed unique name of the classification, not the human-readable displayName.
  
  entityGuid string
  
  Unique identifier of the entity to which this classification is attached.
  
  propagate boolean | null
  
  Whether to propagate this classification to other entities related to the entity to which the classification is attached.
  
  removePropagationsOnEntityDelete boolean | null
  
  Whether to remove this classification from other entities to which it has been propagated when the classification is removed from this entity.
  
  entityStatus string | null
  
  Status of the entity to which this classification is attached.
  
  Values are ACTIVE or DELETED.
  
  displayText string | null
  
  Human-readable name of the entity.
  
  guid string
  
  Unique identifier of the entity instance.
  
  isIncomplete boolean | null
  
  Default value is false.
  
  createdBy string | null
  
  Username of the user who created the object.
  
  updatedBy string | null
  
  Username of the user who last updated the object.
  
  createTime integer | null
  
  Time (epoch) at which this object was created, in milliseconds.
  
  updateTime integer | null
  
  Time (epoch) at which this object was last updated, in milliseconds.
  
  version integer | null
  
  Version of this object.
  
  classificationNames array[string] | null
  
  List of classifications for this entity. Note that these are the internal hashed names used in Atlan, not the displayText of the classification.
  
  labels array[string] | null
  
  Internal use only.
  
  status string
  
  Status of the entity, either ACTIVE or DELETED.
  
  Values are ACTIVE or DELETED.
  
  meaningNames array[string] Deprecated
  
  Unused.
  
  meanings array[object] Deprecated
  
  Unused.
- aggregations object | null
- count integer
  
  Number of audit history entries returned by the query.
- totalCount integer
  
  Total number of audit history entries for the asset.

POST /api/meta/entity/auditSearch

curl \
 -X POST https://tenant.atlan.com/api/meta/entity/auditSearch \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"dsl":{"from":0,"size":10,"sort":[{"created":{"order":"desc"}}],"query":{"bool":{"filter":{"term":{"entityId":"c47d2400-0c21-4c0d-b9fb-1d53440a75ae"}}}}}}'

Request example

{
  "dsl": {
    "from": 0,
    "size": 10,
    "sort": [
      {
        "created": {
          "order": "desc"
        }
      }
    ],
    "query": {
      "bool": {
        "filter": {
          "term": {
            "entityId": "c47d2400-0c21-4c0d-b9fb-1d53440a75ae"
          }
        }
      }
    }
  }
}

Response example (200)

{
  "entityAudits": [
    {
      "entityQualifiedName": "u1qWdBZPF9vfEHXFcgEER@FzCMyPR2LxkPFgr8eNGrq",
      "typeName": "AtlasGlossaryTerm",
      "entityId": "c47d2400-0c21-4c0d-b9fb-1d53440a75ae",
      "timestamp": 1657039571112,
      "created": 1657039571135,
      "user": "service-account-apikey-9471cf12-f45c-4275-b280-3e01d26f57e8",
      "action": "CLASSIFICATION_ADD",
      "details": null,
      "eventKey": "c47d2400-0c21-4c0d-b9fb-1d53440a75ae:1657039571112",
      "entity": null,
      "type": null,
      "detail": {
        "typeName": "GeiqD5GfQoJ8oVzhspjQdo",
        "entityGuid": "c47d2400-0c21-4c0d-b9fb-1d53440a75ae",
        "entityStatus": "ACTIVE",
        "propagate": true,
        "removePropagationsOnEntityDelete": true
      },
      "entityDetail": {
        "typeName": "AtlasGlossaryTerm",
        "attributes": {
          "qualifiedName": "u1qWdBZPF9vfEHXFcgEER@FzCMyPR2LxkPFgr8eNGrq",
          "name": "Customer Acquisition Cost"
        },
        "guid": "c47d2400-0c21-4c0d-b9fb-1d53440a75ae",
        "status": "ACTIVE",
        "displayText": "Customer Acquisition Cost",
        "classificationNames": [
          "GeiqD5GfQoJ8oVzhspjQdo"
        ],
        "meaningNames": [],
        "meanings": [],
        "isIncomplete": false,
        "labels": [],
        "createdBy": "service-account-apikey-9471cf12-f45c-4275-b280-3e01d26f57e8",
        "updatedBy": "service-account-apikey-9471cf12-f45c-4275-b280-3e01d26f57e8",
        "createTime": 1657039477745,
        "updateTime": 1657039571112
      }
    },
    {
      "entityQualifiedName": "u1qWdBZPF9vfEHXFcgEER@FzCMyPR2LxkPFgr8eNGrq",
      "typeName": "AtlasGlossaryTerm",
      "entityId": "c47d2400-0c21-4c0d-b9fb-1d53440a75ae",
      "timestamp": 1657039477745,
      "created": 1657039477783,
      "user": "service-account-apikey-9471cf12-f45c-4275-b280-3e01d26f57e8",
      "action": "ENTITY_CREATE",
      "details": null,
      "eventKey": "c47d2400-0c21-4c0d-b9fb-1d53440a75ae:1657039477745",
      "entity": null,
      "type": null,
      "detail": {
        "typeName": "AtlasGlossaryTerm",
        "attributes": {
          "popularityScore": 1.17549435e-38,
          "viewerUsers": [],
          "sourceCreatedAt": 0,
          "viewScore": 1.17549435e-38,
          "lastSyncRunAt": 0,
          "certificateStatus": "VERIFIED",
          "userDescription": "The average amount spent in order to acquire a customer. CAC is calculated by dividing the total amount spent on acquisition activities by the total number of customers acquired during a certain time period. The acquisition activity costs cover various efforts including business development and marketing, as well as salaries, external consultancy fees, and technology costs.",
          "adminRoles": [],
          "adminGroups": [],
          "qualifiedName": "u1qWdBZPF9vfEHXFcgEER@FzCMyPR2LxkPFgr8eNGrq",
          "__hasLineage": false,
          "adminUsers": [],
          "ownerGroups": [],
          "certificateUpdatedBy": "service-account-apikey-9471cf12-f45c-4275-b280-3e01d26f57e8",
          "isEditable": true,
          "sourceUpdatedAt": 0,
          "examples": [],
          "announcementUpdatedAt": 0,
          "name": "Customer Acquisition Cost",
          "certificateUpdatedAt": 1657039477745,
          "isDiscoverable": true,
          "viewerGroups": [],
          "ownerUsers": []
        },
        "guid": "c47d2400-0c21-4c0d-b9fb-1d53440a75ae",
        "isIncomplete": false,
        "provenanceType": 0,
        "createdBy": "service-account-apikey-9471cf12-f45c-4275-b280-3e01d26f57e8",
        "updatedBy": "service-account-apikey-9471cf12-f45c-4275-b280-3e01d26f57e8",
        "createTime": 1657039477745,
        "updateTime": 1657039477745,
        "version": 0,
        "relationshipAttributes": {
          "anchor": {
            "guid": "1c557933-aa97-4eb2-bb14-3b51a636a664",
            "typeName": "AtlasGlossary"
          }
        },
        "classifications": [],
        "proxy": false
      },
      "entityDetail": {
        "typeName": "AtlasGlossaryTerm",
        "attributes": {
          "qualifiedName": "u1qWdBZPF9vfEHXFcgEER@FzCMyPR2LxkPFgr8eNGrq",
          "name": "Customer Acquisition Cost"
        },
        "guid": "c47d2400-0c21-4c0d-b9fb-1d53440a75ae",
        "status": "ACTIVE",
        "displayText": "Customer Acquisition Cost",
        "classificationNames": [
          "GeiqD5GfQoJ8oVzhspjQdo"
        ],
        "meaningNames": [],
        "meanings": [],
        "isIncomplete": false,
        "labels": [],
        "createdBy": "service-account-apikey-9471cf12-f45c-4275-b280-3e01d26f57e8",
        "updatedBy": "service-account-apikey-9471cf12-f45c-4275-b280-3e01d26f57e8",
        "createTime": 1657039477745,
        "updateTime": 1657039571112
      }
    }
  ],
  "aggregations": null,
  "count": 2,
  "totalCount": 2
}

Attach custom metadata

POST /api/meta/entity/guid/{guid}/businessmetadata/displayName

Attach custom metadata to an asset (table, schema, etc) by its GUID. This is used to populate any of the custom metadata attributes on any type of asset.

Path parameters

guid string(uuid) Required

Unique identifier of the entity to retrieve.

Query parameters

isOverwrite boolean

When true, will act as a full replacement of custom metadata: any custom metadata not provided in the request body will have any existing value removed from the asset. When false, will act as a partial update of the custom metadata: only the attributes provided in the request body will be updated, and any other custom metadata attributes will be left as-is on the asset.

Body Required

Map of custom metadata types, with nested maps of their attributes and values to set on the asset.

Custom metadata name object

Display name of the custom metadata as it appears on the Atlan UI. In the example, this is Additional contributors
- Custom metadata property name array[string]
  
  Display name of the custom metadata property. In the example, this is Data experts

Responses

• 204

Custom metadata was successfully attached or updated.
• 404 object

Entity does not exist, or is deleted.
- errorCode string
  
  Unique code for the type of error that occurred.
- errorMessage string
  
  Human-readable description of the error that occurred.

POST /api/meta/entity/guid/{guid}/businessmetadata/displayName

curl \
 -X POST https://tenant.atlan.com/api/meta/entity/guid/917ffec9-fa84-4c59-8e6c-c7b114d04be3/businessmetadata/displayName \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"Additional contributors":{"Data experts":["jsmith","jdoe"]}}'

Request example

{
  "Additional contributors": {
    "Data experts": [
      "jsmith",
      "jdoe"
    ]
  }
}

Response example (404)

{
  "errorCode": "ATLAS-404-00-005",
  "errorMessage": "Given instance guid abc123 is invalid/not found\n"
}

Attach classification

POST /api/meta/entity/bulk/classification/displayName

Attach a classification to an asset using the display name of the classification (in the Atlan UI) and the GUID of the entity to which to attach it.

Body Required

List of attachments between assets and classifications.

entityGuid string Required

Unique identifier of the asset for which the classification is to be added.
displayName string Required

Name of the classification that is to be attached to the asset.
propagate boolean

When true, propagates the classification to child assets. This includes contained children (e.g. from a table to all columns in the table) and to downstream assets via lineage.
removePropagationsOnEntityDelete boolean

When true, propagates the removal of a classification to child assets. This includes contained children (e.g. from a table to all columns in the table) and to downstream assets via lineage.

Responses

• 204

Successfully attached classifications to entities.
• 400 object

Error when attaching the classification. For example, if the provided entity and classification are already attached.
- errorCode string
  
  Unique code for the type of error that occurred.
- errorMessage string
  
  Human-readable description of the error that occurred.

POST /api/meta/entity/bulk/classification/displayName

curl \
 -X POST https://tenant.atlan.com/api/meta/entity/bulk/classification/displayName \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '[{"entityGuid":"bdcbd27e-153e-4e86-ba50-ecea60097018","displayName":"PII","propagate":true,"removePropagationsOnEntityDelete":true}]'

Request example

[
  {
    "entityGuid": "bdcbd27e-153e-4e86-ba50-ecea60097018",
    "displayName": "PII",
    "propagate": true,
    "removePropagationsOnEntityDelete": true
  }
]

Response example (400)

{
  "errorCode": "ATLAS-400-00-01A",
  "errorMessage": "invalid parameters: entity: 4961767f-a26e-4d4f-bf3c-b28320a4f3aa, already associated with classification: DbEq9WxfnHlXxPejKu9Nec"
}

Attach glossary terms

POST /api/meta/entity/bulk#attachGlossaryTerm

Attach one or more glossary terms.

Note that the update relies on a match being found for the provided qualifiedNames. If the qualifiedNames do not match any existing asset, those assets will instead be created and terms attached, rather than updating an existing asset by attaching a term. Also be aware that the qualifiedName is case-sensitive.

Terms can be attached either based on their qualifiedName (in the example here against the ID column) or by using their GUID (in the example here against the NAME column). Note that when using the qualifiedName that terms in Atlan have a unique hashed name, which is different than the name you see in the UI.

For more details on the semantics and other attributes available through this interface, see the Upsert entities operation.

Body Required

List of assets (entities) and the term(s) to attach to them.

entities array[object] Required

Minimal set of fields required in order to update an asset.
- typeName string Required
  
  Type of the asset that is being updated.
  
  Values are AtlasGlossary, AtlasGlossaryCategory, Collection, Column, ColumnProcess, Connection, Database, DataSet, Folder, Infrastructure, Link, LookerDashboard, LookerExplore, LookerField, LookerFolder, LookerLook, LookerModel, LookerProject, LookerQuery, LookerTile, MaterialisedView, Namespace, PowerBIDashboard, PowerBIDataflow, PowerBIDataset, PowerBIDatasource, PowerBIPage, PowerBIReport, PowerBITile, PowerBIWorkspace, Procedure, Process, ProcessExecution, Query, Readme, SalesforceDashboard, SalesforceField, SalesforceObject, SalesforceOrganization, SalesforceReport, Schema, Table, TableauCalculatedField, TableauDashboard, TableauDatasource, TableauDatasourceField, TableauFlow, TableauMetric, TableauProject, TableauSite, TableauWorkbook, TableauWorksheet, TablePartition, or View.
- attributes object Required
  
  Minimal set of attributes that are required to update an asset.
  qualifiedName string Required
  
  Unique name for this asset. This is typically a concatenation of the asset's name onto its parent's qualifiedName.
  
  name string Required
  
  Human-readable name of the asset.
- relationshipAttributes object | null Required
  
  Map of the relationships to this asset.
  meanings array[object] Required
  
  Details to use within an asset when referring to a term.
  
  typeName string
  
  Should always be AtlasnGlossaryTerm.
  
  guid string | null
  
  Unique identifier of the related term. If the uniqueAttributes are not provided, this must be provided.
  
  uniqueAttributes object | null
  
  Attribute(s) that uniquely identify the related term. If the guid is not provided, these must be provided.
  
  qualifiedName string
  
  Unique name of the related term. Note that in Atlan this unique name is a hashed value, not the name you see in the UI.

Responses

• 200 object

Glossary term(s) were successfully attached. The response example here is simplified to show only the properties related to the linking of glossary terms — there would be a full set of properties for each asset in the actual response.
- mutatedEntities object | null
  
  Assets that were changed.
  CREATE array[object]
  
  Instance of an asset in Atlan, with its detailed information.
  
  entity object
  
  Instance of an entity in Atlan, with its detailed information.
  
  typeName string
  
  Name of the type definition that defines this instance.
  
  attributes object | null
  
  Will be further documented in sub-types of EntityHeader.
  
  classifications array[object] | null
  
  Instance of a classification in Atlan, with its detailed information.
  
  typeName string
  
  Name of the classification. Note that this is the static-hashed unique name of the classification, not the human-readable displayName.
  
  entityGuid string
  
  Unique identifier of the entity to which this classification is attached.
  
  propagate boolean | null
  
  Whether to propagate this classification to other entities related to the entity to which the classification is attached.
  
  removePropagationsOnEntityDelete boolean | null
  
  Whether to remove this classification from other entities to which it has been propagated when the classification is removed from this entity.
  
  entityStatus string | null
  
  Status of the entity to which this classification is attached.
  
  Values are ACTIVE or DELETED.
  
  displayText string | null
  
  Human-readable name of the entity.
  
  guid string
  
  Unique identifier of the entity instance.
  
  isIncomplete boolean | null
  
  Default value is false.
  
  businessAttributes object | null
  
  Map of custom metadata attributes and values defined on the entity.
  
  relationshipAttributes object
  
  Map of relationships for the entity. The specific keys of this map will vary by type, so are described in the sub-types of this schema.
  
  createdBy string | null
  
  Username of the user who created the object.
  
  updatedBy string | null
  
  Username of the user who last updated the object.
  
  createTime integer | null
  
  Time (epoch) at which this object was created, in milliseconds.
  
  updateTime integer | null
  
  Time (epoch) at which this object was last updated, in milliseconds.
  
  version integer | null
  
  Version of this object.
  
  classificationNames array[string] | null
  
  List of classifications for this entity. Note that these are the internal hashed names used in Atlan, not the displayText of the classification.
  
  labels array[string] | null
  
  Internal use only.
  
  status string
  
  Status of the entity, either ACTIVE or DELETED.
  
  Values are ACTIVE or DELETED.
  
  customAttributes object | null
  
  Internal use only.
  
  Additional properties: string
  
  pendingTasks array[string] | null
  
  Internal use only.
  
  referredEntities object
  
  Map of related entities keyed by the GUID of the related entity. The values will be the detailed entity object of the related entity.
  
  typeName string
  
  Name of the type definition that defines this instance.
  
  attributes object | null
  
  Attributes that can exist across all assets in Atlan.
  
  qualifiedName string
  
  Unique name for this asset. This is typically a concatenation of the asset's name onto its parent's qualifiedName.
  
  name string
  
  Human-readable name of the asset.
  
  displayName string | null
  
  Name used for display purposes (in user interfaces).
  
  description string | null
  
  Description of the asset, as crawled from a source.
  
  userDescription string | null
  
  Description of the asset, as provided by a user. If present, this will be used for the description in user interfaces. If not present, the description will be used.
  
  tenantId string
  
  Name of the Atlan workspace in which the table exists.
  
  certificateStatus string | null
  
  Status of the asset's certification.
  
  Values are VERIFIED, DRAFT, or DEPRECATED.
  
  certificateStatusMessage string | null
  
  Human-readable descriptive message that can optionally be submitted when the certificateStatus is changed.
  
  announcementTitle string | null
  
  Brief title for the announcement on this asset. Required when announcementType is specified.
  
  announcementMessage string | null
  
  Detailed message to include in the announcement on this asset.
  
  announcementType string | null
  
  Type of announcement on the asset.
  
  Values are information, warning, or issue.
  
  ownerUsers array[string] | null
  
  List of users who own the asset.
  
  ownerGroups array[string] | null
  
  List of groups who own the asset.
  
  adminUsers array[string] | null
  
  List of users who administer the asset. (This is only used for Connection assets?)
  
  adminGroups array[string] | null
  
  List of groups who administer the asset. (This is only used for Connection assets?)
  
  viewerUsers array[string] | null
  
  viewerGroups array[string] | null
  
  connectorName string | null
  
  Name of the connector through which this asset is accessible.
  
  connectionName string | null Deprecated
  
  Unused.
  
  connectionQualifiedName string | null
  
  Unique name of the connection through which this asset is accessible.
  
  isDiscoverable boolean
  
  isEditable boolean
  
  subType object | null
  
  viewScore number | null
  
  popularityScore number | null
  
  sourceOwners array[string] | null
  
  sourceURL string | null
  
  lastSyncWorkflowName string | null
  
  Name of the crawler that last synchronized this asset.
  
  lastSyncRunAt integer | null
  
  Time (epoch) at which the table was last crawled, in milliseconds.
  
  lastSyncRun string | null
  
  Name of the last run of the crawler that last synchronized this asset.
  
  certificateUpdatedBy string | null
  
  Name of the user who last updated the certificateStatus.
  
  certificateUpdatedAt integer | null
  
  Time (epoch) at which the certificateStatus was last updated, in milliseconds.
  
  announcementUpdatedAt integer | null
  
  Time (epoch) at which the announcement was last updated, in milliseconds.
  
  announcementUpdatedBy string | null
  
  User who last updated the announcement.
  
  sourceCreatedBy string | null
  
  sourceCreatedAt integer | null
  
  sourceUpdatedAt integer | null
  
  sourceUpdatedBy string | null
  
  classifications array[object] | null
  
  Instance of a classification in Atlan.
  
  typeName string
  
  Name of the classification. Note that this is the static-hashed unique name of the classification, not the human-readable displayName.
  
  entityGuid string
  
  Unique identifier of the entity to which this classification is attached.
  
  propagate boolean | null
  
  Whether to propagate this classification to other entities related to the entity to which the classification is attached.
  
  removePropagationsOnEntityDelete boolean | null
  
  Whether to remove this classification from other entities to which it has been propagated when the classification is removed from this entity.
  
  displayText string | null
  
  Human-readable name of the entity.
  
  guid string
  
  Unique identifier of the entity instance.
  
  isIncomplete boolean | null
  
  Default value is false.
  
  businessAttributes object | null
  
  Map of custom metadata attributes and values defined on the entity.
  
  relationshipAttributes object | null
  
  Map of the relationships to this asset.
  
  links array[object]
  
  Details to use within an asset when referring to a link (resource).
  
  typeName string
  
  Should always be Link.
  
  guid string | null
  
  Unique identifier of the related link. If the uniqueAttributes are not provided, this must be provided.
  
  uniqueAttributes object | null
  
  Attribute(s) that uniquely identify the related link. If the guid is not provided, these must be provided.
  
  qualifiedName string
  
  Unique name of the related link. Note that this is a generated unique name which is not visible in the UI.
  
  readme object
  
  Details to use within an asset when referring to a readme.
  
  typeName string
  
  Should always be Readme.
  
  guid string | null
  
  Unique identifier of the related readme. If the uniqueAttributes are not provided, this must be provided.
  
  uniqueAttributes object | null
  
  Attribute(s) that uniquely identify the related readme. If the guid is not provided, these must be provided.
  
  qualifiedName string
  
  Unique name of the related readme.
  
  meanings array[object]
  
  Details to use within an asset when referring to a term.
  
  typeName string
  
  Should always be AtlasnGlossaryTerm.
  
  guid string | null
  
  Unique identifier of the related term. If the uniqueAttributes are not provided, this must be provided.
  
  uniqueAttributes object | null
  
  Attribute(s) that uniquely identify the related term. If the guid is not provided, these must be provided.
  
  qualifiedName string
  
  Unique name of the related term. Note that in Atlan this unique name is a hashed value, not the name you see in the UI.
  
  UPDATE array[object]
  
  Instance of an asset in Atlan, with its detailed information.
  
  entity object
  
  Instance of an entity in Atlan, with its detailed information.
  
  typeName string
  
  Name of the type definition that defines this instance.
  
  attributes object | null
  
  Will be further documented in sub-types of EntityHeader.
  
  classifications array[object] | null
  
  Instance of a classification in Atlan, with its detailed information.
  
  typeName string
  
  Name of the classification. Note that this is the static-hashed unique name of the classification, not the human-readable displayName.
  
  entityGuid string
  
  Unique identifier of the entity to which this classification is attached.
  
  propagate boolean | null
  
  Whether to propagate this classification to other entities related to the entity to which the classification is attached.
  
  removePropagationsOnEntityDelete boolean | null
  
  Whether to remove this classification from other entities to which it has been propagated when the classification is removed from this entity.
  
  entityStatus string | null
  
  Status of the entity to which this classification is attached.
  
  Values are ACTIVE or DELETED.
  
  displayText string | null
  
  Human-readable name of the entity.
  
  guid string
  
  Unique identifier of the entity instance.
  
  isIncomplete boolean | null
  
  Default value is false.
  
  businessAttributes object | null
  
  Map of custom metadata attributes and values defined on the entity.
  
  relationshipAttributes object
  
  Map of relationships for the entity. The specific keys of this map will vary by type, so are described in the sub-types of this schema.
  
  createdBy string | null
  
  Username of the user who created the object.
  
  updatedBy string | null
  
  Username of the user who last updated the object.
  
  createTime integer | null
  
  Time (epoch) at which this object was created, in milliseconds.
  
  updateTime integer | null
  
  Time (epoch) at which this object was last updated, in milliseconds.
  
  version integer | null
  
  Version of this object.
  
  classificationNames array[string] | null
  
  List of classifications for this entity. Note that these are the internal hashed names used in Atlan, not the displayText of the classification.
  
  labels array[string] | null
  
  Internal use only.
  
  status string
  
  Status of the entity, either ACTIVE or DELETED.
  
  Values are ACTIVE or DELETED.
  
  customAttributes object | null
  
  Internal use only.
  
  Additional properties: string
  
  pendingTasks array[string] | null
  
  Internal use only.
  
  referredEntities object
  
  Map of related entities keyed by the GUID of the related entity. The values will be the detailed entity object of the related entity.
  
  typeName string
  
  Name of the type definition that defines this instance.
  
  attributes object | null
  
  Attributes that can exist across all assets in Atlan.
  
  qualifiedName string
  
  Unique name for this asset. This is typically a concatenation of the asset's name onto its parent's qualifiedName.
  
  name string
  
  Human-readable name of the asset.
  
  displayName string | null
  
  Name used for display purposes (in user interfaces).
  
  description string | null
  
  Description of the asset, as crawled from a source.
  
  userDescription string | null
  
  Description of the asset, as provided by a user. If present, this will be used for the description in user interfaces. If not present, the description will be used.
  
  tenantId string
  
  Name of the Atlan workspace in which the table exists.
  
  certificateStatus string | null
  
  Status of the asset's certification.
  
  Values are VERIFIED, DRAFT, or DEPRECATED.
  
  certificateStatusMessage string | null
  
  Human-readable descriptive message that can optionally be submitted when the certificateStatus is changed.
  
  announcementTitle string | null
  
  Brief title for the announcement on this asset. Required when announcementType is specified.
  
  announcementMessage string | null
  
  Detailed message to include in the announcement on this asset.
  
  announcementType string | null
  
  Type of announcement on the asset.
  
  Values are information, warning, or issue.
  
  ownerUsers array[string] | null
  
  List of users who own the asset.
  
  ownerGroups array[string] | null
  
  List of groups who own the asset.
  
  adminUsers array[string] | null
  
  List of users who administer the asset. (This is only used for Connection assets?)
  
  adminGroups array[string] | null
  
  List of groups who administer the asset. (This is only used for Connection assets?)
  
  viewerUsers array[string] | null
  
  viewerGroups array[string] | null
  
  connectorName string | null
  
  Name of the connector through which this asset is accessible.
  
  connectionName string | null Deprecated
  
  Unused.
  
  connectionQualifiedName string | null
  
  Unique name of the connection through which this asset is accessible.
  
  isDiscoverable boolean
  
  isEditable boolean
  
  subType object | null
  
  viewScore number | null
  
  popularityScore number | null
  
  sourceOwners array[string] | null
  
  sourceURL string | null
  
  lastSyncWorkflowName string | null
  
  Name of the crawler that last synchronized this asset.
  
  lastSyncRunAt integer | null
  
  Time (epoch) at which the table was last crawled, in milliseconds.
  
  lastSyncRun string | null
  
  Name of the last run of the crawler that last synchronized this asset.
  
  certificateUpdatedBy string | null
  
  Name of the user who last updated the certificateStatus.
  
  certificateUpdatedAt integer | null
  
  Time (epoch) at which the certificateStatus was last updated, in milliseconds.
  
  announcementUpdatedAt integer | null
  
  Time (epoch) at which the announcement was last updated, in milliseconds.
  
  announcementUpdatedBy string | null
  
  User who last updated the announcement.
  
  sourceCreatedBy string | null
  
  sourceCreatedAt integer | null
  
  sourceUpdatedAt integer | null
  
  sourceUpdatedBy string | null
  
  classifications array[object] | null
  
  Instance of a classification in Atlan.
  
  typeName string
  
  Name of the classification. Note that this is the static-hashed unique name of the classification, not the human-readable displayName.
  
  entityGuid string
  
  Unique identifier of the entity to which this classification is attached.
  
  propagate boolean | null
  
  Whether to propagate this classification to other entities related to the entity to which the classification is attached.
  
  removePropagationsOnEntityDelete boolean | null
  
  Whether to remove this classification from other entities to which it has been propagated when the classification is removed from this entity.
  
  displayText string | null
  
  Human-readable name of the entity.
  
  guid string
  
  Unique identifier of the entity instance.
  
  isIncomplete boolean | null
  
  Default value is false.
  
  businessAttributes object | null
  
  Map of custom metadata attributes and values defined on the entity.
  
  relationshipAttributes object | null
  
  Map of the relationships to this asset.
  
  links array[object]
  
  Details to use within an asset when referring to a link (resource).
  
  typeName string
  
  Should always be Link.
  
  guid string | null
  
  Unique identifier of the related link. If the uniqueAttributes are not provided, this must be provided.
  
  uniqueAttributes object | null
  
  Attribute(s) that uniquely identify the related link. If the guid is not provided, these must be provided.
  
  qualifiedName string
  
  Unique name of the related link. Note that this is a generated unique name which is not visible in the UI.
  
  readme object
  
  Details to use within an asset when referring to a readme.
  
  typeName string
  
  Should always be Readme.
  
  guid string | null
  
  Unique identifier of the related readme. If the uniqueAttributes are not provided, this must be provided.
  
  uniqueAttributes object | null
  
  Attribute(s) that uniquely identify the related readme. If the guid is not provided, these must be provided.
  
  qualifiedName string
  
  Unique name of the related readme.
  
  meanings array[object]
  
  Details to use within an asset when referring to a term.
  
  typeName string
  
  Should always be AtlasnGlossaryTerm.
  
  guid string | null
  
  Unique identifier of the related term. If the uniqueAttributes are not provided, this must be provided.
  
  uniqueAttributes object | null
  
  Attribute(s) that uniquely identify the related term. If the guid is not provided, these must be provided.
  
  qualifiedName string
  
  Unique name of the related term. Note that in Atlan this unique name is a hashed value, not the name you see in the UI.
- guidAssignments object
  
  Map of assigned unique identifiers for the changed assets.
• 404 object

Entity does not exist, or is deleted.
- errorCode string
  
  Unique code for the type of error that occurred.
- errorMessage string
  
  Human-readable description of the error that occurred.

POST /api/meta/entity/bulk#attachGlossaryTerm

curl \
 -X POST https://tenant.atlan.com/api/meta/entity/bulk#attachGlossaryTerm \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"entities":[{"typeName":"Column","attributes":{"name":"ID","qualifiedName":"default/snowflake/123456789/TEST_DB/TEST_SCHEMA/CUSTOMER/ID"},"relationshipAttributes":{"meanings":[{"typeName":"AtlasGlossaryTerm","uniqueAttributes":{"qualifiedName":"T20JsKts9CMpznRcpGJJd@vdLN8ETB3KiDLTzoDcT6j"}}]}},{"typeName":"Column","attributes":{"name":"NAME","qualifiedName":"default/snowflake/123456789/TEST_DB/TEST_SCHEMA/CUSTOMER/NAME"},"relationshipAttributes":{"meanings":[{"typeName":"AtlasGlossaryTerm","guid":"ce55c5e1-c93e-45d9-a915-4526d9c6bf96"}]}}]}'

Request example

{
  "entities": [
    {
      "typeName": "Column",
      "attributes": {
        "name": "ID",
        "qualifiedName": "default/snowflake/123456789/TEST_DB/TEST_SCHEMA/CUSTOMER/ID"
      },
      "relationshipAttributes": {
        "meanings": [
          {
            "typeName": "AtlasGlossaryTerm",
            "uniqueAttributes": {
              "qualifiedName": "T20JsKts9CMpznRcpGJJd@vdLN8ETB3KiDLTzoDcT6j"
            }
          }
        ]
      }
    },
    {
      "typeName": "Column",
      "attributes": {
        "name": "NAME",
        "qualifiedName": "default/snowflake/123456789/TEST_DB/TEST_SCHEMA/CUSTOMER/NAME"
      },
      "relationshipAttributes": {
        "meanings": [
          {
            "typeName": "AtlasGlossaryTerm",
            "guid": "ce55c5e1-c93e-45d9-a915-4526d9c6bf96"
          }
        ]
      }
    }
  ]
}

Response example (200)

{
  "mutatedEntities": {
    "UPDATE": [
      {
        "typeName": "Column",
        "attributes": {
          "name": "ID",
          "qualifiedName": "default/snowflake/123456789/TEST_DB/TEST_SCHEMA/CUSTOMER/ID"
        },
        "guid": "f5740924-fe74-4462-96ff-5da0bc970cec",
        "relationshipAttributes": {
          "meanings": [
            {
              "typeName": "AtlasGlossaryTerm",
              "guid": "91aaf8a0-be52-4a65-a21f-e6a6bfd4c00f",
              "uniqueAttributes": {
                "qualifiedName": "T20JsKts9CMpznRcpGJJd@vdLN8ETB3KiDLTzoDcT6j"
              }
            }
          ]
        }
      },
      {
        "typeName": "Column",
        "attributes": {
          "name": "NAME",
          "qualifiedName": "default/snowflake/123456789/TEST_DB/TEST_SCHEMA/CUSTOMER/NAME"
        },
        "guid": "23d6ec91-9399-41bf-8427-5cc91caaa42d",
        "relationshipAttributes": {
          "meanings": [
            {
              "typeName": "AtlasGlossaryTerm",
              "guid": "ce55c5e1-c93e-45d9-a915-4526d9c6bf96",
              "uniqueAttributes": {
                "qualifiedName": "U19IqLst8DZqrtKopMXP9@vdLN8ETB3KiDLTzoDcT6j"
              }
            }
          ]
        }
      }
    ],
    "guidAssignments": {
      "-10887525374267651": "f5740924-fe74-4462-96ff-5da0bc970cec",
      "-10887525374267652": "23d6ec91-9399-41bf-8427-5cc91caaa42d"
    }
  }
}

Response example (404)

{
  "errorCode": "ATLAS-404-00-005",
  "errorMessage": "Given instance guid abc123 is invalid/not found\n"
}

Add a readme

POST /api/meta/entity/bulk#addReadme

Attach a readme to an asset.

Note that the creation of a readme relies on no match being found for the provided qualifiedNames. If the qualifiedNames do match any existing readme, that readme will instead be updated rather than a new one being created. Also be aware that the qualifiedName is case-sensitive.

For more details on the semantics and other attributes available through this interface, see the Upsert entities operation.

Body Required

List of readmes (entities) and the asset to attach them to.

entities array[object] Required

Instance of a readme in Atlan, with its detailed information.
- attributes object Required
  
  Attributes that can exist in readmes in Atlan.
  link string | null
  
  isGlobal boolean | null
  
  reference string | null
  
  qualifiedName string Required
  
  Unique name for this readme. This is usually the concatenation of the related asset's GUID with /readme.
  
  name string Required
  
  Human-readable name of the readme. This is usually the concatenation of the related asset's name with Readme.
  
  description string | null Required
  
  Contents of the readme. This should be a string of HTML that has been URL-encoded. For examples of the decoded form, run the example description value through urldecoder.org. For examples of an encoded form, write plain-text HTML into urlencoder.org.
- typeName string Required
  
  Should always be Readme.
- relationshipAttributes object | null Required
  
  Relationships that can exist across all readmes in Atlan.
  asset object Required
  
  Asset to which this readme should be attached.
  
  typeName string
  
  Should be some sub-type of Asset.
  
  Values are AtlasGlossary, AtlasGlossaryCategory, AtlasGlossaryTerm, Readme, Link, Insight, Query, Database, Schema, Table, View, MaterialisedView, Column, Procedure, TablePartition, LookerDashboard, LookerExplore, LookerField, LookerFolder, LookerLook, LookerModel, LookerProject, LookerQuery, LookerTile, PowerBIDashboard, PowerBIDataflow, PowerBIDataset, PowerBIDatasource, PowerBIPage, PowerBIReport, PowerBITile, PowerBIWorkspace, SalesforceDashboard, SalesforceField, SalesforceObject, SalesforceOrganization, SalesforceReport, TableauCalculatedField, TableauDashboard, TableauDatasource, TableauDatasourceField, TableauFlow, TableauMetric, TableauProject, TableauSite, TableauWorkbook, TableauWorksheet, ObjectStore, S3, S3Bucket, S3Object, DataStudioAsset, Process, BIProcess, or ColumnProcess.
  
  guid string | null
  
  Unique identifier of the related object. If the uniqueAttributes are not provided, this must be provided.
  
  uniqueAttributes object | null
  
  Attribute(s) that uniquely identify the related object. If the guid is not provided, these must be provided.
  
  qualifiedName string | null
  
  Unique name of the related object.

Responses

• 200 object

Readme(s) were successfully created and attached.
- mutatedEntities object | null
  
  Assets that were changed.
  CREATE array[object]
  
  Instance of an asset in Atlan, with its detailed information.
  
  entity object
  
  Instance of an entity in Atlan, with its detailed information.
  
  typeName string
  
  Name of the type definition that defines this instance.
  
  attributes object | null
  
  Will be further documented in sub-types of EntityHeader.
  
  classifications array[object] | null
  
  Instance of a classification in Atlan, with its detailed information.
  
  typeName string
  
  Name of the classification. Note that this is the static-hashed unique name of the classification, not the human-readable displayName.
  
  entityGuid string
  
  Unique identifier of the entity to which this classification is attached.
  
  propagate boolean | null
  
  Whether to propagate this classification to other entities related to the entity to which the classification is attached.
  
  removePropagationsOnEntityDelete boolean | null
  
  Whether to remove this classification from other entities to which it has been propagated when the classification is removed from this entity.
  
  entityStatus string | null
  
  Status of the entity to which this classification is attached.
  
  Values are ACTIVE or DELETED.
  
  displayText string | null
  
  Human-readable name of the entity.
  
  guid string
  
  Unique identifier of the entity instance.
  
  isIncomplete boolean | null
  
  Default value is false.
  
  businessAttributes object | null
  
  Map of custom metadata attributes and values defined on the entity.
  
  relationshipAttributes object
  
  Map of relationships for the entity. The specific keys of this map will vary by type, so are described in the sub-types of this schema.
  
  createdBy string | null
  
  Username of the user who created the object.
  
  updatedBy string | null
  
  Username of the user who last updated the object.
  
  createTime integer | null
  
  Time (epoch) at which this object was created, in milliseconds.
  
  updateTime integer | null
  
  Time (epoch) at which this object was last updated, in milliseconds.
  
  version integer | null
  
  Version of this object.
  
  classificationNames array[string] | null
  
  List of classifications for this entity. Note that these are the internal hashed names used in Atlan, not the displayText of the classification.
  
  labels array[string] | null
  
  Internal use only.
  
  status string
  
  Status of the entity, either ACTIVE or DELETED.
  
  Values are ACTIVE or DELETED.
  
  customAttributes object | null
  
  Internal use only.
  
  Additional properties: string
  
  pendingTasks array[string] | null
  
  Internal use only.
  
  referredEntities object
  
  Map of related entities keyed by the GUID of the related entity. The values will be the detailed entity object of the related entity.
  
  typeName string
  
  Name of the type definition that defines this instance.
  
  attributes object | null
  
  Attributes that can exist across all assets in Atlan.
  
  qualifiedName string
  
  Unique name for this asset. This is typically a concatenation of the asset's name onto its parent's qualifiedName.
  
  name string
  
  Human-readable name of the asset.
  
  displayName string | null
  
  Name used for display purposes (in user interfaces).
  
  description string | null
  
  Description of the asset, as crawled from a source.
  
  userDescription string | null
  
  Description of the asset, as provided by a user. If present, this will be used for the description in user interfaces. If not present, the description will be used.
  
  tenantId string
  
  Name of the Atlan workspace in which the table exists.
  
  certificateStatus string | null
  
  Status of the asset's certification.
  
  Values are VERIFIED, DRAFT, or DEPRECATED.
  
  certificateStatusMessage string | null
  
  Human-readable descriptive message that can optionally be submitted when the certificateStatus is changed.
  
  announcementTitle string | null
  
  Brief title for the announcement on this asset. Required when announcementType is specified.
  
  announcementMessage string | null
  
  Detailed message to include in the announcement on this asset.
  
  announcementType string | null
  
  Type of announcement on the asset.
  
  Values are information, warning, or issue.
  
  ownerUsers array[string] | null
  
  List of users who own the asset.
  
  ownerGroups array[string] | null
  
  List of groups who own the asset.
  
  adminUsers array[string] | null
  
  List of users who administer the asset. (This is only used for Connection assets?)
  
  adminGroups array[string] | null
  
  List of groups who administer the asset. (This is only used for Connection assets?)
  
  viewerUsers array[string] | null
  
  viewerGroups array[string] | null
  
  connectorName string | null
  
  Name of the connector through which this asset is accessible.
  
  connectionName string | null Deprecated
  
  Unused.
  
  connectionQualifiedName string | null
  
  Unique name of the connection through which this asset is accessible.
  
  isDiscoverable boolean
  
  isEditable boolean
  
  subType object | null
  
  viewScore number | null
  
  popularityScore number | null
  
  sourceOwners array[string] | null
  
  sourceURL string | null
  
  lastSyncWorkflowName string | null
  
  Name of the crawler that last synchronized this asset.
  
  lastSyncRunAt integer | null
  
  Time (epoch) at which the table was last crawled, in milliseconds.
  
  lastSyncRun string | null
  
  Name of the last run of the crawler that last synchronized this asset.
  
  certificateUpdatedBy string | null
  
  Name of the user who last updated the certificateStatus.
  
  certificateUpdatedAt integer | null
  
  Time (epoch) at which the certificateStatus was last updated, in milliseconds.
  
  announcementUpdatedAt integer | null
  
  Time (epoch) at which the announcement was last updated, in milliseconds.
  
  announcementUpdatedBy string | null
  
  User who last updated the announcement.
  
  sourceCreatedBy string | null
  
  sourceCreatedAt integer | null
  
  sourceUpdatedAt integer | null
  
  sourceUpdatedBy string | null
  
  classifications array[object] | null
  
  Instance of a classification in Atlan.
  
  typeName string
  
  Name of the classification. Note that this is the static-hashed unique name of the classification, not the human-readable displayName.
  
  entityGuid string
  
  Unique identifier of the entity to which this classification is attached.
  
  propagate boolean | null
  
  Whether to propagate this classification to other entities related to the entity to which the classification is attached.
  
  removePropagationsOnEntityDelete boolean | null
  
  Whether to remove this classification from other entities to which it has been propagated when the classification is removed from this entity.
  
  displayText string | null
  
  Human-readable name of the entity.
  
  guid string
  
  Unique identifier of the entity instance.
  
  isIncomplete boolean | null
  
  Default value is false.
  
  businessAttributes object | null
  
  Map of custom metadata attributes and values defined on the entity.
  
  relationshipAttributes object | null
  
  Map of the relationships to this asset.
  
  links array[object]
  
  Details to use within an asset when referring to a link (resource).
  
  typeName string
  
  Should always be Link.
  
  guid string | null
  
  Unique identifier of the related link. If the uniqueAttributes are not provided, this must be provided.
  
  uniqueAttributes object | null
  
  Attribute(s) that uniquely identify the related link. If the guid is not provided, these must be provided.
  
  qualifiedName string
  
  Unique name of the related link. Note that this is a generated unique name which is not visible in the UI.
  
  readme object
  
  Details to use within an asset when referring to a readme.
  
  typeName string
  
  Should always be Readme.
  
  guid string | null
  
  Unique identifier of the related readme. If the uniqueAttributes are not provided, this must be provided.
  
  uniqueAttributes object | null
  
  Attribute(s) that uniquely identify the related readme. If the guid is not provided, these must be provided.
  
  qualifiedName string
  
  Unique name of the related readme.
  
  meanings array[object]
  
  Details to use within an asset when referring to a term.
  
  typeName string
  
  Should always be AtlasnGlossaryTerm.
  
  guid string | null
  
  Unique identifier of the related term. If the uniqueAttributes are not provided, this must be provided.
  
  uniqueAttributes object | null
  
  Attribute(s) that uniquely identify the related term. If the guid is not provided, these must be provided.
  
  qualifiedName string
  
  Unique name of the related term. Note that in Atlan this unique name is a hashed value, not the name you see in the UI.
  
  UPDATE array[object]
  
  Instance of an asset in Atlan, with its detailed information.
  
  entity object
  
  Instance of an entity in Atlan, with its detailed information.
  
  typeName string
  
  Name of the type definition that defines this instance.
  
  attributes object | null
  
  Will be further documented in sub-types of EntityHeader.
  
  classifications array[object] | null
  
  Instance of a classification in Atlan, with its detailed information.
  
  typeName string
  
  Name of the classification. Note that this is the static-hashed unique name of the classification, not the human-readable displayName.
  
  entityGuid string
  
  Unique identifier of the entity to which this classification is attached.
  
  propagate boolean | null
  
  Whether to propagate this classification to other entities related to the entity to which the classification is attached.
  
  removePropagationsOnEntityDelete boolean | null
  
  Whether to remove this classification from other entities to which it has been propagated when the classification is removed from this entity.
  
  entityStatus string | null
  
  Status of the entity to which this classification is attached.
  
  Values are ACTIVE or DELETED.
  
  displayText string | null
  
  Human-readable name of the entity.
  
  guid string
  
  Unique identifier of the entity instance.
  
  isIncomplete boolean | null
  
  Default value is false.
  
  businessAttributes object | null
  
  Map of custom metadata attributes and values defined on the entity.
  
  relationshipAttributes object
  
  Map of relationships for the entity. The specific keys of this map will vary by type, so are described in the sub-types of this schema.
  
  createdBy string | null
  
  Username of the user who created the object.
  
  updatedBy string | null
  
  Username of the user who last updated the object.
  
  createTime integer | null
  
  Time (epoch) at which this object was created, in milliseconds.
  
  updateTime integer | null
  
  Time (epoch) at which this object was last updated, in milliseconds.
  
  version integer | null
  
  Version of this object.
  
  classificationNames array[string] | null
  
  List of classifications for this entity. Note that these are the internal hashed names used in Atlan, not the displayText of the classification.
  
  labels array[string] | null
  
  Internal use only.
  
  status string
  
  Status of the entity, either ACTIVE or DELETED.
  
  Values are ACTIVE or DELETED.
  
  customAttributes object | null
  
  Internal use only.
  
  Additional properties: string
  
  pendingTasks array[string] | null
  
  Internal use only.
  
  referredEntities object
  
  Map of related entities keyed by the GUID of the related entity. The values will be the detailed entity object of the related entity.
  
  typeName string
  
  Name of the type definition that defines this instance.
  
  attributes object | null
  
  Attributes that can exist across all assets in Atlan.
  
  qualifiedName string
  
  Unique name for this asset. This is typically a concatenation of the asset's name onto its parent's qualifiedName.
  
  name string
  
  Human-readable name of the asset.
  
  displayName string | null
  
  Name used for display purposes (in user interfaces).
  
  description string | null
  
  Description of the asset, as crawled from a source.
  
  userDescription string | null
  
  Description of the asset, as provided by a user. If present, this will be used for the description in user interfaces. If not present, the description will be used.
  
  tenantId string
  
  Name of the Atlan workspace in which the table exists.
  
  certificateStatus string | null
  
  Status of the asset's certification.
  
  Values are VERIFIED, DRAFT, or DEPRECATED.
  
  certificateStatusMessage string | null
  
  Human-readable descriptive message that can optionally be submitted when the certificateStatus is changed.
  
  announcementTitle string | null
  
  Brief title for the announcement on this asset. Required when announcementType is specified.
  
  announcementMessage string | null
  
  Detailed message to include in the announcement on this asset.
  
  announcementType string | null
  
  Type of announcement on the asset.
  
  Values are information, warning, or issue.
  
  ownerUsers array[string] | null
  
  List of users who own the asset.
  
  ownerGroups array[string] | null
  
  List of groups who own the asset.
  
  adminUsers array[string] | null
  
  List of users who administer the asset. (This is only used for Connection assets?)
  
  adminGroups array[string] | null
  
  List of groups who administer the asset. (This is only used for Connection assets?)
  
  viewerUsers array[string] | null
  
  viewerGroups array[string] | null
  
  connectorName string | null
  
  Name of the connector through which this asset is accessible.
  
  connectionName string | null Deprecated
  
  Unused.
  
  connectionQualifiedName string | null
  
  Unique name of the connection through which this asset is accessible.
  
  isDiscoverable boolean
  
  isEditable boolean
  
  subType object | null
  
  viewScore number | null
  
  popularityScore number | null
  
  sourceOwners array[string] | null
  
  sourceURL string | null
  
  lastSyncWorkflowName string | null
  
  Name of the crawler that last synchronized this asset.
  
  lastSyncRunAt integer | null
  
  Time (epoch) at which the table was last crawled, in milliseconds.
  
  lastSyncRun string | null
  
  Name of the last run of the crawler that last synchronized this asset.
  
  certificateUpdatedBy string | null
  
  Name of the user who last updated the certificateStatus.
  
  certificateUpdatedAt integer | null
  
  Time (epoch) at which the certificateStatus was last updated, in milliseconds.
  
  announcementUpdatedAt integer | null
  
  Time (epoch) at which the announcement was last updated, in milliseconds.
  
  announcementUpdatedBy string | null
  
  User who last updated the announcement.
  
  sourceCreatedBy string | null
  
  sourceCreatedAt integer | null
  
  sourceUpdatedAt integer | null
  
  sourceUpdatedBy string | null
  
  classifications array[object] | null
  
  Instance of a classification in Atlan.
  
  typeName string
  
  Name of the classification. Note that this is the static-hashed unique name of the classification, not the human-readable displayName.
  
  entityGuid string
  
  Unique identifier of the entity to which this classification is attached.
  
  propagate boolean | null
  
  Whether to propagate this classification to other entities related to the entity to which the classification is attached.
  
  removePropagationsOnEntityDelete boolean | null
  
  Whether to remove this classification from other entities to which it has been propagated when the classification is removed from this entity.
  
  displayText string | null
  
  Human-readable name of the entity.
  
  guid string
  
  Unique identifier of the entity instance.
  
  isIncomplete boolean | null
  
  Default value is false.
  
  businessAttributes object | null
  
  Map of custom metadata attributes and values defined on the entity.
  
  relationshipAttributes object | null
  
  Map of the relationships to this asset.
  
  links array[object]
  
  Details to use within an asset when referring to a link (resource).
  
  typeName string
  
  Should always be Link.
  
  guid string | null
  
  Unique identifier of the related link. If the uniqueAttributes are not provided, this must be provided.
  
  uniqueAttributes object | null
  
  Attribute(s) that uniquely identify the related link. If the guid is not provided, these must be provided.
  
  qualifiedName string
  
  Unique name of the related link. Note that this is a generated unique name which is not visible in the UI.
  
  readme object
  
  Details to use within an asset when referring to a readme.
  
  typeName string
  
  Should always be Readme.
  
  guid string | null
  
  Unique identifier of the related readme. If the uniqueAttributes are not provided, this must be provided.
  
  uniqueAttributes object | null
  
  Attribute(s) that uniquely identify the related readme. If the guid is not provided, these must be provided.
  
  qualifiedName string
  
  Unique name of the related readme.
  
  meanings array[object]
  
  Details to use within an asset when referring to a term.
  
  typeName string
  
  Should always be AtlasnGlossaryTerm.
  
  guid string | null
  
  Unique identifier of the related term. If the uniqueAttributes are not provided, this must be provided.
  
  uniqueAttributes object | null
  
  Attribute(s) that uniquely identify the related term. If the guid is not provided, these must be provided.
  
  qualifiedName string
  
  Unique name of the related term. Note that in Atlan this unique name is a hashed value, not the name you see in the UI.
- guidAssignments object
  
  Map of assigned unique identifiers for the changed assets.

POST /api/meta/entity/bulk#addReadme

curl \
 -X POST https://tenant.atlan.com/api/meta/entity/bulk#addReadme \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"entities":[{"typeName":"Readme","attributes":{"name":"user_id Readme","qualifiedName":"2e5b4bdb-592d-4964-afbe-021214b0cc9f/readme\n","description":"%3Ch2%3EID%3C%2Fh2%3E%3Cp%3EUnique%20identifier%20of%20a%20customer.%3C%2Fp%3E"},"relationshipAttributes":{"asset":{"typeName":"Column","guid":"2e5b4bdb-592d-4964-afbe-021214b0cc9f"}}},{"typeName":"Readme","attributes":{"name":"INSTACART_TOP_USERS Readme","qualifiedName":"c1ef6535-4c9d-4946-83a3-9f70d7a98e47/readme","description":"%3Ch2%3EOverview%3C%2Fh2%3E%3Cp%3ETop%20users%20of%20our%20website.%3C%2Fp%3E"},"relationshipAttributes":{"asset":{"typeName":"Table","guid":"d45fb048-0461-44ec-9cc7-eaf7a438c8df"}}}]}'

Request example

{
  "entities": [
    {
      "typeName": "Readme",
      "attributes": {
        "name": "user_id Readme",
        "qualifiedName": "2e5b4bdb-592d-4964-afbe-021214b0cc9f/readme\n",
        "description": "%3Ch2%3EID%3C%2Fh2%3E%3Cp%3EUnique%20identifier%20of%20a%20customer.%3C%2Fp%3E"
      },
      "relationshipAttributes": {
        "asset": {
          "typeName": "Column",
          "guid": "2e5b4bdb-592d-4964-afbe-021214b0cc9f"
        }
      }
    },
    {
      "typeName": "Readme",
      "attributes": {
        "name": "INSTACART_TOP_USERS Readme",
        "qualifiedName": "c1ef6535-4c9d-4946-83a3-9f70d7a98e47/readme",
        "description": "%3Ch2%3EOverview%3C%2Fh2%3E%3Cp%3ETop%20users%20of%20our%20website.%3C%2Fp%3E"
      },
      "relationshipAttributes": {
        "asset": {
          "typeName": "Table",
          "guid": "d45fb048-0461-44ec-9cc7-eaf7a438c8df"
        }
      }
    }
  ]
}

Response example (200)

{
  "mutatedEntities": {
    "CREATE": [
      {
        "typeName": "Readme",
        "attributes": {
          "popularityScore": 1.17549435e-38,
          "viewerUsers": [],
          "sourceCreatedAt": 0,
          "viewScore": 1.17549435e-38,
          "lastSyncRunAt": 0,
          "adminRoles": [],
          "adminGroups": [],
          "qualifiedName": "2e5b4bdb-592d-4964-afbe-021214b0cc9f/readme",
          "__hasLineage": false,
          "description": "%3Ch2%3EID%3C%2Fh2%3E%3Cp%3EUnique%20identifier%20of%20a%20customer.%3C%2Fp%3E\n",
          "adminUsers": [],
          "ownerGroups": [],
          "isEditable": true,
          "sourceUpdatedAt": 0,
          "announcementUpdatedAt": 0,
          "name": "user_id Readme",
          "certificateUpdatedAt": 0,
          "isGlobal": false,
          "isDiscoverable": true,
          "viewerGroups": [],
          "ownerUsers": []
        },
        "guid": "2992ae78-c480-48b9-b61a-67cce210e3d7",
        "status": "ACTIVE",
        "displayText": "user_id Readme",
        "classificationNames": [],
        "classifications": [],
        "meaningNames": [],
        "meanings": [],
        "isIncomplete": false,
        "labels": [],
        "createdBy": "service-account-apikey-e8d1f0bd-600e-4a8a-9248-b7c9aa1ef8c3",
        "updatedBy": "service-account-apikey-e8d1f0bd-600e-4a8a-9248-b7c9aa1ef8c3",
        "createTime": 1655460145909,
        "updateTime": 1655460145909
      },
      {
        "typeName": "Readme",
        "attributes": {
          "popularityScore": 1.17549435e-38,
          "viewerUsers": [],
          "sourceCreatedAt": 0,
          "viewScore": 1.17549435e-38,
          "lastSyncRunAt": 0,
          "adminRoles": [],
          "adminGroups": [],
          "qualifiedName": "c1ef6535-4c9d-4946-83a3-9f70d7a98e47/readme",
          "__hasLineage": false,
          "description": "%3Ch2%3EOverview%3C%2Fh2%3E%3Cp%3ETop%20users%20of%20our%20website.%3C%2Fp%3E\n",
          "adminUsers": [],
          "ownerGroups": [],
          "isEditable": true,
          "sourceUpdatedAt": 0,
          "announcementUpdatedAt": 0,
          "name": "INSTACART_TOP_USERS Readme",
          "certificateUpdatedAt": 0,
          "isGlobal": false,
          "isDiscoverable": true,
          "viewerGroups": [],
          "ownerUsers": []
        },
        "guid": "f25aec9b-790f-4760-b66c-997eee2fe613",
        "status": "ACTIVE",
        "displayText": "INSTACART_TOP_USERS Readme",
        "classificationNames": [],
        "classifications": [],
        "meaningNames": [],
        "meanings": [],
        "isIncomplete": false,
        "labels": [],
        "createdBy": "service-account-apikey-e8d1f0bd-600e-4a8a-9248-b7c9aa1ef8c3",
        "updatedBy": "service-account-apikey-e8d1f0bd-600e-4a8a-9248-b7c9aa1ef8c3",
        "createTime": 1655460145909,
        "updateTime": 1655460145909
      }
    ],
    "UPDATE": [
      {
        "typeName": "Column",
        "attributes": {
          "qualifiedName": "default/snowflake/1655116256/ATLAN_SAMPLE_DATA/FOOD_BEVERAGE/INSTACART_TOP_USERS/user_id",
          "name": "user_id",
          "description": "Unique identifier of the user"
        },
        "guid": "2e5b4bdb-592d-4964-afbe-021214b0cc9f",
        "status": "ACTIVE",
        "displayText": "user_id",
        "classificationNames": [],
        "meaningNames": [],
        "meanings": [],
        "isIncomplete": false,
        "labels": [],
        "createdBy": "service-account-apikey-e8d1f0bd-600e-4a8a-9248-b7c9aa1ef8c3",
        "updatedBy": "service-account-apikey-e8d1f0bd-600e-4a8a-9248-b7c9aa1ef8c3",
        "createTime": 1655116523261,
        "updateTime": 1655460145909
      },
      {
        "typeName": "Table",
        "attributes": {
          "qualifiedName\"": "default/snowflake/1655116256/ATLAN_SAMPLE_DATA/FOOD_BEVERAGE/INSTACART_TOP_USERS",
          "name\"": "INSTACART_TOP_USERS",
          "description\"": "Top users across categories"
        },
        "guid": "c1ef6535-4c9d-4946-83a3-9f70d7a98e47",
        "status": "ACTIVE",
        "displayText": "INSTACART_TOP_USERS",
        "classificationNames": [],
        "meaningNames": [],
        "meanings": [],
        "isIncomplete": false,
        "labels": [],
        "createdBy": "service-account-apikey-e8d1f0bd-600e-4a8a-9248-b7c9aa1ef8c3",
        "updatedBy": "service-account-apikey-e8d1f0bd-600e-4a8a-9248-b7c9aa1ef8c3",
        "createTime": 1655116491284,
        "updateTime": 1655460145909
      }
    ],
    "guidAssignments": {
      "-786722728348341": "2992ae78-c480-48b9-b61a-67cce210e3d7",
      "-786722728348342": "f25aec9b-790f-4760-b66c-997eee2fe613"
    }
  }
}

Change description

POST /api/meta/entity/bulk#changeDescription

Change an asset's description.

There are two fields in Atlan that capture the description of an asset: description and userDescription.

In the UI, userDescription will take precedence. This is the field that is updated when a user updates the description through the UI.

When a system updates a description, it will populate the description field. This field is only shown in the UI when the userDescription field is empty.

So, if you want to only override the fallback system-defined description, update the description field. If you want to override the users' own descriptions, then update the userDescription field.

To remove either (or both) descriptions, set them to null.

Note that the update relies on a match being found for the provided qualifiedNames. If the qualifiedNames do not match any existing asset, those assets will instead be created with the provided properties and values, rather than updating an existing asset by changing its properties. Also be aware that the qualifiedName is case-sensitive.

For more details on the semantics and other attributes available through this interface, see the Upsert entities operation.

Body Required

List of assets and the descriptions to set on them.

entities array[object] Required

Instance of an asset in Atlan, with its detailed information.
- typeName string Required
  
  Name of the type definition that defines this instance.
- attributes object | null Required
  
  Attributes that can exist across all assets in Atlan.
  qualifiedName string Required
  
  Unique name for this asset. This is typically a concatenation of the asset's name onto its parent's qualifiedName.
  
  name string Required
  
  Human-readable name of the asset.
  
  displayName string | null
  
  Name used for display purposes (in user interfaces).
  
  description string | null
  
  Description of the asset, as crawled from a source.
  
  userDescription string | null
  
  Description of the asset, as provided by a user. If present, this will be used for the description in user interfaces. If not present, the description will be used.
  
  tenantId string
  
  Name of the Atlan workspace in which the table exists.
  
  certificateStatus string | null
  
  Status of the asset's certification.
  
  Values are VERIFIED, DRAFT, or DEPRECATED.
  
  certificateStatusMessage string | null
  
  Human-readable descriptive message that can optionally be submitted when the certificateStatus is changed.
  
  announcementTitle string | null
  
  Brief title for the announcement on this asset. Required when announcementType is specified.
  
  announcementMessage string | null
  
  Detailed message to include in the announcement on this asset.
  
  announcementType string | null
  
  Type of announcement on the asset.
  
  Values are information, warning, or issue.
  
  ownerUsers array[string] | null
  
  List of users who own the asset.
  
  ownerGroups array[string] | null
  
  List of groups who own the asset.
  
  adminUsers array[string] | null
  
  List of users who administer the asset. (This is only used for Connection assets?)
  
  adminGroups array[string] | null
  
  List of groups who administer the asset. (This is only used for Connection assets?)
  
  viewerUsers array[string] | null
  
  viewerGroups array[string] | null
  
  connectorName string | null
  
  Name of the connector through which this asset is accessible.
  
  connectionName string | null Deprecated
  
  Unused.
  
  connectionQualifiedName string | null
  
  Unique name of the connection through which this asset is accessible.
  
  isDiscoverable boolean
  
  isEditable boolean
  
  subType object | null
  
  viewScore number | null
  
  popularityScore number | null
  
  sourceOwners array[string] | null
  
  sourceURL string | null
  
  lastSyncWorkflowName string | null
  
  Name of the crawler that last synchronized this asset.
  
  lastSyncRunAt integer | null
  
  Time (epoch) at which the table was last crawled, in milliseconds.
  
  lastSyncRun string | null
  
  Name of the last run of the crawler that last synchronized this asset.
- classifications array[object] | null
  
  Instance of a classification in Atlan.
  typeName string
  
  Name of the classification. Note that this is the static-hashed unique name of the classification, not the human-readable displayName.
  
  entityGuid string
  
  Unique identifier of the entity to which this classification is attached.
  
  propagate boolean | null
  
  Whether to propagate this classification to other entities related to the entity to which the classification is attached.
  
  removePropagationsOnEntityDelete boolean | null
  
  Whether to remove this classification from other entities to which it has been propagated when the classification is removed from this entity.
- displayText string | null
  
  Human-readable name of the entity.
- guid string
  
  Unique identifier of the entity instance.
- isIncomplete boolean | null
  
  Default value is false.
- businessAttributes object | null
  
  Map of custom metadata attributes and values defined on the entity.
- relationshipAttributes object | null
  
  Map of the relationships to this asset.
  links array[object]
  
  Details to use within an asset when referring to a link (resource).
  
  typeName string
  
  Should always be Link.
  
  guid string | null
  
  Unique identifier of the related link. If the uniqueAttributes are not provided, this must be provided.
  
  uniqueAttributes object | null
  
  Attribute(s) that uniquely identify the related link. If the guid is not provided, these must be provided.
  
  qualifiedName string
  
  Unique name of the related link. Note that this is a generated unique name which is not visible in the UI.
  
  readme object
  
  Details to use within an asset when referring to a readme.
  
  typeName string
  
  Should always be Readme.
  
  guid string | null
  
  Unique identifier of the related readme. If the uniqueAttributes are not provided, this must be provided.
  
  uniqueAttributes object | null
  
  Attribute(s) that uniquely identify the related readme. If the guid is not provided, these must be provided.
  
  qualifiedName string
  
  Unique name of the related readme.
  
  meanings array[object]
  
  Details to use within an asset when referring to a term.
  
  typeName string
  
  Should always be AtlasnGlossaryTerm.
  
  guid string | null
  
  Unique identifier of the related term. If the uniqueAttributes are not provided, this must be provided.
  
  uniqueAttributes object | null
  
  Attribute(s) that uniquely identify the related term. If the guid is not provided, these must be provided.
  
  qualifiedName string
  
  Unique name of the related term. Note that in Atlan this unique name is a hashed value, not the name you see in the UI.

Responses

• 200 object

Asset descriptions were successfully added or updated.
- mutatedEntities object | null
  
  Assets that were changed.
  CREATE array[object]
  
  Instance of an asset in Atlan, with its detailed information.
  
  entity object
  
  Instance of an entity in Atlan, with its detailed information.
  
  typeName string
  
  Name of the type definition that defines this instance.
  
  attributes object | null
  
  Will be further documented in sub-types of EntityHeader.
  
  classifications array[object] | null
  
  Instance of a classification in Atlan, with its detailed information.
  
  typeName string
  
  Name of the classification. Note that this is the static-hashed unique name of the classification, not the human-readable displayName.
  
  entityGuid string
  
  Unique identifier of the entity to which this classification is attached.
  
  propagate boolean | null
  
  Whether to propagate this classification to other entities related to the entity to which the classification is attached.
  
  removePropagationsOnEntityDelete boolean | null
  
  Whether to remove this classification from other entities to which it has been propagated when the classification is removed from this entity.
  
  entityStatus string | null
  
  Status of the entity to which this classification is attached.
  
  Values are ACTIVE or DELETED.
  
  displayText string | null
  
  Human-readable name of the entity.
  
  guid string
  
  Unique identifier of the entity instance.
  
  isIncomplete boolean | null
  
  Default value is false.
  
  businessAttributes object | null
  
  Map of custom metadata attributes and values defined on the entity.
  
  relationshipAttributes object
  
  Map of relationships for the entity. The specific keys of this map will vary by type, so are described in the sub-types of this schema.
  
  createdBy string | null
  
  Username of the user who created the object.
  
  updatedBy string | null
  
  Username of the user who last updated the object.
  
  createTime integer | null
  
  Time (epoch) at which this object was created, in milliseconds.
  
  updateTime integer | null
  
  Time (epoch) at which this object was last updated, in milliseconds.
  
  version integer | null
  
  Version of this object.
  
  classificationNames array[string] | null
  
  List of classifications for this entity. Note that these are the internal hashed names used in Atlan, not the displayText of the classification.
  
  labels array[string] | null
  
  Internal use only.
  
  status string
  
  Status of the entity, either ACTIVE or DELETED.
  
  Values are ACTIVE or DELETED.
  
  customAttributes object | null
  
  Internal use only.
  
  Additional properties: string
  
  pendingTasks array[string] | null
  
  Internal use only.
  
  referredEntities object
  
  Map of related entities keyed by the GUID of the related entity. The values will be the detailed entity object of the related entity.
  
  typeName string
  
  Name of the type definition that defines this instance.
  
  attributes object | null
  
  Attributes that can exist across all assets in Atlan.
  
  qualifiedName string
  
  Unique name for this asset. This is typically a concatenation of the asset's name onto its parent's qualifiedName.
  
  name string
  
  Human-readable name of the asset.
  
  displayName string | null
  
  Name used for display purposes (in user interfaces).
  
  description string | null
  
  Description of the asset, as crawled from a source.
  
  userDescription string | null
  
  Description of the asset, as provided by a user. If present, this will be used for the description in user interfaces. If not present, the description will be used.
  
  tenantId string
  
  Name of the Atlan workspace in which the table exists.
  
  certificateStatus string | null
  
  Status of the asset's certification.
  
  Values are VERIFIED, DRAFT, or DEPRECATED.
  
  certificateStatusMessage string | null
  
  Human-readable descriptive message that can optionally be submitted when the certificateStatus is changed.
  
  announcementTitle string | null
  
  Brief title for the announcement on this asset. Required when announcementType is specified.
  
  announcementMessage string | null
  
  Detailed message to include in the announcement on this asset.
  
  announcementType string | null
  
  Type of announcement on the asset.
  
  Values are information, warning, or issue.
  
  ownerUsers array[string] | null
  
  List of users who own the asset.
  
  ownerGroups array[string] | null
  
  List of groups who own the asset.
  
  adminUsers array[string] | null
  
  List of users who administer the asset. (This is only used for Connection assets?)
  
  adminGroups array[string] | null
  
  List of groups who administer the asset. (This is only used for Connection assets?)
  
  viewerUsers array[string] | null
  
  viewerGroups array[string] | null
  
  connectorName string | null
  
  Name of the connector through which this asset is accessible.
  
  connectionName string | null Deprecated
  
  Unused.
  
  connectionQualifiedName string | null
  
  Unique name of the connection through which this asset is accessible.
  
  isDiscoverable boolean
  
  isEditable boolean
  
  subType object | null
  
  viewScore number | null
  
  popularityScore number | null
  
  sourceOwners array[string] | null
  
  sourceURL string | null
  
  lastSyncWorkflowName string | null
  
  Name of the crawler that last synchronized this asset.
  
  lastSyncRunAt integer | null
  
  Time (epoch) at which the table was last crawled, in milliseconds.
  
  lastSyncRun string | null
  
  Name of the last run of the crawler that last synchronized this asset.
  
  certificateUpdatedBy string | null
  
  Name of the user who last updated the certificateStatus.
  
  certificateUpdatedAt integer | null
  
  Time (epoch) at which the certificateStatus was last updated, in milliseconds.
  
  announcementUpdatedAt integer | null
  
  Time (epoch) at which the announcement was last updated, in milliseconds.
  
  announcementUpdatedBy string | null
  
  User who last updated the announcement.
  
  sourceCreatedBy string | null
  
  sourceCreatedAt integer | null
  
  sourceUpdatedAt integer | null
  
  sourceUpdatedBy string | null
  
  classifications array[object] | null
  
  Instance of a classification in Atlan.
  
  typeName string
  
  Name of the classification. Note that this is the static-hashed unique name of the classification, not the human-readable displayName.
  
  entityGuid string
  
  Unique identifier of the entity to which this classification is attached.
  
  propagate boolean | null
  
  Whether to propagate this classification to other entities related to the entity to which the classification is attached.
  
  removePropagationsOnEntityDelete boolean | null
  
  Whether to remove this classification from other entities to which it has been propagated when the classification is removed from this entity.
  
  displayText string | null
  
  Human-readable name of the entity.
  
  guid string
  
  Unique identifier of the entity instance.
  
  isIncomplete boolean | null
  
  Default value is false.
  
  businessAttributes object | null
  
  Map of custom metadata attributes and values defined on the entity.
  
  relationshipAttributes object | null
  
  Map of the relationships to this asset.
  
  links array[object]
  
  Details to use within an asset when referring to a link (resource).
  
  typeName string
  
  Should always be Link.
  
  guid string | null
  
  Unique identifier of the related link. If the uniqueAttributes are not provided, this must be provided.
  
  uniqueAttributes object | null
  
  Attribute(s) that uniquely identify the related link. If the guid is not provided, these must be provided.
  
  qualifiedName string
  
  Unique name of the related link. Note that this is a generated unique name which is not visible in the UI.
  
  readme object
  
  Details to use within an asset when referring to a readme.
  
  typeName string
  
  Should always be Readme.
  
  guid string | null
  
  Unique identifier of the related readme. If the uniqueAttributes are not provided, this must be provided.
  
  uniqueAttributes object | null
  
  Attribute(s) that uniquely identify the related readme. If the guid is not provided, these must be provided.
  
  qualifiedName string
  
  Unique name of the related readme.
  
  meanings array[object]
  
  Details to use within an asset when referring to a term.
  
  typeName string
  
  Should always be AtlasnGlossaryTerm.
  
  guid string | null
  
  Unique identifier of the related term. If the uniqueAttributes are not provided, this must be provided.
  
  uniqueAttributes object | null
  
  Attribute(s) that uniquely identify the related term. If the guid is not provided, these must be provided.
  
  qualifiedName string
  
  Unique name of the related term. Note that in Atlan this unique name is a hashed value, not the name you see in the UI.
  
  UPDATE array[object]
  
  Instance of an asset in Atlan, with its detailed information.
  
  entity object
  
  Instance of an entity in Atlan, with its detailed information.
  
  typeName string
  
  Name of the type definition that defines this instance.
  
  attributes object | null
  
  Will be further documented in sub-types of EntityHeader.
  
  classifications array[object] | null
  
  Instance of a classification in Atlan, with its detailed information.
  
  typeName string
  
  Name of the classification. Note that this is the static-hashed unique name of the classification, not the human-readable displayName.
  
  entityGuid string
  
  Unique identifier of the entity to which this classification is attached.
  
  propagate boolean | null
  
  Whether to propagate this classification to other entities related to the entity to which the classification is attached.
  
  removePropagationsOnEntityDelete boolean | null
  
  Whether to remove this classification from other entities to which it has been propagated when the classification is removed from this entity.
  
  entityStatus string | null
  
  Status of the entity to which this classification is attached.
  
  Values are ACTIVE or DELETED.
  
  displayText string | null
  
  Human-readable name of the entity.
  
  guid string
  
  Unique identifier of the entity instance.
  
  isIncomplete boolean | null
  
  Default value is false.
  
  businessAttributes object | null
  
  Map of custom metadata attributes and values defined on the entity.
  
  relationshipAttributes object
  
  Map of relationships for the entity. The specific keys of this map will vary by type, so are described in the sub-types of this schema.
  
  createdBy string | null
  
  Username of the user who created the object.
  
  updatedBy string | null
  
  Username of the user who last updated the object.
  
  createTime integer | null
  
  Time (epoch) at which this object was created, in milliseconds.
  
  updateTime integer | null
  
  Time (epoch) at which this object was last updated, in milliseconds.
  
  version integer | null
  
  Version of this object.
  
  classificationNames array[string] | null
  
  List of classifications for this entity. Note that these are the internal hashed names used in Atlan, not the displayText of the classification.
  
  labels array[string] | null
  
  Internal use only.
  
  status string
  
  Status of the entity, either ACTIVE or DELETED.
  
  Values are ACTIVE or DELETED.
  
  customAttributes object | null
  
  Internal use only.
  
  Additional properties: string
  
  pendingTasks array[string] | null
  
  Internal use only.
  
  referredEntities object
  
  Map of related entities keyed by the GUID of the related entity. The values will be the detailed entity object of the related entity.
  
  typeName string
  
  Name of the type definition that defines this instance.
  
  attributes object | null
  
  Attributes that can exist across all assets in Atlan.
  
  qualifiedName string
  
  Unique name for this asset. This is typically a concatenation of the asset's name onto its parent's qualifiedName.
  
  name string
  
  Human-readable name of the asset.
  
  displayName string | null
  
  Name used for display purposes (in user interfaces).
  
  description string | null
  
  Description of the asset, as crawled from a source.
  
  userDescription string | null
  
  Description of the asset, as provided by a user. If present, this will be used for the description in user interfaces. If not present, the description will be used.
  
  tenantId string
  
  Name of the Atlan workspace in which the table exists.
  
  certificateStatus string | null
  
  Status of the asset's certification.
  
  Values are VERIFIED, DRAFT, or DEPRECATED.
  
  certificateStatusMessage string | null
  
  Human-readable descriptive message that can optionally be submitted when the certificateStatus is changed.
  
  announcementTitle string | null
  
  Brief title for the announcement on this asset. Required when announcementType is specified.
  
  announcementMessage string | null
  
  Detailed message to include in the announcement on this asset.
  
  announcementType string | null
  
  Type of announcement on the asset.
  
  Values are information, warning, or issue.
  
  ownerUsers array[string] | null
  
  List of users who own the asset.
  
  ownerGroups array[string] | null
  
  List of groups who own the asset.
  
  adminUsers array[string] | null
  
  List of users who administer the asset. (This is only used for Connection assets?)
  
  adminGroups array[string] | null
  
  List of groups who administer the asset. (This is only used for Connection assets?)
  
  viewerUsers array[string] | null
  
  viewerGroups array[string] | null
  
  connectorName string | null
  
  Name of the connector through which this asset is accessible.
  
  connectionName string | null Deprecated
  
  Unused.
  
  connectionQualifiedName string | null
  
  Unique name of the connection through which this asset is accessible.
  
  isDiscoverable boolean
  
  isEditable boolean
  
  subType object | null
  
  viewScore number | null
  
  popularityScore number | null
  
  sourceOwners array[string] | null
  
  sourceURL string | null
  
  lastSyncWorkflowName string | null
  
  Name of the crawler that last synchronized this asset.
  
  lastSyncRunAt integer | null
  
  Time (epoch) at which the table was last crawled, in milliseconds.
  
  lastSyncRun string | null
  
  Name of the last run of the crawler that last synchronized this asset.
  
  certificateUpdatedBy string | null
  
  Name of the user who last updated the certificateStatus.
  
  certificateUpdatedAt integer | null
  
  Time (epoch) at which the certificateStatus was last updated, in milliseconds.
  
  announcementUpdatedAt integer | null
  
  Time (epoch) at which the announcement was last updated, in milliseconds.

Atlan API 2.0.0

Body Required

Body Required

Body Required

Body Required

Body Required

Body Required

Body Required

Body Required

Body Required

Body Required

Atlan API
2.0.0