Asset Link

View as Markdown

A reference or provenance link from a page to an asset. Links are immutable; to change the target, delete and re-create the link.

Get an asset linkGET /api/2.0/knowledge/{name=pages/*/asset-link-categories/*/asset-links/*}Create an asset link on a pagePOST /api/2.0/knowledge/{parent=pages/*/asset-link-categories/*}/asset-linksDelete an asset linkDELETE /api/2.0/knowledge/{name=pages/*/asset-link-categories/*/asset-links/*}

AssetLink object

A reference or provenance link from a page to an asset. Links are immutable; to change the target, delete and re-create the link.

namestringBetaIDImmutable

Resource name of the link. Server-assigned on create, immutable thereafter. Format: pages/{page_id}/asset-link-categories/{category}/asset-links/{link_id}, where category is SOURCE or RELATED_ASSETS and link_id is a server-generated UUID. Omit on create; use the returned name for Get/Delete.

asset_typestringBeta

Kind of asset this link points to. Required on create; ASSET_TYPE_UNSPECIFIED is not a valid target type.

Values:

• ASSET_TYPE_UC_TABLE
• ASSET_TYPE_WORKSPACE_DASHBOARD
• ASSET_TYPE_WORKSPACE_GENIE_AGENT
• ASSET_TYPE_WORKSPACE_NOTEBOOK
• ASSET_TYPE_WORKSPACE_APP
• ASSET_TYPE_WORKSPACE_DBSQL_QUERY
• ASSET_TYPE_ACCOUNT_PAGE
• ASSET_TYPE_ACCOUNT_USER
• ASSET_TYPE_EXTERNAL_URL

asset_scope_idstringBeta

Containing scope of the asset. Required on create for every asset type:

• UC table: metastore UUID.
• Workspace asset: decimal workspace ID string.
• Account page or external URL: the calling account UUID. Pass the bare ID, without a resource-name prefix. Query and Genie links, dashboard UUID inputs, and app-name inputs require this scope to match the caller's workspace.

asset_idstringBeta

Target identifier within asset_scope_id. Required on create. The accepted format depends on asset_type; see the identifier rules on each AssetType. For Databricks assets, pass the bare identifier rather than a resource name such as pages/{page_id} or queries/{query_id}. External assets use the full URL. Create and Get return table FQNs, app UUIDs, query UUIDs, and native Genie space IDs.

create_timestringBetaOutput only

Server-assigned creation time, formatted as an RFC 3339 timestamp in JSON.

View as Markdown

The AssetLink object

{
  "name": "string",
  "asset_type": "ASSET_TYPE_UC_TABLE",
  "asset_scope_id": "string",
  "asset_id": "string",
  "create_time": "string"
}

Get an asset link Beta

GET /api/2.0/knowledge/{name=pages/*/asset-link-categories/*/asset-links/*}

Get an asset link by its full resource name. Table links return the table's current FQN and require access to that table. Query and Genie links return native UUIDs and require access in the caller's workspace. Returns NOT_FOUND if the link is missing or its target identifier cannot be resolved.

API scopes: knowledge

Parameters

namestringRequiredpath

Resource name of the link to retrieve. Format: pages/{page_id}/asset-link-categories/{category}/asset-links/{link_id}

Response

Returns the AssetLink object.

View as Markdown

Response

{
  "name": "string",
  "asset_type": "ASSET_TYPE_UC_TABLE",
  "asset_scope_id": "string",
  "asset_id": "string",
  "create_time": "string"
}

Create an asset link on a page Beta

POST /api/2.0/knowledge/{parent=pages/*/asset-link-categories/*}/asset-links

Create an asset link on a page. For REST, send AssetLink fields directly as the JSON request body; the parent path supplies the page and category. An existing target with the same asset type, scope, and resolved asset ID in that page/category returns the original link and creation time.

API scopes: knowledge

Parameters

parentstringRequiredpath

Category collection on the page in which to create the link. Format: pages/{page_id}/asset-link-categories/{category}, where {category} is a LinkCategory value (SOURCE or RELATED_ASSETS).

Request body

The link to create. asset_type, asset_scope_id, and asset_id are required. The server assigns name and create_time; the path supplies the page and category. A duplicate target in that category returns the existing link.

namestringIDImmutable

Resource name of the link. Server-assigned on create, immutable thereafter. Format: pages/{page_id}/asset-link-categories/{category}/asset-links/{link_id}, where category is SOURCE or RELATED_ASSETS and link_id is a server-generated UUID. Omit on create; use the returned name for Get/Delete.

asset_typestringRequired

Kind of asset this link points to. Required on create; ASSET_TYPE_UNSPECIFIED is not a valid target type.

Values:

• ASSET_TYPE_UC_TABLE
• ASSET_TYPE_WORKSPACE_DASHBOARD
• ASSET_TYPE_WORKSPACE_GENIE_AGENT
• ASSET_TYPE_WORKSPACE_NOTEBOOK
• ASSET_TYPE_WORKSPACE_APP
• ASSET_TYPE_WORKSPACE_DBSQL_QUERY
• ASSET_TYPE_ACCOUNT_PAGE
• ASSET_TYPE_ACCOUNT_USER
• ASSET_TYPE_EXTERNAL_URL

asset_scope_idstringRequired

Containing scope of the asset. Required on create for every asset type:

• UC table: metastore UUID.
• Workspace asset: decimal workspace ID string.
• Account page or external URL: the calling account UUID. Pass the bare ID, without a resource-name prefix. Query and Genie links, dashboard UUID inputs, and app-name inputs require this scope to match the caller's workspace.

asset_idstringRequired

Target identifier within asset_scope_id. Required on create. The accepted format depends on asset_type; see the identifier rules on each AssetType. For Databricks assets, pass the bare identifier rather than a resource name such as pages/{page_id} or queries/{query_id}. External assets use the full URL. Create and Get return table FQNs, app UUIDs, query UUIDs, and native Genie space IDs.

Response

Returns the AssetLink object.

View as Markdown

Request

{
  "name": "string",
  "asset_type": "ASSET_TYPE_UC_TABLE",
  "asset_scope_id": "string",
  "asset_id": "string"
}

Response

{
  "name": "string",
  "asset_type": "ASSET_TYPE_UC_TABLE",
  "asset_scope_id": "string",
  "asset_id": "string",
  "create_time": "string"
}

Delete an asset link Beta

DELETE /api/2.0/knowledge/{name=pages/*/asset-link-categories/*/asset-links/*}

Delete an asset link by its full resource name. Returns NOT_FOUND if the link does not exist, including when it has already been deleted.

API scopes: knowledge

Parameters

namestringRequiredpath

Resource name of the link to delete. Format: pages/{page_id}/asset-link-categories/{category}/asset-links/{link_id}

View as Markdown

Response

{}