Databricks SDK for JavaScript
    Preparing search index...

    A knowledge page: a domain-scoped governance document describing a concept or term in the account.

    interface Page {
        body?: string;
        createTime?: Instant;
        description?: string;
        displayName?: string;
        domain?: string;
        name?: string;
        ownerIds?: string[];
        state?: State;
        synonyms?: string[];
        updateTime?: Instant;
    }
    Index

    Properties

    body?: string

    Page body as Markdown text. An update replaces the entire body when body is selected by update_mask.

    createTime?: Instant

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

    description?: string

    Short description of the page. An update replaces the description when description is selected by update_mask.

    displayName?: string

    Human-readable title, 1 to 200 characters. Required on create and when selected by update_mask. Published titles must be unique within the domain.

    domain?: string

    Resource name of the domain this page belongs to; format domains/{domain_id}. Required on create. Use the full resource name rather than a bare domain ID. The domain is fixed after creation; updating it is not supported.

    name?: string

    Resource name in the form pages/{page_id}, where page_id is a server-generated UUID. Omit on create; required to identify the page on update. Get and Delete also address pages by this full resource name.

    ownerIds?: string[]

    Decimal principal ID strings for the page's single owner: a user, group, or service principal. Use principal IDs rather than email addresses or service-principal application UUIDs. On create, an omitted or empty list defaults to the caller; at most one ID may be supplied. An update selecting owner_ids in update_mask must supply exactly one ID to replace the owner.

    state?: State

    Lifecycle state. Omitting it on create defaults to DRAFT. Set PUBLISHED to publish or DRAFT to unpublish. An update selecting state in update_mask must explicitly supply DRAFT or PUBLISHED.

    synonyms?: string[]

    Alternate names or abbreviations. Accepts at most 50 entries, each 1 to 200 characters. Values are trimmed, deduplicated, and sorted. An update replaces the entire list when synonyms is selected by update_mask; an empty list clears it.

    updateTime?: Instant

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