External Client API (0.2.34)

Download OpenAPI specification:Download

This REST API provides a programmatic interface for reading and authoring the open Tableau Studio document. Clients authenticate with the bearer token published in the per-user discovery file.

External Client API Guide

The External Client API Guide provides an overview of the External Client API and:

Get application info

Returns information about the running Tableau Studio process, including its version, edition, build, operating system, locale, and repository and log paths.

Authorizations:
bearerAuth
header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "applicationVersion": "string",
  • "edition": "string",
  • "build": "string",
  • "os": "string",
  • "locale": "string",
  • "repositoryLocation": "string",
  • "logLocation": "string",
  • "isStartPageVisible": true,
  • "isDataSourcePageActive": true,
  • "isPresentationMode": true,
  • "isCanvasMode": true
}

List active dialogs

Returns the dialogs that are open, including ones that are preparing, suspended, or closing. Each active dialog includes the session id and revision used to invoke an action.

Authorizations:
bearerAuth
header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "dialogs": [
    ],
  • "uiSnapshotAvailable": true,
  • "recentActions": [
    ]
}

List workspace extensions

Returns workspace extensions installed for this user, including disabled ones. Each entry has a stable id for the reload operation.

Authorizations:
bearerAuth
header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "extensions": [
    ]
}

Reload workspace extension

Reloads a workspace extension from the Packages folder and refreshes any of its open pages. Extensions removed from that folder are removed from Studio. An unknown id returns 404.

Authorizations:
bearerAuth
path Parameters
id
required
string

The workspace extension's id, as returned by GET /v0/app/extensions.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

Capture window screenshots

Saves a PNG of each open Studio window to the given directory and returns the file paths.

Authorizations:
bearerAuth
query Parameters
outputPath
required
string

Absolute directory where the screenshots are written.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "filePaths": [
    ]
}

Get application state

Returns whether Studio is idle or blocked, and which dialogs or activities are in the way.

Authorizations:
bearerAuth
header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "state": "string",
  • "blockedBy": "string",
  • "uiSnapshotAvailable": true,
  • "activeActivities": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

Invoke dialog action

Runs one action on an active dialog. Copy the dialog identity from the dialog list, and send a new request id for each attempt.

Authorizations:
bearerAuth
header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Request Body schema: application/json
required
required
object (DialogIdentity)

Dialog to act on, copied from the dialog list.

requestId
required
string [ 1 .. 128 ] characters ^[!-~]+$

Id for this attempt. Send the same id to retry it.

required
object or object or object or object or object or object or object or object or object (DialogActionInvocation)

Responses

Request samples

Content type
application/json
{
  • "dialog": {
    },
  • "requestId": "string",
  • "action": {
    }
}

Response samples

Content type
application/json
{
  • "outcome": "dispatched-pending",
  • "dialog": {
    },
  • "status": {
    },
  • "uiSnapshotAvailable": true,
  • "dialogs": [
    ]
}

Open a file

Opens a local file by path. A workbook file opens as a workbook. A data file attaches to the open workbook, and creates a workbook when none is open. Opening another workbook starts a new Studio window, and this session stays on the original workbook.

Authorizations:
bearerAuth
header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Request Body schema: application/json
required
filePath
required
string

The absolute path of the local file to open.

Responses

Request samples

Content type
application/json
{
  • "filePath": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

Set Data Source page visibility

Sets whether the Data Source page is the active tab. Sending the same state again changes nothing.

Authorizations:
bearerAuth
header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Request Body schema: application/json
required
isDataSourcePageActive
required
boolean

True to show the Data Source page.

Responses

Request samples

Content type
application/json
{
  • "isDataSourcePageActive": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

Set start page visibility

Sets whether the Tableau Studio start page is visible and returns the resulting visibility. Repeated requests for the same visibility have no additional effect.

Authorizations:
bearerAuth
header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Request Body schema: application/json
required
isStartPageVisible
required
boolean

True when the start page is visible.

Responses

Request samples

Content type
application/json
{
  • "isStartPageVisible": true
}

Response samples

Content type
application/json
{
  • "isStartPageVisible": true
}

List dashboards

Lists the dashboards contained in the open workbook.

Authorizations:
bearerAuth
header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "dashboards": [
    ]
}

Get a dashboard

Returns the metadata for a single dashboard in the open workbook identified by its id.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "id": "string",
  • "name": "string",
  • "hidden": true,
  • "isActiveSheet": true,
  • "index": 0,
  • "isAutoUpdatesPaused": true,
  • "containedSheets": [
    ]
}

Get a dashboard document

Returns the dashboard as Tableau XML.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

header Parameters
X-Tableau-Effective-Payload-Version
string

Reserved. The server accepts the header and ignores it. Documents use the running product version.

User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

Apply a dashboard document

Replaces this dashboard with the submitted Tableau XML and leaves other sheets unchanged. The XML is checked only to confirm it is well formed, and it overwrites a concurrent edit of the same sheet.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

header Parameters
X-Tableau-Effective-Payload-Version
string

Reserved. The server accepts the header and ignores it. Documents use the running product version.

User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Request Body schema:
required

Tableau XML for this dashboard, alone or wrapped in a workbook. Other sheets in the file are ignored. The dashboard must use datasources already in the open workbook.

string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

Export a dashboard image

Renders a single dashboard (resolved by id) as an image, returned inline as base64 or written to a caller-supplied file path.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

query Parameters
filePath
string

Path to write the image to. Must be absolute and name a file; a directory, a trailing slash, or any '.'/'..' path segment is rejected with a 400. When set, the response projects this path instead of inline base64; when omitted, the image is returned as base64.

mimeType
string

Requested image MIME type (e.g. image/png, image/jpeg). The effective type is returned in the response.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "filePath": "string",
  • "effectiveMimeType": "string",
  • "width": 0,
  • "height": 0
}

Delete a dashboard

Deletes a single dashboard by id. Deleting the workbook's last visible sheet is a no-op.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

Pause dashboard auto-updates

Pauses automatic query execution for a dashboard so several edits can be batched before the next refresh.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

Refresh dashboard now

Refreshes every worksheet on the dashboard's current layout without changing the active sheet. A worksheet that fails does not undo the ones that succeeded.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

Reload dashboard extensions

Reloads every extension on the dashboard. Succeeds with nothing to do when the dashboard has no extension.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

Rename a dashboard

Renames a dashboard identified by id.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Request Body schema: application/json
required
name
required
string

The new name of the sheet.

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

Resume dashboard auto-updates

Resumes automatic query execution for a dashboard.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

Add a blank dashboard

Creates a single blank dashboard with a generated name. Any request body is ignored.

Authorizations:
bearerAuth
query Parameters
index
integer

Tab position for the new sheet, starting at 0. Omit it to add the sheet at the end.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

Datasources

With Datasources operations, you can:

Refresh a datasource's data

Refreshes live data for the datasource named by id. This does not refresh an extract. A datasource with nothing to refresh finishes successfully.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

Refresh a datasource extract

Refreshes the extract for the datasource named by id. The refresh is incremental when the extract is set up that way. Set isFullRefresh to force a full refresh. A datasource with no extract finishes successfully.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Request Body schema: application/json
optional
isFullRefresh
boolean

Force a full refresh instead of an incremental one. Defaults to false: incremental when the extract supports it, otherwise a full refresh.

Responses

Request samples

Content type
application/json
{
  • "isFullRefresh": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

List operations

Lists in-flight and recently-completed async operations.

Authorizations:
bearerAuth
query Parameters
state
string

Return only operations in this state (an OperationState value); an unrecognized value matches nothing.

kind
string

Return only operations of this command kind.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "operations": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ],
  • "uiSnapshotAvailable": true
}

Get an operation

Polls a single async operation by id until it reaches a terminal state.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

Get protected-resource metadata

Returns the metadata clients use to authenticate to this API, including its resource URL and the supported bearer methods.

Responses

Response samples

Content type
application/json
{
  • "resource": "string",
  • "bearer_methods_supported": [
    ]
}

Get the OpenAPI document

Returns this API's OpenAPI document.

Responses

Response samples

Content type
application/json
{
  • "openapi": "3.1.0",
  • "info": { },
  • "servers": [ ],
  • "paths": { },
  • "components": { },
  • "security": [ ]
}

Get the API root

Returns the API and application version strings together with a link map that points to the available top-level resources.

Responses

Response samples

Content type
application/json
{
  • "apiVersion": "string",
  • "applicationVersion": "string",
  • "links": {
    }
}

Get capability matrix

Returns the operations this API version supports, and whether each one needs a signed-in server.

Authorizations:
bearerAuth
header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "capabilities": {
    }
}

Check API liveness

Returns a liveness probe result that confirms the External Client API is running and able to serve requests.

Responses

Response samples

Content type
application/json
{
  • "status": "OK"
}

List storyboards

Lists the storyboards contained in the open workbook.

Authorizations:
bearerAuth
header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "storyboards": [
    ]
}

Get a storyboard

Returns the metadata for a single storyboard in the open workbook identified by its id.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "id": "string",
  • "name": "string",
  • "hidden": true,
  • "isActiveSheet": true,
  • "index": 0,
  • "storyPointCount": 0
}

Get a storyboard document

Returns the storyboard as Tableau XML.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

header Parameters
X-Tableau-Effective-Payload-Version
string

Reserved. The server accepts the header and ignores it. Documents use the running product version.

User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

Apply a storyboard document

Replaces this storyboard with the submitted Tableau XML and leaves other sheets unchanged. The XML is checked only to confirm it is well formed, and it overwrites a concurrent edit of the same sheet.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

header Parameters
X-Tableau-Effective-Payload-Version
string

Reserved. The server accepts the header and ignores it. Documents use the running product version.

User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Request Body schema:
required

Tableau XML for this storyboard, alone or wrapped in a workbook. Other sheets in the file are ignored. The storyboard must use datasources already in the open workbook.

string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

Export a storyboard image

Renders a storyboard's active story point (resolved by id) as an image, returned inline as base64 or written to a caller-supplied file path.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

query Parameters
filePath
string

Path to write the image to. Must be absolute and name a file; a directory, a trailing slash, or any '.'/'..' path segment is rejected with a 400. When set, the response projects this path instead of inline base64; when omitted, the image is returned as base64.

mimeType
string

Requested image MIME type (e.g. image/png, image/jpeg). The effective type is returned in the response.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "filePath": "string",
  • "effectiveMimeType": "string",
  • "width": 0,
  • "height": 0
}

Delete a storyboard

Deletes a single storyboard by id. Deleting the workbook's last visible sheet is a no-op.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

Refresh storyboard now

Refreshes the current story point without changing the active sheet or story point. A worksheet that fails does not undo the ones that succeeded.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

Rename a storyboard

Renames a storyboard identified by id.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Request Body schema: application/json
required
name
required
string

The new name of the sheet.

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

Add a blank storyboard

Creates a single blank storyboard with a generated name. Any request body is ignored.

Authorizations:
bearerAuth
query Parameters
index
integer

Tab position for the new sheet, starting at 0. Omit it to add the sheet at the end.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

Get the open workbook

Returns the metadata and sheet inventory of the workbook currently open in Tableau Studio, or a 404 response when no workbook is open.

Authorizations:
bearerAuth
header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "title": "string",
  • "location": "string",
  • "unsavedChanges": true,
  • "worksheets": [
    ],
  • "dashboards": [
    ],
  • "storyboards": [
    ]
}

List workbook datasources

Lists the datasources that the open workbook uses.

Authorizations:
bearerAuth
header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "datasources": [
    ]
}

Get a workbook datasource

Returns metadata for a single datasource by its URL-encoded inventory id.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "id": "string",
  • "luid": "string",
  • "name": "string",
  • "caption": "string",
  • "isExtract": true,
  • "hasDownloadFilePermission": true
}

Get a datasource document

Returns the datasource as Tableau XML.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

header Parameters
X-Tableau-Effective-Payload-Version
string

Reserved. The server accepts the header and ignores it. Documents use the running product version.

User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

Apply a datasource document

Replaces this datasource with the submitted Tableau XML and leaves other datasources and sheets unchanged. The XML must contain that one datasource.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

header Parameters
X-Tableau-Effective-Payload-Version
string

Reserved. The server accepts the header and ignores it. Documents use the running product version.

User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Request Body schema:
required

Tableau XML for this datasource. The file must contain exactly one datasource, and its internal name must match the id.

string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

List datasource logical tables

Returns the logical tables in the datasource, with each table's id and caption.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "tables": [
    ]
}

Get datasource logical table data

Returns rows from one logical table in the datasource.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

logicalTableId
required
string

Id of the logical table. Use single-table-id-sentinel when there is only one table.

query Parameters
maxRows
integer

Maximum number of rows to return.

columnsToIncludeByFieldName
Array of strings

Field names that limit which columns are returned.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "columns": [
    ],
  • "rows": [
    ]
}

Validate datasource calculated field

Checks a calculated-field formula on the datasource without creating or changing a field. Omit the field name to check a new formula. Set it to check an edit of an existing field.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Request Body schema: application/json
required
formula
required
string non-empty

The calculated-field formula text to validate.

caption
string non-empty

Caption the field would use. A blank or duplicate caption is an error.

fieldName
string non-empty

Internal name of an existing calculated field to edit, as [datasource].[field]. Omit it to check a new field.

Responses

Request samples

Content type
application/json
{
  • "formula": "string",
  • "caption": "string",
  • "fieldName": "string"
}

Response samples

Content type
application/json
{
  • "isValid": true,
  • "errors": [
    ],
  • "isAggregate": true,
  • "dataType": "string"
}

Get workbook diagnostics

Checks the fields used on each worksheet and reports any that are invalid. This check does not run the query.

Authorizations:
bearerAuth
header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "worksheets": [
    ]
}

Get the workbook document

Returns the open workbook as Tableau XML.

Authorizations:
bearerAuth
header Parameters
X-Tableau-Effective-Payload-Version
string

Reserved. The server accepts the header and ignores it. Documents use the running product version.

User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

Apply a workbook document

Replaces the open workbook with the submitted Tableau XML. The XML is checked only to confirm it is well formed. Sheets left out of the XML are deleted.

Authorizations:
bearerAuth
header Parameters
X-Tableau-Effective-Payload-Version
string

Reserved. The server accepts the header and ignores it. Documents use the running product version.

User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Request Body schema:
required

The workbook as Tableau XML.

string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

Validate a workbook document

Checks the submitted Tableau XML and reports problems without changing the open workbook.

Authorizations:
bearerAuth
header Parameters
X-Tableau-Effective-Payload-Version
string

Reserved. The server accepts the header and ignores it. Documents use the running product version.

User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Request Body schema:
required

The workbook as Tableau XML.

string

Responses

Response samples

Content type
application/json
{
  • "isValid": true,
  • "issues": [
    ]
}

List workbook extensions

Returns the extensions placed on sheets in the open workbook.

Authorizations:
bearerAuth
header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "extensions": [
    ]
}

Close workbook

Closes the open workbook. Studio asks to save when there are unsaved changes.

Authorizations:
bearerAuth
header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

Export the workbook

Exports the open workbook to a file and leaves the open workbook unchanged. format is pdf, powerpoint, packaged-workbook, or prior-version. For prior-version, also send targetVersion, such as 2024.1. The export writes only to filePath.

Authorizations:
bearerAuth
header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Request Body schema: application/json
required
filePath
required
string

Absolute path to write the export to. Its extension must match format: .pdf for pdf, .pptx for powerpoint, .twbx for packaged-workbook, and .twb or .twbx for prior-version.

format
required
string
Enum: "pdf" "powerpoint" "packaged-workbook" "prior-version"

The export format that selects what file to produce. Only the listed values are accepted; any other value is rejected with a 400.

targetVersion
string

Required when format is prior-version: the customer-facing Tableau release to down-save to (e.g. "2024.1"). Ignored for other formats.

Responses

Request samples

Content type
application/json
{
  • "filePath": "string",
  • "format": "pdf",
  • "targetVersion": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

Go to a sheet

Makes the identified worksheet, dashboard, or storyboard the active sheet.

Authorizations:
bearerAuth
header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Request Body schema: application/json
required
id
required
string

The identifier of the sheet to activate.

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

Redo the last undone change

Reapplies the change most recently undone on the open workbook, equivalent to Edit > Redo.

Authorizations:
bearerAuth
header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

Save the workbook

Saves the open workbook. Send filePath to save a copy, or omit it to save in place. The path must end in .twb or .twbx. A workbook that has never been saved, and has no filePath, opens the Save As dialog.

Authorizations:
bearerAuth
header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Request Body schema: application/json
optional
filePath
string

Path to save a copy to. It must end in .twb or .twbx. Omit it, or send an empty value, to save in place.

Responses

Request samples

Content type
application/json
{
  • "filePath": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

Undo the last change

Reverses the most recent change to the open workbook, equivalent to Edit > Undo.

Authorizations:
bearerAuth
header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

List worksheets

Lists the worksheets contained in the open workbook.

Authorizations:
bearerAuth
header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "worksheets": [
    ]
}

Get a worksheet

Returns the metadata for a single worksheet in the open workbook identified by its id.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "id": "string",
  • "name": "string",
  • "hidden": true,
  • "isActiveSheet": true,
  • "index": 0,
  • "isAutoUpdatesPaused": true,
  • "datasources": [
    ]
}

Get worksheet diagnostics

Checks the fields used on the worksheet and reports any that are invalid. This check does not run the query.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "worksheets": [
    ]
}

Get a worksheet document

Returns the worksheet as Tableau XML.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

header Parameters
X-Tableau-Effective-Payload-Version
string

Reserved. The server accepts the header and ignores it. Documents use the running product version.

User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

Apply a worksheet document

Replaces this worksheet with the submitted Tableau XML and leaves other sheets unchanged. The XML is checked only to confirm it is well formed, and it overwrites a concurrent edit of the same sheet.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

header Parameters
X-Tableau-Effective-Payload-Version
string

Reserved. The server accepts the header and ignores it. Documents use the running product version.

User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Request Body schema:
required

Tableau XML for this worksheet, alone or wrapped in a workbook. Other sheets in the file are ignored. The worksheet must use datasources already in the open workbook.

string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

Export a worksheet image

Renders a single worksheet (resolved by id) as an image, returned inline as base64 or written to a caller-supplied file path.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

query Parameters
filePath
string

Path to write the image to. Must be absolute and name a file; a directory, a trailing slash, or any '.'/'..' path segment is rejected with a 400. When set, the response projects this path instead of inline base64; when omitted, the image is returned as base64.

mimeType
string

Requested image MIME type (e.g. image/png, image/jpeg). The effective type is returned in the response.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "filePath": "string",
  • "effectiveMimeType": "string",
  • "width": 0,
  • "height": 0
}

List worksheet logical tables

Lists the logical table ids and captions available for a worksheet's underlying data.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "tables": [
    ]
}

Get worksheet underlying data

Returns the underlying data for one logical table of a worksheet as JSON.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

logicalTableId
required
string

Id of the logical table. Use single-table-id-sentinel when there is only one table.

query Parameters
maxRows
integer

Maximum number of rows to return.

ignoreAliases
boolean

Ignored. Cell values are always the raw values.

ignoreSelection
boolean

True to return all rows instead of the current selection.

includeAllColumns
boolean

True to include every column. Defaults to true.

columnsToIncludeByFieldName
Array of strings

Field names that limit which columns are returned.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "columns": [
    ],
  • "rows": [
    ]
}

List worksheet Show Me options

Returns the Show Me choices for the worksheet, and whether each choice applies.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

query Parameters
dataSource
string

Internal datasource name used to judge the Show Me options.

fieldsSelectedInSchemaViewer
Array of strings

Field names used to judge the Show Me options. Repeat this parameter to keep their order.

selectionMode
string
Enum: "ambient" "explicit"

How fields are selected. ambient uses the current selection. explicit uses the supplied fields.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "worksheet": {
    },
  • "options": [
    ]
}

Get worksheet summary data

Returns the worksheet's summary data as rows and columns.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

query Parameters
maxRows
integer

Maximum number of rows to return.

ignoreAliases
boolean

Ignored. Cell values are always the raw values.

ignoreSelection
boolean

True to return all rows instead of the current selection.

columnsToIncludeByFieldName
Array of strings

Field names that limit which columns are returned.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "columns": [
    ],
  • "rows": [
    ]
}

Delete a worksheet

Deletes a single worksheet by id. Deleting the workbook's last visible sheet is a no-op.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

Pause worksheet auto-updates

Pauses automatic query execution for a worksheet so several edits can be batched before the next refresh.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

Refresh worksheet now

Refreshes the worksheet without changing the active sheet.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

Reload worksheet extension

Reloads the extension on the worksheet. Succeeds with nothing to do when the worksheet has no extension.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

Rename a worksheet

Renames a worksheet identified by id.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Request Body schema: application/json
required
name
required
string

The new name of the sheet.

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

Resume worksheet auto-updates

Resumes automatic query execution for a worksheet.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

Apply Show Me to a worksheet

Applies a concrete Show Me visualization type to a worksheet using optional datasource and fully qualified selected-field context.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Request Body schema: application/json
required
showMeType
required
string (ShowMeType)
Enum: "text" "heat" "spot-table" "bar-horiz" "bar-stack" "bar-side" "bar-measure" "o-line" "qi-line" "o-area" "qi-area" "circle" "circle-side" "gantt" "scatter" "scatter-matrix" "histogram" "maps" "filled-maps" "pies" "dual-bar-line" "dual-line" "bullet" "treemap" "bubble" "box-plot"

Show Me type to apply.

dataSource
string

Optional internal datasource name used to resolve selected fields.

fieldsSelectedInSchemaViewer
Array of strings

Optional fully qualified encoded field names, each with at least a datasource and field component. An explicit empty array supplies an empty field selection; omission preserves ambient selection.

Responses

Request samples

Content type
application/json
{
  • "showMeType": "text",
  • "dataSource": "string",
  • "fieldsSelectedInSchemaViewer": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

Sort a worksheet

Applies a sort by field, direction, and type to a worksheet without opening the sort dialog.

Authorizations:
bearerAuth
path Parameters
id
required
string

The resource's stable id as returned in its list or GET response, not its display name or caption.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Request Body schema: application/json
required
fieldName
required
string

Field to sort, as [Datasource caption].[field instance]. The plain column name does not match.

direction
string
Enum: "asc" "desc"

Sort direction; defaults to 'asc' when omitted. Only the listed values are accepted; any other value is rejected with a 400.

sortType
string
Enum: "data-source-order" "alpha"

Sort type; defaults to 'data-source-order' when omitted. Only the listed values are accepted; any other value is rejected with a 400.

clearSort
boolean

True to remove the current sort instead of applying one.

Responses

Request samples

Content type
application/json
{
  • "fieldName": "string",
  • "direction": "asc",
  • "sortType": "data-source-order",
  • "clearSort": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}

Add a blank worksheet

Creates a single blank worksheet with a generated name. Any request body is ignored.

Authorizations:
bearerAuth
query Parameters
index
integer

Tab position for the new sheet, starting at 0. Omit it to add the sheet at the end.

header Parameters
User-Agent
required
string

Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "string",
  • "state": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "completedAt": "string",
  • "uiSnapshotAvailable": true,
  • "error": {
    },
  • "result": {
    },
  • "diagnostics": {
    },
  • "warnings": [
    ],
  • "blockingWindows": [
    ],
  • "progressWindows": [
    ]
}