Tag (classify) assets¶

Atlan tags must exist before tagging assets

Remember that you must first create the Atlan tag before you will be able to tag any assets.

Cannot add tags when creating assets

Currently it is not possible to add tags when creating assets, other than via dbt.

Add to an existing asset¶

To add tags to an existing asset:

Add tags to an existing asset
models:
  - name: TOP_BEVERAGE_USERS # You must of course give the name of the object.

    meta:
      atlan:
        classificationNames: # The simplest way to tag an asset, using the default values for propagation (those shown below), is to use the meta.atlan.classificationNames structure.

          - PII # When using this simplified form, you can give the normal human-readable name of the tags rather than the hashed-string representation.

          - Marketing Analysis
        classificationNames: # Alternatively, if you want to override the propagation settings, you can use this more detailed structure.

          - name: PII # Each listed item must itself be a YAML object consisting of the human-readable name of the tag and the propagation setting overrides:

            propagate: true # (Optional) You can decide whether to propagate this tag (true) or not (false). If you choose false, no propagation of this tag from the asset will occur — neither through lineage nor parent-child relationships.

            removePropagationsOnEntityDelete: true # (Optional) If propagation is allowed, you can then define whether propagated tags should be removed if this asset is deleted (true) or not (false).

            restrictPropagationThroughLineage: false # (Optional) If propagation is allowed, you can also decide whether to disable propagation of the tag only for lineage (true) or still allow it through lineage (false).

            restrictPropagationThroughHierarchy: false # (Optional) If propagation is allowed, you can also decide whether to disable propagation of the tag only for hierarchy (true) or still allow it through hierarchy (false).

          - name: Marketing Analysis
            propagate: true
            removePropagationsOnEntityDelete: true
            restrictPropagationThroughLineage: false
            restrictPropagationThroughHierarchy: false
        classifications: # Alternatively, you can specify tags nested within the meta.atlan.classifications structure.

          - typeName: yQBDoKHdTLJhqAsdR3RMq6 # In this structure, each tag you want to add must be given using its hashed-string representation. Its propagation settings can be overridden using the same options described above.

            propagate: true
            removePropagationsOnEntityDelete: true
            restrictPropagationThroughLineage: false
            restrictPropagationThroughHierarchy: false
          - typeName: WCVjmgKnW40G151dESXZ03
            propagate: true
            removePropagationsOnEntityDelete: true
            restrictPropagationThroughLineage: false
            restrictPropagationThroughHierarchy: false

Replaces all tags

Unlike the examples for the SDKs and raw APIs, dbt will always replace all tags on the asset. Any tags that already exist on the asset that are not specified here will be removed.

Add tags to an existing asset
Table.appendAtlanTags( // 
    client, // 
    "default/snowflake/1657037873/SAMPLE_DB/FOOD_BEV/TOP_BEVERAGE_USERS", // The qualifiedName of the asset.

    List.of("PII", "Marketing Analysis")); // A list of the tags (the names as you set them up in the UI) to add to the asset.

Add tags to an existing asset
from pyatlan.client.atlan import AtlanClient
from pyatlan.model.assets import Table

client = AtlanClient()
client.asset.add_atlan_tags( # Use the asset.add_atlan_tags() method, which for most objects requires a minimal set of information. This helper method will construct the necessary request and call the necessary API(s) to add the tags all-in-one.

    asset_type=Table,
    qualified_name="default/snowflake/1657037873/SAMPLE_DB/FOOD_BEV/TOP_BEVERAGE_USERS",
    atlan_tag_names=["PII", "Marketing Analysis"], # A list of the tags (the names as you set them up in the UI) to add to the asset.

)

Add tags to an existing asset
val table = Table.appendAtlanTags(  // Use the appendAtlanTags() helper method, which for most objects requires a minimal set of information. This helper method will construct the necessary request and call the necessary API(s) to add the tags all-in-one.

    client, // Because this operation will directly change the asset in Atlan, you must provide it an AtlanClient through which to connect to the tenant.

    "default/snowflake/1657037873/SAMPLE_DB/FOOD_BEV/TOP_BEVERAGE_USERS",  // The qualifiedName of the asset.

    listOf("PII", "Marketing Analysis"))  // A list of the tags (the names as you set them up in the UI) to add to the asset.

POST /api/meta/entity/uniqueAttribute/type/Table/classifications?attr:qualifiedName=default%2Fsnowflake%2F1657037873%2FSAMPLE_DB%2FFOOD_BEV%2FTOP_BEVERAGE_USERS
[
  {
    "typeName": "yQBDoKHdTLJhqAsdR3RMq6", // Each tag you want to add must be given using its hashed-string representation.

    "propagate": true, // (Optional) You can decide whether to propagate this tag (true) or not (false). If you choose false, no propagation of this tag from the asset will occur — neither through lineage nor parent-child relationships.

    "removePropagationsOnEntityDelete": true, // (Optional) If propagation is allowed, you can then define whether propagated tags should be removed if this asset is deleted (true) or not (false).

    "restrictPropagationThroughLineage": false, // (Optional) If propagation is allowed, you can also decide whether to disable propagation of the tag only for lineage (true) or still allow it through lineage (false).

    "restrictPropagationThroughHierarchy": false // (Optional) If propagation is allowed, you can also decide whether to disable propagation of the tag only for hierarchy (true) or still allow it through hierarchy (false).

  },
  {
    "typeName": "WCVjmgKnW40G151dESXZ03",
    "propagate": true,
    "removePropagationsOnEntityDelete": true,
    "restrictPropagationThroughLineage": false,
    "restrictPropagationThroughHierarchy": false
  }
]

Update on an existing asset¶

1.6.4 4.0.0

To update tags on an existing asset:

dbt Java Python Kotlin Raw REST API

Not possible through dbt

In dbt, the tags will be replaced in their entirety. It is not possible to just update a single tag through dbt.

Update tags on an existing asset
Table.updateAtlanTags( // Use the updateAtlanTags() helper method, which for most objects requires a minimal set of information. This helper method will construct the necessary request and call the necessary API(s) to update tags for an asset, all-in-one.

    client, // Because this operation will directly change the asset in Atlan, you must provide it an AtlanClient through which to connect to the tenant.

    "default/snowflake/1657037873/SAMPLE_DB/FOOD_BEV/TOP_BEVERAGE_USERS", // The qualifiedName of the asset.

    List.of("PII", "Marketing Analysis"), // A list of the tags (the names as you set them up in the UI) to update for the asset.

    true, // (Optional) You can decide whether to propagate these tags (true) or not (false). If you choose false, no propagation for these tags from the asset will occur — neither through lineage nor parent-child relationships.

    true, // (Optional) If propagation is allowed, you can then define whether propagated tags should be removed if this asset is deleted (true) or not (false).

    false, // (Optional) If propagation is allowed, you can also decide whether to disable propagation of the tags only for lineage (true) or still allow it through lineage (false).

    false // (Optional) If propagation is allowed, you can also decide whether to disable propagation of the tag only for hierarchy (true) or still allow it through hierarchy (false).

);

Update tags on an existing asset
from pyatlan.client.atlan import AtlanClient
from pyatlan.model.assets import Table

client = AtlanClient()
client.asset.update_atlan_tags( # Use the asset.update_atlan_tags() method, which for most objects requires a minimal set of information. This helper method will construct the necessary request and call the necessary API(s) to update tags for an asset, all-in-one.

    asset_type=Table,
    qualified_name="default/snowflake/1657037873/SAMPLE_DB/FOOD_BEV/TOP_BEVERAGE_USERS",
    atlan_tag_names=["PII", "Marketing Analysis"], # A list of the tags (the names as you set them up in the UI) to update for the asset.

    True, # (Optional) You can decide whether to propagate these tags (True) or not (False). If you choose False, no propagation for these tags from the asset will occur — neither through lineage nor parent-child relationships.

    True, # (Optional) If propagation is allowed, you can then define whether propagated tags should be removed if this asset is deleted (True) or not (False).

    False, # (Optional) If propagation is allowed, you can also decide whether to disable propagation of the tags only for lineage (True) or still allow it through lineage (False).

    False, # (Optional) If propagation is allowed, you can also decide whether to disable propagation of the tag only for hierarchy (True) or still allow it through hierarchy (False).

)

Update tags on an existing asset
val table = Table.updateAtlanTags(  // Use the updateAtlanTags() helper method, which for most objects requires a minimal set of information. This helper method will construct the necessary request and call the necessary API(s) to update tags for an asset, all-in-one.

    client, // Because this operation will directly change the asset in Atlan, you must provide it an AtlanClient through which to connect to the tenant.

    "default/snowflake/1657037873/SAMPLE_DB/FOOD_BEV/TOP_BEVERAGE_USERS",  // The qualifiedName of the asset.

    listOf("PII", "Marketing Analysis"), // A list of the tags (the names as you set them up in the UI) to update for the asset.

    true, // (Optional) You can decide whether to propagate these tags (true) or not (false). If you choose false, no propagation for these tags from the asset will occur — neither through lineage nor parent-child relationships.

    true, // (Optional) If propagation is allowed, you can then define whether propagated tags should be removed if this asset is deleted (true) or not (false).

    false, // (Optional) If propagation is allowed, you can also decide whether to disable propagation of the tags only for lineage (true) or still allow it through lineage (false).

    false // (Optional) If propagation is allowed, you can also decide whether to disable propagation of the tag only for hierarchy (true) or still allow it through hierarchy (false).

)

PUT /api/meta/entity/uniqueAttribute/type/Table/classifications?attr:qualifiedName=default%2Fsnowflake%2F1657037873%2FSAMPLE_DB%2FFOOD_BEV%2FTOP_BEVERAGE_USERS
[
  {
    "typeName": "yQBDoKHdTLJhqAsdR3RMq6", // Each tag you want to update must be given using its hashed-string representation.

    "propagate": true, // (Optional) You can decide whether to propagate these tags (true) or not (false). If you choose false, no propagation for these tags from the asset will occur — neither through lineage nor parent-child relationships.

    "removePropagationsOnEntityDelete": true, // (Optional) If propagation is allowed, you can then define whether propagated tags should be removed if this asset is deleted (true) or not (false).

    "restrictPropagationThroughLineage": false, // (Optional) If propagation is allowed, you can also decide whether to disable propagation of the tags only for lineage (true) or still allow it through lineage (false).

    "restrictPropagationThroughHierarchy": false // (Optional) If propagation is allowed, you can also decide whether to disable propagation of the tag only for hierarchy (true) or still allow it through hierarchy (false).

  },
  {
    "typeName": "WCVjmgKnW40G151dESXZ03",
    "propagate": true,
    "removePropagationsOnEntityDelete": true,
    "restrictPropagationThroughLineage": false,
    "restrictPropagationThroughHierarchy": false
  }
]

Remove from existing assets¶

Remove a single tag¶

1.4.0 4.0.0

To remove a single tag from an existing asset:

dbt Java Python Kotlin Raw REST API

Remove one tag from an existing asset

models:
  - name: TOP_BEVERAGE_USERS # You must of course give the name of the object.

    meta:
      atlan:
        classificationNames: # You can use the meta.atlan.classificationNames structure, as above.

          - PII # 
When using this simplified form, you can give the normal human-readable name of the tags you want to remain, rather than the hashed-string representation.

The tag being removed is no longer present
You are removing the tag by not specifying it anymore here in dbt.


        classifications: # 
The tags must be nested within the meta.atlan.classifications structure.

          - typeName: yQBDoKHdTLJhqAsdR3RMq6 # 
Each tag you want to remain must be given using its hashed-string representation.

The tag being removed is no longer present
You are removing the tag by not specifying it anymore here in dbt.


            propagate: true
            removePropagationsOnEntityDelete: true
            restrictPropagationThroughLineage: false
            restrictPropagationThroughHierarchy: false

Remove one tag from an existing asset
Table.removeAtlanTag( // Use the removeAtlanTag() helper method, which for most objects requires a minimal set of information. This helper method will construct the necessary request and call the necessary API(s) to remove a tag from an asset, all-in-one.

    client, // Because this operation will directly change the asset in Atlan, you must provide it an AtlanClient through which to connect to the tenant.

    "default/snowflake/1657037873/SAMPLE_DB/FOOD_BEV/TOP_BEVERAGE_USERS", // The qualifiedName of the asset.

    "Marketing Analysis"); // The tag (the name you set up in the UI) to remove from the asset.

Remove one tag from an existing asset
from pyatlan.client.atlan import AtlanClient
from pyatlan.model.assets import Table

client = AtlanClient()
client.asset.remove_atlan_tag(  # Use the asset.remove_atlan_tag() method, which for most objects requires a minimal set of information. This method will construct the necessary request and call the necessary API(s) to remove a tag from an asset, all-in-one.

    asset_type=Table,
    qualified_name="default/snowflake/1657037873/SAMPLE_DB/FOOD_BEV/TOP_BEVERAGE_USERS",
    atlan_tag_name="Marketing Analysis",  # The tag (the name you set up in the UI) to remove from the asset.

)

Remove one tag from an existing asset
Table.removeAtlanTag(  // Use the removeAtlanTag() helper method, which for most objects requires a minimal set of information. This helper method will construct the necessary request and call the necessary API(s) to remove a tag from an asset, all-in-one.

    client, // Because this operation will directly change the asset in Atlan, you must provide it an AtlanClient through which to connect to the tenant.

    "default/snowflake/1657037873/SAMPLE_DB/FOOD_BEV/TOP_BEVERAGE_USERS",  // The qualifiedName of the asset.

    "Marketing Analysis")  // The tag (the name you set up in the UI) to remove from the asset.

DELETE /api/meta/entity/uniqueAttribute/type/Table/classification/WCVjmgKnW40G151dESXZ03?attr:qualifiedName=default%2Fsnowflake%2F1657037873%2FSAMPLE_DB%2FFOOD_BEV%2FTOP_BEVERAGE_USERS

// Note that all of the details for the deletion are embedded in the URL or query parameters to the request. Once again the hashed-string representation of the tag is required. You would either need to first retrieve the list of tags via API to determine this value, or look through the development console of your browser while opening the tag in the Atlan UI.

Remove all tags¶

Could create a new asset

Remember that Atlan matches the provided qualifiedName to determine whether to update or create the asset.

2.0.0 4.0.0

To remove all tags from an existing asset, you need to specify no tags in your object:

dbt Java Python Kotlin Raw REST API

Remove all tags from an existing asset
models:
  - name: TOP_BEVERAGE_USERS # You must of course give the name of the object.

    meta:
      atlan:
        classifications: [] # The tags must be nested within the meta.atlan.classifications structure. To remove all of them, send an explicit empty list.

Remove all tags from an existing asset
Table table = Table.updater( // Use the updater() method to initialize the object with all necessary attributes for updating it(../advanced-examples/update.md#build-minimal-object-needed). (Removing the tags is still an update to the asset, we are not deleting the asset itself.)

    "default/snowflake/1657037873/SAMPLE_DB/FOOD_BEV/TOP_BEVERAGE_USERS",
    "TOP_BEVERAGE_USERS").build();
AssetMutationResponse response = table.save(client, true); // Call the save() method to actually update the asset, using true as the second argument to overwrite tags. Since we have not provided any tags in our object, this will replace the existing tags on the asset with no tags. (In other words, it will remove all tags from the asset.) Because this operation will persist the asset in Atlan, you must provide it an AtlanClient through which to connect to the tenant.

assert response.getUpdatedAssets().size() == 1; // The response will include that single asset that was updated (again, removing tags is an update to the asset — we are not deleting the asset itself).

Remove all tags from an existing asset
from pyatlan.client.atlan import AtlanClient
from pyatlan.model.assets import Table

client = AtlanClient()
table = Table.updater( # Use the updater() method to create an asset suitable for modifiaction i.e. with all the requisite attributes.

    qualified_name="default/snowflake/1657037873/SAMPLE_DB/FOOD_BEV/TOP_BEVERAGE_USERS",
    name="TOP_BEVERAGE_USERS",
)
response = client.asset.save(table, replace_atlan_tags=True) #  Call the save() method to actually update the asset, using True for the replace_atlan_tags argument will cause the tags to be overwritten. Since we have not provided any tags in our object,  this will replace the existing tags on the asset with no tags. (In other words, it will remove all tags from the asset.)

assert 1 == len(response.assets_updated(asset_type=Table)) # The response should only include that single asset that was updated (again, removing tags is an update to the asset — we are not deleting the asset itself).

Remove all tags from an existing asset
val table = Table.updater(  // Use the updater() method to initialize the object with all necessary attributes for updating it(../advanced-examples/update.md#build-minimal-object-needed). (Removing the tags is still an update to the asset, we are not deleting the asset itself.)

    "default/snowflake/1657037873/SAMPLE_DB/FOOD_BEV/TOP_BEVERAGE_USERS",
    "TOP_BEVERAGE_USERS").build()
val response = table.save(client, true)  // Call the save() method to actually update the asset, using true as the second argument to overwrite tags. Since we have not provided any tags in our object, this will replace the existing tags on the asset with no tags. (In other words, it will remove all tags from the asset.) Because this operation will persist the asset in Atlan, you must provide it an AtlanClient through which to connect to the tenant.

assert(response.updatedAssets.size == 1)  // The response will include that single asset that was updated (again, removing tags is an update to the asset — we are not deleting the asset itself).

POST /api/meta/entity/bulk?replaceClassifications=true&replaceBusinessAttributes=false&overwriteBusinessAttributes=false
{ // Note that the query parameter replaceClassifications is equal to true in the request. This is what causes the override behavior — so when you do not specify any tags in the request body those overwrite any existing tags on the asset. (The result being that there are then no tags on the asset.)

  "entities": [ // All assets must be wrapped in an entities array.

    {
      "typeName": "Table", // You must provide the exact type name for the asset (case-sensitive).

      "attributes": {
        "qualifiedName": "default/snowflake/1665450065/DBT_FOOD_BEVERAGE/PUBLIC/INSTACART_ORDER_PRODUCTS_USERS_TIME_MASTER", // You must provide the exact qualifiedName of the asset (case-sensitive).

        "name": "INSTACART_ORDER_PRODUCTS_USERS_TIME_MASTER" // You must provide the exact name of the asset (case-sensitive).

      }
    }
  ]
}

In bulk¶

2.5.4 4.0.0

You can modify many tags, for many assets, at the same time.

Operates as a replace

Applying tags in bulk can currently only be done as a replacement. All tags on the asset(s) you upate will be replaced with the tags you specify. This means any tags that already exist on the asset in Atlan that are not in your update will be removed from that asset.

dbt Java Python Kotlin Raw REST API

Replace tags on multiple assets
models:
  - name: TOP_BEVERAGE_USERS # You must of course give the name of the object.

    meta:
      atlan:
        classificationNames: # The simplest way to tag an asset, using the default values for propagation (those shown below), is to use the meta.atlan.classificationNames structure.

          - PII # When using this simplified form, you can give the normal human-readable name of the tags rather than the hashed-string representation.

          - Marketing Analysis
        classificationNames: # Alternatively, if you want to override the propagation settings, you can use this more detailed structure.

          - name: PII # Each listed item must itself be a YAML object consisting of the human-readable name of the tag and the propagation setting overrides:

            propagate: true # (Optional) You can decide whether to propagate this tag (true) or not (false). If you choose false, no propagation of this tag from the asset will occur — neither through lineage nor parent-child relationships.

            removePropagationsOnEntityDelete: true # (Optional) If propagation is allowed, you can then define whether propagated tags should be removed if this asset is deleted (true) or not (false).

            restrictPropagationThroughLineage: false # (Optional) If propagation is allowed, you can also decide whether to disable propagation of the tag only for lineage (true) or still allow it through lineage (false).

            restrictPropagationThroughHierarchy: false # (Optional) If propagation is allowed, you can also decide whether to disable propagation of the tag only for hierarchy (true) or still allow it through hierarchy (false).

          - name: Marketing Analysis
            propagate: true
            removePropagationsOnEntityDelete: true
            restrictPropagationThroughLineage: false
            restrictPropagationThroughHierarchy: false
        classifications: # Alternatively, you can specify tags nested within the meta.atlan.classifications structure.

          - typeName: yQBDoKHdTLJhqAsdR3RMq6 # In this structure, each tag you want to add must be given using its hashed-string representation. Its propagation settings can be overridden using the same options described above.

            propagate: true
            removePropagationsOnEntityDelete: true
            restrictPropagationThroughLineage: false
            restrictPropagationThroughHierarchy: false
          - typeName: WCVjmgKnW40G151dESXZ03
            propagate: true
            removePropagationsOnEntityDelete: true
            restrictPropagationThroughLineage: false
            restrictPropagationThroughHierarchy: false
  - name: ANOTHER_ASSET # To apply tags to multiple assets, just list all of the assets in the model file.

    meta:
      atlan:
        classificationNames:
          - ...

Replace tags on multiple assets
Table table = Table.updater( // Use the updater() helper method, which for most objects requires a minimal set of information. This helper method will construct a builder onto which you can chain any tag details. (You can also do this at creation time, using the creator() helper method, which will also return a builder.)

    "default/snowflake/1657037873/SAMPLE_DB/FOOD_BEV/TOP_BEVERAGE_USERS", "TOP_BEVERAGE_USERS")
    .atlanTag(AtlanTag.of("PII")) // You can chain simple Atlan tags using .atlanTag() and the AtlanTag.of() helper.

    .atlanTag(AtlanTag.builder() // You can chain a fully-configured Atlan tag using .atlanTag() and the AtlanTag.builder() helper to specify the exact propagation options.

        .typeName("Marketing Analysis")
        .propagate(true)
        .removePropagationsOnEntityDelete(true)
        .restrictPropagationThroughLineage(false)
        .restrictPropagationThroughHierarchy(false)
        .build())
    .atlanTag(AtlanTag.of("Sensitivity", // Or you can chain a source-synced tag using .atlanTag() and the AtlanTag.of() helper that takes a SourceTagAttachment object.

        SourceTagAttachment.byName(client, // Because creating a source tag attachment may need to look up information in Atlan, you must provide it an AtlanClient through which to connect to the tenant.

            SourceTagCache.SourceTagName("snowflake/development@@DB/SCH/SENSITIVITY"), // You can build a source tag attachment by name or qualifiedName of the source tag. To build by name, you need to specify the source tag in the format: {{connectorType}}/{{connectionName}}@@DB_NAME/SCHEMA_NAME/TAG_NAME.

            List.of(SourceTagAttachmentValue.of(null, "Restricted"))))) // You can then also specify the value(s) for that source tag, either by key (first argument to SourceTagAttachemntValue.of()) or value (second argument to SourceTagAttachmentValue.of()).

    .build();
AtlanMutationResponse response = table.save(client, true); // When you save the object, you must send true to the optional parameter to replace tags (otherwise all tags in your request will be ignored). Because this operation will persist the asset in Atlan, you must provide it an AtlanClient through which to connect to the tenant.

Replace tags on multiple assets
from pyatlan.client.atlan import AtlanClient
from pyatlan.model.assets import Table
from pyatlan.model.core import AtlanTag, AtlanTagName
from pyatlan.cache.source_tag_cache import SourceTagName
from pyatlan.model.structs import SourceTagAttachment, SourceTagAttachmentValue

client = AtlanClient()

table = Table.updater( # Use the updater() helper method, which typically requires
only a minimal set of information for most objects.

    qualified_name="default/snowflake/1657037873/SAMPLE_DB/FOOD_BEV/TOP_BEVERAGE_USERS",
    name="TOP_BEVERAGE_USERS",
)

table.atlan_tags = [ # You can assign Atlan tags directly to table.atlan_tags.

    AtlanTag.of(atlan_tag_name=AtlanTagName("PII")), 
    AtlanTag(
        type_name=AtlanTagName("Marketing Analysis"), # To create a fully-configured Atlan tag, use the AtlanTag() model,
allowing you to specify precise propagation options.

        remove_propagations_on_entity_delete=True,
        restrict_propagation_through_lineage=False,
        restrict_propagation_through_hierarchy=False,
    ),
    AtlanTag.of( # Alternatively, create a source-synced tag using the AtlanTag.of() helper,
which takes a SourceTagAttachment object.

        atlan_tag_name=AtlanTagName("Sensitivity"),
        source_tag_attachment=SourceTagAttachment.by_name(
            name=SourceTagName("snowflake/development@@DB/SCH/SENSITIVITY"), # Build a source tag attachment using either the name or qualified_name
of the source tag. To build by name, specify the source tag in this format:
{{connectorType}}/{{connectionName}}@@DB_NAME/SCHEMA_NAME/TAG_NAME.

            source_tag_values=[
                SourceTagAttachmentValue(
                    tag_attachment_key="", tag_attachment_value="Restricted"
                ) # Specify the value(s) for the source tag using either the key
(tag_attachment_key) or the value (tag_attachment_value).

            ],
        ),
    ),
]
response = client.asset.save(table, replace_atlan_tags=True) # When saving the object, include the optional parameter
replace_atlan_tags=true to replace the tags
(otherwise, all tags in the request will be ignored).

Add tags to an existing asset
val table = Table.updater( // Use the updater() helper method, which for most objects requires a minimal set of information. This helper method will construct a builder onto which you can chain any tag details. (You can also do this at creation time, using the creator() helper method, which will also return a builder.)

    "default/snowflake/1657037873/SAMPLE_DB/FOOD_BEV/TOP_BEVERAGE_USERS", "TOP_BEVERAGE_USERS")
    .atlanTag(AtlanTag.of("PII")) // You can chain simple Atlan tags using .atlanTag() and the AtlanTag.of() helper.

    .atlanTag(AtlanTag.builder() // You can chain a fully-configured Atlan tag using .atlanTag() and the AtlanTag.builder() helper to specify the exact propagation options.

        .typeName("Marketing Analysis")
        .propagate(true)
        .removePropagationsOnEntityDelete(true)
        .restrictPropagationThroughLineage(false)
        .restrictPropagationThroughHierarchy(false)
        .build())
    .atlanTag(AtlanTag.of("Sensitivity", // Or you can chain a source-synced tag using .atlanTag() and the AtlanTag.of() helper that takes a SourceTagAttachment object.

        SourceTagAttachment.byName(client, // Because creating a source tag attachment may need to look up information in Atlan, you must provide it an AtlanClient through which to connect to the tenant.

            SourceTagCache.SourceTagName("snowflake/development@@DB/SCH/SENSITIVITY"), // You can build a source tag attachment by name or qualifiedName of the source tag. To build by name, you need to specify the source tag in the format: {{connectorType}}/{{connectionName}}@@DB_NAME/SCHEMA_NAME/TAG_NAME.

            listOf(SourceTagAttachmentValue.of(null, "Restricted"))))) // You can then also specify the value(s) for that source tag, either by key (first argument to SourceTagAttachemntValue.of()) or value (second argument to SourceTagAttachmentValue.of()).

    .build()
val response = table.save(client, true) // When you save the object, you must send true to the optional parameter to replace tags (otherwise all tags in your request will be ignored). Because this operation will persist the asset in Atlan, you must provide it an AtlanClient through which to connect to the tenant.

POST /api/meta/entity/bulk
{
  "entities": [ // All assets must be wrapped in an entities array.

    {
      "typeName": "Table", // You must provide the exact type name for the asset (case-sensitive).

      "attributes": {
        "name": "TOP_BEVERAGE_USERS", // You must provide the exact name of the asset (case-sensitive).

        "qualifiedName": "default/snowflake/1657037873/SAMPLE_DB/FOOD_BEV/TOP_BEVERAGE_USERS" // You must provide the exact qualifiedName of the asset (case-sensitive).

      },
      "classifications": [ // Each tag you want to apply to the asset must be wrapped in a classifications array.

        {
          "typeName": "yQBDoKHdTLJhqAsdR3RMq6", // Each tag you want to add must be given using its hashed-string representation.

          "propagate": true, // (Optional) You can decide whether to propagate this tag (true) or not (false). If you choose false, no propagation of this tag from the asset will occur — neither through lineage nor parent-child relationships.

          "removePropagationsOnEntityDelete": true, // (Optional) If propagation is allowed, you can then define whether propagated tags should be removed if this asset is deleted (true) or not (false).

          "restrictPropagationThroughLineage": false, // (Optional) If propagation is allowed, you can also decide whether to disable propagation of the tag only for lineage (true) or still allow it through lineage (false).

          "restrictPropagationThroughHierarchy": false // (Optional) If propagation is allowed, you can also decide whether to disable propagation of the tag only for hierarchy (true) or still allow it through hierarchy (false).

        },
        {
          "typeName": "WCVjmgKnW40G151dESXZ03",
          "propagate": true,
          "removePropagationsOnEntityDelete": true,
          "restrictPropagationThroughLineage": false,
          "restrictPropagationThroughHierarchy": false
        },
        {
          "typeName": "Z96sGJrF0S68PxYTUdKG6b",
          "propagate": true,
          "removePropagationsOnEntityDelete": true,
          "restrictPropagationThroughLineage": false,
          "restrictPropagationThroughHierarchy": false,
          "attributes": { // For source tags, you must also specify an embedded attributes in the tag.

            "rt5N3mHZTcxXafuu6ZPpyL": [ // You must give the hashed-string representation of the attribute whose displayName is sourceTagAttachment.

              {
                "sourceTagName": "CONFIDENTIAL", // You must give the name of the tag in the source.

                "sourceTagQualifiedName": "default/snowflake/1726834662/ANALYTICS/WIDE_WORLD_IMPORTERS/CONFIDENTIAL", // You must give the qualifiedName of the Tag asset representing that tag in Atlan.

                "sourceTagGuid": "c28c08a8-320b-4a1a-b52e-75d120b4a8cc", // You must give the guid of the Tag asset representing that tag in Atlan.

                "sourceTagConnectorName": "snowflake", // You must give the name of the connector for the source where the tag comes from.

                "isSourceTagSynced": false,
                "sourceTagSyncTimestamp": 0,
                "sourceTagValue": [ // To specify a value for the tag, you must wrap it in a sourceTagValue array.

                  {
                    "tagAttachmentValue": "Highly Restricted" // You can then specify the value using tagAttachmentValue or its key using tagAttachmentKey.

                  }
                ]
              }
            ]
          }
        }
      ]
    }
  ]
}

Find hashed-string names¶

When using either the raw APIs or dbt, you must provide the custom metadata names using Atlan's hashed-string representation.

Not necessary for SDKs

Note that this is not needed when using the SDKs, which translate these for you!

To look up the hashed-string representations:

GET /api/meta/types/typedefs?type=classification

The response will include displayName and name for each tag. The displayName is what you see in Atlan's UI, and the name is the hashed-string representation:

Simplified response
{
  "enumDefs": [],
  "structDefs": [],
  "classificationDefs": [
    {
      "category": "CLASSIFICATION",
      "guid": "c43e2f52-975f-40b6-88fa-93697fb54f52",
      "name": "WCVjmgKnW40G151dESXZ03", // Hashed-string name for the tag named Marketing Analysis.

      "displayName": "Marketing Analysis",
      "description": "Assets relevant to the marketing domain"
    },
    {
      "category": "CLASSIFICATION",
      "guid": "ec641061-d8fa-4090-9145-a5f23c9c3e99",
      "name": "yQBDoKHdTLJhqAsdR3RMq6", // Hashed-string name for the tag named PII.

      "displayName": "PII",
      "description": "Personally-identifiable information can be used to uniquely identify an individual person."
    },
    {
      "category": "CLASSIFICATION",
      "guid": "70211696-f3fb-4a4a-a81a-db589e29f436",
      "name": "Z96sGJrF0S68PxYTUdKG6b", // Hashed-string name for the tag named Sensitivity.

      "displayName": "Sensitivity",
      "attributeDefs": [
        {
          "name": "rt5N3mHZTcxXafuu6ZPpyL", // Hashed-string name for the sourceTagAttachment attribute in the Sensitivity classification.

          "displayName": "sourceTagAttachment",
          "description": "",
          "typeName": "array<SourceTagAttachment>",
          "isDefaultValueNull": false,
          "isOptional": true,
          "cardinality": "SET",
          "valuesMinCount": 0,
          "valuesMaxCount": 2147483647,
          "isUnique": false,
          "isIndexable": false,
          "includeInNotification": false,
          "skipScrubbing": false,
          "searchWeight": -1,
          "isNew": true
        }
      ],
    }
  ],
  "entityDefs": [],
  "relationshipDefs": [],
  "businessMetadataDefs": []
}