Tableau · Schema

Workbook

AnalyticsBusiness IntelligenceDashboardsData Visualization

Properties

Name Type Description
id string The unique identifier for the workbook.
name string The name of the workbook.
description string A description of the workbook.
contentUrl string The URL name of the workbook, used in URLs to access the workbook.
webpageUrl string The full URL to the workbook on the server.
showTabs boolean Whether the workbook shows views as tabs.
size integer The size of the workbook in bytes.
createdAt string The date and time the workbook was created.
updatedAt string The date and time the workbook was last updated.
encryptExtracts string Whether extracts in the workbook are encrypted.
defaultViewId string The ID of the default view in the workbook.
project object
owner object
tags object
views object
usage object
View JSON Schema on GitHub

JSON Schema

tableau-rest-workbook-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Workbook",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier for the workbook."
    },
    "name": {
      "type": "string",
      "description": "The name of the workbook."
    },
    "description": {
      "type": "string",
      "description": "A description of the workbook."
    },
    "contentUrl": {
      "type": "string",
      "description": "The URL name of the workbook, used in URLs to access the workbook."
    },
    "webpageUrl": {
      "type": "string",
      "description": "The full URL to the workbook on the server."
    },
    "showTabs": {
      "type": "boolean",
      "description": "Whether the workbook shows views as tabs."
    },
    "size": {
      "type": "integer",
      "description": "The size of the workbook in bytes."
    },
    "createdAt": {
      "type": "string",
      "description": "The date and time the workbook was created."
    },
    "updatedAt": {
      "type": "string",
      "description": "The date and time the workbook was last updated."
    },
    "encryptExtracts": {
      "type": "string",
      "description": "Whether extracts in the workbook are encrypted."
    },
    "defaultViewId": {
      "type": "string",
      "description": "The ID of the default view in the workbook."
    },
    "project": {
      "type": "object"
    },
    "owner": {
      "type": "object"
    },
    "tags": {
      "type": "object"
    },
    "views": {
      "type": "object"
    },
    "usage": {
      "type": "object"
    }
  }
}