Databricks SDK for JavaScript
    Preparing search index...
    Index

    Constructors

    Methods

    • 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.

      Parameters

      Returns Promise<AssetLink>

    • Create a knowledge page. Optional request_id makes retries idempotent while the page exists; without it, retries can create duplicate drafts. For REST, send Page fields as the JSON body and request_id as a query parameter. When page permissions are enforced, creating a published page or assigning another owner requires Page Manager or Domain Admin permissions on the domain, including inherited grants. Creating your own draft requires neither grant.

      Errors: INVALID_PARAMETER_VALUE (missing page/domain or field validation), NOT_FOUND (the referenced domain does not exist), ALREADY_EXISTS (a published page with the same domain and display_name already exists), PERMISSION_DENIED (insufficient permissions), RESOURCE_EXHAUSTED (rate limited), INTERNAL_ERROR (unexpected failure).

      Parameters

      Returns Promise<Page>

    • 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.

      Parameters

      Returns Promise<AssetLink>

    • List visible knowledge pages in the account, optionally narrowed by domain and state. With a domain filter, the caller must administer that domain, including through inherited grants. Without a domain filter, including when filtering only by state, account-wide Manage Discover or Account Admin permission is required. List returns page metadata.

      Parameters

      Returns Promise<ListPagesResponse>

    • Update an existing knowledge page. For REST, send Page fields directly as the JSON body and supply update_mask as a query parameter. The resource name identifies the page; omitted mask fields retain their stored values.

      Errors: INVALID_PARAMETER_VALUE (field validation), NOT_FOUND (the page does not exist), ALREADY_EXISTS (a rename would collide with another published page), RESOURCE_EXHAUSTED, ABORTED, INTERNAL_ERROR.

      Parameters

      Returns Promise<Page>