Version: current [25.x]

Wiki

Use the Catalog API to create, update, and retrieve the wiki for a source, space, or dataset.

Wiki Object

{
  "text": "# Testspace Wiki\nThis is an example wiki for a catalog object in Dremio. Here is some text in **bold**. Here is some text in *italics*.\n\nHere is an example excerpt with quotation formatting:\n\n> Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.\n\n\n## Heading Level 2\n\nHere is a bulleted list:\n* An item in a bulleted list\n* A second item in a bulleted list\n* A third item in a bulleted list\n\n\n### Heading Level 3\n\nHere is a numbered list:\n1. An item in a numbered list\n1. A second item in a numbered list\n1. A third item in a numbered list\n\n\nHere is a sentence that includes an [external link to https://dremio.com](https://dremio.com).\n\nHere is an image:\n\n![](https://www.dremio.com/wp-content/uploads/2022/03/Dremio-logo.png)\n\nUt enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
  "version": 4
}

Wiki Attributes

text String

Text displayed in the wiki, formatted with GitHub-flavored Markdown.

version Integer

Number for the most recent version of the wiki, starting with 0. Dremio increments the value by 1 each time the wiki changes and uses the version value to ensure that updates apply to the most recent version of the wiki.

Example: 4

Creating a Wiki

Create a wiki for the specified source, space, or dataset.

Method and URL

POST /api/v3/catalog/{object-id}/collaboration/wiki

Parameters

object-id Path String (UUID)

Unique identifier of the source, space, or dataset for which you want to add the wiki.

Example: 1bcab7b3-ee82-44c1-abcc-e86d56078d4d

text Body String

Text to display in the wiki. Use GitHub-flavored Markdown for wiki formatting and \\n for new lines and blank lines. Each wiki may have a maximum of 100,000 characters.

Example Request

curl -X POST 'https://{hostname}/api/v3/catalog/1bcab7b3-ee82-44c1-abcc-e86d56078d4d/collaboration/wiki' \
--header 'Authorization: Bearer <PersonalAccessToken>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "text": "# Testspace Wiki\nThis is an example wiki for a catalog object in Dremio. Here is some text in **bold**. Here is some text in *italics*.\n\nHere is an example excerpt with quotation formatting:\n\n> Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.\n\n\n## Heading Level 2\n\nHere is a bulleted list:\n* An item in a bulleted list\n* A second item in a bulleted list\n* A third item in a bulleted list\n\n\n### Heading Level 3\n\nHere is a numbered list:\n1. An item in a numbered list\n1. A second item in a numbered list\n1. A third item in a numbered list\n\n\nHere is a sentence that includes an [external link to https://dremio.com](https://dremio.com).\n\nHere is an image:\n\n![](https://www.dremio.com/wp-content/uploads/2022/03/Dremio-logo.png)\n\nUt enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."
}'

Example Response

{
  "text": "# Testspace Wiki\nThis is an example wiki for a catalog object in Dremio. Here is some text in **bold**. Here is some text in *italics*.\n\nHere is an example excerpt with quotation formatting:\n\n> Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.\n\n\n## Heading Level 2\n\nHere is a bulleted list:\n* An item in a bulleted list\n* A second item in a bulleted list\n* A third item in a bulleted list\n\n\n### Heading Level 3\n\nHere is a numbered list:\n1. An item in a numbered list\n1. A second item in a numbered list\n1. A third item in a numbered list\n\n\nHere is a sentence that includes an [external link to https://dremio.com](https://dremio.com).\n\nHere is an image:\n\n![](https://www.dremio.com/wp-content/uploads/2022/03/Dremio-logo.png)\n\nUt enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
  "version": 0
}

Response Status Codes

200 OK

400 Bad Request

401 Unauthorized

403 Forbidden

404 Not Found

Retrieving a Wiki

Retrieve the wiki for the specified source, space, or dataset.

Method and URL

GET /api/v3/catalog/{object-id}/collaboration/wiki

Parameters

object-id Path String (UUID)

Unique identifier of the source, space, or dataset whose wiki you want to retrieve.

Example: 1bcab7b3-ee82-44c1-abcc-e86d56078d4d

Example Request

curl -X GET 'https://{hostname}/api/v3/catalog/1bcab7b3-ee82-44c1-abcc-e86d56078d4d/collaboration/wiki' \
--header 'Authorization: Bearer <PersonalAccessToken>' \
--header 'Content-Type: application/json'

Example Response

{
  "text": "# Testspace Wiki\nThis is an example wiki for a catalog object in Dremio. Here is some text in **bold**. Here is some text in *italics*.\n\nHere is an example excerpt with quotation formatting:\n\n> Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.\n\n\n## Heading Level 2\n\nHere is a bulleted list:\n* An item in a bulleted list\n* A second item in a bulleted list\n* A third item in a bulleted list\n\n\n### Heading Level 3\n\nHere is a numbered list:\n1. An item in a numbered list\n1. A second item in a numbered list\n1. A third item in a numbered list\n\n\nHere is a sentence that includes an [external link to https://dremio.com](https://dremio.com).\n\nHere is an image:\n\n![](https://www.dremio.com/wp-content/uploads/2022/03/Dremio-logo.png)\n\nUt enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
  "version": 0
}

Response Status Codes

200 OK

400 Bad Request

401 Unauthorized

403 Forbidden

404 Not Found

Updating a Wiki

Update the wiki for the specified source, space, or dataset.

Method and URL

POST /api/v3/catalog/{object-id}/collaboration/wiki

Parameters

object-id Path String (UUID)

Unique identifier of the source, space, or dataset whose wiki you want to update.

Example: 1bcab7b3-ee82-44c1-abcc-e86d56078d4d

text Body String

Text to display in the wiki, formatted with GitHub-flavored Markdown.

version Body Integer

Number listed as the version value for the most recent existing wiki. Dremio uses the version value to ensure that you are updating the most recent version of the wiki.

Example: 0

Example Request

curl -X POST 'https://{hostname}/api/v3/catalog/1bcab7b3-ee82-44c1-abcc-e86d56078d4d/collaboration/wiki' \
--header 'Authorization: Bearer <PersonalAccessToken>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "text": "# New Title Wiki\nThis is an example wiki for a catalog object in Dremio. Here is some text in **bold**. Here is some text in *italics*.\n\nHere is an example excerpt with quotation formatting:\n\n> Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.\n\n\n## Heading Level 2\n\nHere is an update to the bulleted list:\n* An item in a bulleted list\n* A second item in a bulleted list\n* A third item in a bulleted list\n\n\n### Heading Level 3\n\nHere is a numbered list:\n1. An item in a numbered list\n1. A second item in a numbered list\n1. A third item in a numbered list\n\n\nHere is a sentence that includes an [external link to https://dremio.com](https://dremio.com).\n\nHere is an image:\n\n![](https://www.dremio.com/wp-content/uploads/2022/03/Dremio-logo.png)\n\nUt enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
  "version": 0
}'

Example Response

{
  "text": "# New Title Wiki\nThis is an example wiki for a catalog object in Dremio. Here is some text in **bold**. Here is some text in *italics*.\n\nHere is an example excerpt with quotation formatting:\n\n> Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.\n\n\n## Heading Level 2\n\nHere is an update to the bulleted list:\n* An item in a bulleted list\n* A second item in a bulleted list\n* A third item in a bulleted list\n\n\n### Heading Level 3\n\nHere is a numbered list:\n1. An item in a numbered list\n1. A second item in a numbered list\n1. A third item in a numbered list\n\n\nHere is a sentence that includes an [external link to https://dremio.com](https://dremio.com).\n\nHere is an image:\n\n![](https://www.dremio.com/wp-content/uploads/2022/03/Dremio-logo.png)\n\nUt enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
  "version": 1
}

Response Status Codes

200 OK

400 Bad Request

401 Unauthorized

403 Forbidden

404 Not Found

409 Conflict

Deleting a Wiki

Delete the wiki for the specified source, space, or dataset.

note

Deleting the wiki entails sending an empty string to replace the existing wiki with no wiki. The wiki object will still exist, but it will contain an empty text value and no wiki will appear for the source, space, or dataset in the Dremio UI.

Method and URL

POST /api/v3/catalog/{object-id}/collaboration/wiki

Parameters

object-id Path String (UUID)

Unique identifier of the source, space, or dataset whose wiki you want to delete.

Example: 1bcab7b3-ee82-44c1-abcc-e86d56078d4d

text Body String

Empty string to represent deletion of the wiki.

Example: ""

version Body Integer

Number listed as the version value for the most recent existing wiki. Dremio uses the version value to ensure that you are deleting the most recent version of the wiki.

Example: 1

Example Request

curl -X DELETE 'https://{hostname}/api/v3/catalog/1bcab7b3-ee82-44c1-abcc-e86d56078d4d/collaboration/wiki' \
--header 'Authorization: Bearer <PersonalAccessToken>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "text": "",
  "version": 1
}'

Example Response

{
  "text": "",
  "version": 2
}

Response Status Codes

200 OK

400 Bad Request

401 Unauthorized

403 Forbidden

404 Not Found

409 Conflict

Wiki Attributes​

Creating a Wiki​

Parameters​

Response Status Codes​

Retrieving a Wiki​

Parameters​

Response Status Codes​

Updating a Wiki​

Parameters​

Response Status Codes​

Deleting a Wiki​

Parameters​

Response Status Codes​

Wiki Attributes

Creating a Wiki

Parameters

Response Status Codes

Retrieving a Wiki

Parameters

Response Status Codes

Updating a Wiki

Parameters

Response Status Codes

Deleting a Wiki

Parameters

Response Status Codes