Skip to main content

Validate Workbook Draft

Available September 2026 and later.

Checks workbook XML for problems before you apply it to the open workbook with apply-workbook, so invalid content never reaches Tableau Studio. It first runs a local well-formedness check, and only when that passes does it ask the running Tableau Studio instance for its authoritative structural validation. The tool is read-only: it never modifies the open workbook.

APIs called​

This tool checks workbook content and acts on the local Tableau Studio instance, not on the Tableau Cloud or Tableau Server REST API. It first runs a local check; only when that passes does it defer to the running Tableau Studio instance. That deeper check is a call to the local Tableau Studio External Client API — a REST API the running Tableau Studio instance serves at http://127.0.0.1:<port>/v<x>, where <x> is the latest API version. There are no OAuth scopes: the call is authorized by the running Tableau Studio instance's per-session bearer token over the loopback interface.

  • Checks the XML for well-formedness — unclosed tags, mismatched elements, and invalid entities are rejected. Validated in-process (not an API call). When this catches errors they are reported immediately and no further check runs.
  • Asks the running Tableau Studio instance to validate the workbook document and returns its authoritative result. Runs only after the local check passes.
    • POST /v<x>/workbook/document:validate — validate the posted workbook document against the running Tableau Studio instance (Content-Type: application/xml). API reference

Required arguments​

xml​

The workbook XML to check. Provide the full workbook document you intend to apply with apply-workbook. Passed as a string.

Example​

{ "xml": "<?xml version='1.0'?><workbook><worksheets/></workbook>" }

Optional arguments​

session​

Identifier of the target Tableau Studio session. When omitted, the session is resolved automatically (for example, when exactly one Tableau Studio instance is connected). The session is only needed for the deeper structural check against the running instance; the local well-formedness check runs regardless.

Example​

"studio-1"

Notes and caveats​

  • Offline falls back to the local check. When no Tableau Studio instance is reachable, the tool returns the result of the local well-formedness check instead of failing, so a syntax problem is still surfaced without a live session.
  • The running instance's result is authoritative. When the deeper check runs, its isValid verdict and validationIssues supersede the local check — including structural problems the local well-formedness check cannot see, such as a dashboard zone that references a missing worksheet.

Example results​

Well-formed workbook (validated against the running instance)​

{ "isValid": true, "validationIssues": [] }

Structural issues reported by the running instance​

{ "isValid": false, "validationIssues": ["Dashboard zone references missing worksheet \"Missing Sheet\""] }

Malformed XML (local check)​

Workbook structure has 1 error(s):

1. XML is not well-formed: unclosed tag: worksheets

Fix these errors before calling apply-workbook.

Well-formed with no live session (local check)​

Workbook structure is well-formed.
  • apply-workbook — applies workbook XML to the open workbook; run this check first so invalid content never reaches Tableau Studio.