List Worksheet Logical Tables
Lists the logical tables of one worksheet in the workbook open in the connected Tableau Studio instance, returning each table's id and caption — the identifiers you pass when reading that worksheet's row-level underlying data with get-worksheet-underlying-data. Choose the worksheet with worksheet, giving either its name or its id. This is a read-only operation that makes no changes to the workbook.
APIs called
This tool reads from the workbook open in the running Tableau Studio instance, not the Tableau Cloud or Server REST API. Under the hood these are calls 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. Because this API is local rather than a cloud service, it uses no OAuth scopes; each call is authorized instead by the running Tableau Studio instance's per-session bearer token over the loopback interface. A workbook must be open in the resolved Tableau Studio session.
- Reads the worksheet inventory of the open workbook to resolve the target worksheet by name or id. Authorized by the session's loopback bearer token; requires a workbook to be open in the session.
GET /v<x>/workbook/worksheets— list the worksheets in the open workbook. API reference
- Reads the logical tables available for that worksheet's underlying data, returning each table's id and caption. Authorized by the session's loopback bearer token.
GET /v<x>/workbook/worksheets/{id}/logicalTables— list the worksheet's logical tables. API reference
Required arguments
worksheet
Name or id of the worksheet whose logical tables to list. A string. The worksheet must exist in the open workbook.
Example
{ "worksheet": "Sales by Region" }
Worksheet resolution
If the value matches no worksheet, the tool returns an error listing the available worksheet names and ids. If the value matches more than one worksheet by name, the tool returns an error listing the matching worksheets so the ambiguity can be resolved (for example, by passing the worksheet's id instead of its name).
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 or a session has been pinned).
Example
"studio-1"
Notes and caveats
- Id and caption. Each table includes
idandcaptionwhen the running instance reports them. A field that is not reported is omitted from that entry rather than returned empty. - Empty
tableswhen the worksheet has none. The tool returns{ "tables": [] }rather than an error.
Example results
Logical tables found (worksheet: "Sales by Region")
{
"tables": [
{ "id": "lt-orders", "caption": "Orders" },
{ "id": "lt-returns", "caption": "Returns" }
]
}
No logical tables
{
"tables": []
}
Related
get-worksheet-underlying-data— reads row-level rows from one of the listed logical tables.get-summary-data— reads the aggregated rows and columns on the worksheet's view, rather than listing the logical tables used for row-level underlying data.