Add asset resources / links

Resources (links) can only be added to assets after an asset exists. (The asset itself must be created first.)

Add to an existing asset

2.0.0 1.0.0

Each resource can be assigned to only a single asset. To create a resource and assign it to an asset:

dbt Java Python Kotlin Raw REST API

Managing resources for assets is currently not possible via dbt.

Table table = Table.refByQualifiedName("default/snowflake/1234567890/reln_db/reln_schema/customers"); // (1)
Link link = Link.creator( // (2)
        table, // (3)
        "Definition", // (4)
        "https://en.wikipedia.org/wiki/Customer") // (5)
    .build();
AssetMutationResponse response = link.save(); // (6)
assert response.getCreatedAssets().size() == 1 // (7)
assert response.getUpdatedAssets().size() == 1 // (8)

1. Set up a reference to the asset you want to assign the resource to from somewhere. In this example, we just create a reference based on the qualifiedName of the asset we want, but this could also be from the result of a search, for example.
2. Use the creator() method to initialize the link with all necessary attributes for creating it.
3. In the case of a link, you need to give a reference to an asset to which you want to attach the link.
4. And the title Atlan should display for the link.
5. And finally the URL for the link itself.
6. Call the save() method to actually create the link and attach it to the asset.
7. The response will include that single asset that was created (the link).
8. The response will also include a single asset that was updated (the asset to which you've attached the link).

from pyatlan.client.atlan import AtlanClient
from pyatlan.model.assets import Link, Table

client = AtlanClient()
table = Table.ref_by_qualified_name("default/snowflake/1234567890/reln_db/reln_schema/customers") # (1)
link = Link.creator( # (2)
    asset=table, # (3)
    name="Definition", # (4)
    link="https://en.wikipedia.org/wiki/Customer") # (5)
response = client.asset.save(link) # (6)
assert (links := response.assets_created(asset_type=Link)) # (7)
assert (tables := response.assets_updated(asset_type=Table)) # (8)

1. Set up a reference to the asset you want to assign the resource to from somewhere. In this example, we just create a reference based on the qualified_name of the asset we want, but this could also be from the result of a search, for example.
2. Use the create() method to build a link with all necessary attributes for creating it.
3. In the case of a link, you need to give a reference to an asset to which you want to attach the link.
4. And the title Atlan should display for the link.
5. And finally the URL for the link itself.
6. Call the save() method to actually create the link and attach it to the asset.
7. Assert that the link was created.
8. Assert a table was updated (the asset to which you've attached the link).

val table = Table.refByQualifiedName("default/snowflake/1234567890/reln_db/reln_schema/customers")  // (1)
val link = Link.creator(  // (2)
        table,  // (3)
        "Definition",  // (4)
        "https://en.wikipedia.org/wiki/Customer")  // (5)
    .build()
val response = link.save()  // (6)
assert(response.createdAssets.size == 1)  // (7)
assert(response.updatedAssets.size == 1)  // (8)

1. Set up a reference to the asset you want to assign the resource to from somewhere. In this example, we just create a reference based on the qualifiedName of the asset we want, but this could also be from the result of a search, for example.
2. Use the creator() method to initialize the link with all necessary attributes for creating it.
3. In the case of a link, you need to give a reference to an asset to which you want to attach the link.
4. And the title Atlan should display for the link.
5. And finally the URL for the link itself.
6. Call the save() method to actually create the link and attach it to the asset.
7. The response will include that single asset that was created (the link).
8. The response will also include a single asset that was updated (the asset to which you've attached the link).

Note that you are actually creating a new link asset

When adding a link through the API, you are really creating a new instance of a link asset. At the same time, you're attaching this new object to an existing asset.

{
  "entities": [ // (1)
    {
      "typeName": "Link", // (2)
      "attributes": {
        "name": "Definition", // (3)
        "qualifiedName": "540182b5-f47b-4ba1-a247-6ca9ffd9f37a", // (4)
        "link": "https://en.wikipedia.org/wiki/Customer", // (5)
        "asset": [ // (6)
          {
            "typeName": "Table",
            "uniqueAttributes": {
              "qualifiedName": "default/snowflake/1234567890/reln_db/reln_schema/customers"
            }
          }
        ]
      }
    }
  ]
}

1. All assets must be wrapped in an entities array.
2. You must provide the exact type name for the link asset, which will always be Link (case-sensitive).
3. You must also provide a name for the link. This will show up on the UI as the title of the link.
4. You must also provide a unique qualifiedName for the link. This will not show up on the UI, and must be a unique UUID (generated yourself).
5. The URL for the link should be provided in the link field.
6. Finally, you need to include the reference information for the asset the link should be attached to.

Remove from an existing asset

To remove a link from an existing asset you only need to delete the link itself. (The link is itself an asset.)

See Deleting an asset.

The link will have its own GUID, separate from the asset to which it is attached

When deleting the link, you need to use the link's GUID, not the GUID of the asset to which it is attached.

---