Asset Page

View as Markdown

A wiki attached to a single Unity Catalog entity. Each entity has at most one wiki.

Get the wiki for an entityGET /api/2.0/knowledge/{name=*/*/page}Update the wiki for an entityPATCH /api/2.0/knowledge/{name=*/*/page}

AssetPage object

A wiki attached to a single Unity Catalog entity. Each entity has at most one wiki.

namestringBetaIDImmutable

Resource name of the wiki, of the form tables/{full_name}/page, where full_name is the table's three-level name (catalog.schema.table). Tables are the only entity type that supports wikis.

bodystringBeta

The wiki content, in Markdown.

descriptionstringBeta

Short description of the wiki.

statestringBeta

Lifecycle state of the wiki. Defaults to DRAFT when the wiki is created.

Values:

• DRAFT
• PUBLISHED

create_timestringBetaOutput only

Time at which this wiki was created.

update_timestringBetaOutput only

Time at which this wiki was last updated.

View as Markdown

The AssetPage object

{
  "name": "string",
  "body": "string",
  "description": "string",
  "state": "DRAFT",
  "create_time": "string",
  "update_time": "string"
}

Get the wiki for an entity Beta

GET /api/2.0/knowledge/{name=*/*/page}

Fetches the wiki for an entity.

API scopes: unity-catalog

Parameters

namestringRequiredpath

Resource name of the wiki, of the form tables/{full_name}/page, where full_name is the table's three-level name (catalog.schema.table).

Response

Returns the AssetPage object.

View as Markdown

Response

{
  "name": "string",
  "body": "string",
  "description": "string",
  "state": "DRAFT",
  "create_time": "string",
  "update_time": "string"
}

Update the wiki for an entity Beta

PATCH /api/2.0/knowledge/{name=*/*/page}

Updates the wiki, creating it if it does not exist yet. Setting state to PUBLISHED publishes a new version, as does changing the body of a wiki that stays published. Only update_mask paths are written.

API scopes: unity-catalog

Parameters

namestringRequiredIDImmutablepath

Resource name of the wiki, of the form tables/{full_name}/page, where full_name is the table's three-level name (catalog.schema.table). Tables are the only entity type that supports wikis.

update_maskstringRequiredquery

Paths that may be updated: body, description, state.

Request body

The wiki to update. Only fields named in update_mask are written.

bodystring

The wiki content, in Markdown.

descriptionstring

Short description of the wiki.

statestring

Lifecycle state of the wiki. Defaults to DRAFT when the wiki is created.

Values:

• DRAFT
• PUBLISHED

Response

Returns the AssetPage object.

View as Markdown

Request

{
  "body": "string",
  "description": "string",
  "state": "DRAFT"
}

Response

{
  "name": "string",
  "body": "string",
  "description": "string",
  "state": "DRAFT",
  "create_time": "string",
  "update_time": "string"
}