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.
The External Client API Guide provides an overview of the External Client API and:
With Application operations, you can:
Returns information about the running Tableau Studio process, including its version, edition, build, operating system, locale, and repository and log paths.
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "applicationVersion": "string",
- "edition": "string",
- "build": "string",
- "os": "string",
- "locale": "string",
- "repositoryLocation": "string",
- "logLocation": "string",
- "isStartPageVisible": true,
- "isDataSourcePageActive": true,
- "isPresentationMode": true,
- "isCanvasMode": true
}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.
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "dialogs": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "uiSnapshotAvailable": true,
- "recentActions": [
- {
- "sessionId": "string",
- "revision": 0,
- "requestId": "string",
- "state": "pending",
- "effect": "none",
- "code": "string",
- "expiresInMilliseconds": 0
}
]
}Returns workspace extensions installed for this user, including disabled ones. Each entry has a stable id for the reload operation.
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "extensions": [
- {
- "id": "string",
- "extensionKey": {
- "id": "string",
- "version": "string",
- "url": "string"
}, - "name": "string",
- "author": "string",
- "isEnabled": true
}
]
}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.
| id required | string The workspace extension's id, as returned by GET /v0/app/extensions. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}Saves a PNG of each open Studio window to the given directory and returns the file paths.
| outputPath required | string Absolute directory where the screenshots are written. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "filePaths": [
- "string"
]
}Returns whether Studio is idle or blocked, and which dialogs or activities are in the way.
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "state": "string",
- "blockedBy": "string",
- "uiSnapshotAvailable": true,
- "activeActivities": [
- "string"
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}Runs one action on an active dialog. Copy the dialog identity from the dialog list, and send a new request id for each attempt.
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
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) |
{- "dialog": {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 9223372036854776000
}, - "requestId": "string",
- "action": {
- "kind": "button",
- "label": "string"
}
}{- "outcome": "dispatched-pending",
- "dialog": {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 9223372036854776000
}, - "status": {
- "sessionId": "string",
- "revision": 0,
- "requestId": "string",
- "state": "pending",
- "effect": "none",
- "code": "string",
- "expiresInMilliseconds": 0
}, - "uiSnapshotAvailable": true,
- "dialogs": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}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.
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
| filePath required | string The absolute path of the local file to open. |
{- "filePath": "string"
}{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}Sets whether the Data Source page is the active tab. Sending the same state again changes nothing.
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
| isDataSourcePageActive required | boolean True to show the Data Source page. |
{- "isDataSourcePageActive": true
}{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}Sets whether the Tableau Studio start page is visible and returns the resulting visibility. Repeated requests for the same visibility have no additional effect.
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
| isStartPageVisible required | boolean True when the start page is visible. |
{- "isStartPageVisible": true
}{- "isStartPageVisible": true
}With Dashboards operations, you can:
Lists the dashboards contained in the open workbook.
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "dashboards": [
- {
- "type": "string",
- "id": "string",
- "name": "string",
- "hidden": true,
- "isActiveSheet": true,
- "index": 0,
- "isAutoUpdatesPaused": true,
- "containedSheets": [
- "string"
]
}
]
}Returns the metadata for a single dashboard in the open workbook identified by its id.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "type": "string",
- "id": "string",
- "name": "string",
- "hidden": true,
- "isActiveSheet": true,
- "index": 0,
- "isAutoUpdatesPaused": true,
- "containedSheets": [
- "string"
]
}Returns the dashboard as Tableau XML.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| 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. |
{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}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.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| 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. |
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.
{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}Renders a single dashboard (resolved by id) as an image, returned inline as base64 or written to a caller-supplied file path.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| 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. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "filePath": "string",
- "effectiveMimeType": "string",
- "width": 0,
- "height": 0
}Deletes a single dashboard by id. Deleting the workbook's last visible sheet is a no-op.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}Pauses automatic query execution for a dashboard so several edits can be batched before the next refresh.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}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.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string",
- "outcome": "COMPLETE",
- "refreshed": [
- {
- "worksheetId": "string",
- "worksheetName": "string"
}
], - "failed": [
- {
- "worksheetId": "string",
- "worksheetName": "string",
- "code": "string",
- "message": "string"
}
]
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}Reloads every extension on the dashboard. Succeeds with nothing to do when the dashboard has no extension.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}Renames a dashboard identified by id.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
| name required | string The new name of the sheet. |
{- "name": "string"
}{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}Resumes automatic query execution for a dashboard.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}Creates a single blank dashboard with a generated name. Any request body is ignored.
| index | integer Tab position for the new sheet, starting at 0. Omit it to add the sheet at the end. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}With Datasources operations, you can:
Refreshes live data for the datasource named by id. This does not refresh an extract. A datasource with nothing to refresh finishes successfully.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}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.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
| isFullRefresh | boolean Force a full refresh instead of an incremental one. Defaults to false: incremental when the extract supports it, otherwise a full refresh. |
{- "isFullRefresh": true
}{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}With Operations, you can:
Lists in-flight and recently-completed async operations.
| 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. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "operations": [
- {
- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "uiSnapshotAvailable": true
}Polls a single async operation by id until it reaches a terminal state.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}With Service operations, you can:
Returns the API and application version strings together with a link map that points to the available top-level resources.
{- "apiVersion": "string",
- "applicationVersion": "string",
- "links": {
- "property1": "string",
- "property2": "string"
}
}Returns the operations this API version supports, and whether each one needs a signed-in server.
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "capabilities": {
- "property1": {
- "requiresServer": true
}, - "property2": {
- "requiresServer": true
}
}
}Lists the storyboards contained in the open workbook.
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "storyboards": [
- {
- "type": "string",
- "id": "string",
- "name": "string",
- "hidden": true,
- "isActiveSheet": true,
- "index": 0,
- "storyPointCount": 0
}
]
}Returns the metadata for a single storyboard in the open workbook identified by its id.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "type": "string",
- "id": "string",
- "name": "string",
- "hidden": true,
- "isActiveSheet": true,
- "index": 0,
- "storyPointCount": 0
}Returns the storyboard as Tableau XML.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| 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. |
{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}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.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| 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. |
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.
{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}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.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| 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. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "filePath": "string",
- "effectiveMimeType": "string",
- "width": 0,
- "height": 0
}Deletes a single storyboard by id. Deleting the workbook's last visible sheet is a no-op.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}Refreshes the current story point without changing the active sheet or story point. A worksheet that fails does not undo the ones that succeeded.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string",
- "outcome": "COMPLETE",
- "refreshed": [
- {
- "worksheetId": "string",
- "worksheetName": "string"
}
], - "failed": [
- {
- "worksheetId": "string",
- "worksheetName": "string",
- "code": "string",
- "message": "string"
}
]
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}Renames a storyboard identified by id.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
| name required | string The new name of the sheet. |
{- "name": "string"
}{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}Creates a single blank storyboard with a generated name. Any request body is ignored.
| index | integer Tab position for the new sheet, starting at 0. Omit it to add the sheet at the end. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}With Workbook operations, you can:
Returns the metadata and sheet inventory of the workbook currently open in Tableau Studio, or a 404 response when no workbook is open.
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "title": "string",
- "location": "string",
- "unsavedChanges": true,
- "worksheets": [
- {
- "type": "string",
- "id": "string",
- "name": "string",
- "hidden": true,
- "isActiveSheet": true,
- "index": 0,
- "isAutoUpdatesPaused": true,
- "datasources": [
- "string"
]
}
], - "dashboards": [
- {
- "type": "string",
- "id": "string",
- "name": "string",
- "hidden": true,
- "isActiveSheet": true,
- "index": 0,
- "isAutoUpdatesPaused": true,
- "containedSheets": [
- "string"
]
}
], - "storyboards": [
- {
- "type": "string",
- "id": "string",
- "name": "string",
- "hidden": true,
- "isActiveSheet": true,
- "index": 0,
- "storyPointCount": 0
}
]
}Lists the datasources that the open workbook uses.
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "datasources": [
- {
- "type": "string",
- "id": "string",
- "luid": "string",
- "name": "string",
- "caption": "string",
- "isExtract": true,
- "hasDownloadFilePermission": true
}
]
}Returns metadata for a single datasource by its URL-encoded inventory id.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "type": "string",
- "id": "string",
- "luid": "string",
- "name": "string",
- "caption": "string",
- "isExtract": true,
- "hasDownloadFilePermission": true
}Returns the datasource as Tableau XML.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| 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. |
{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}Replaces this datasource with the submitted Tableau XML and leaves other datasources and sheets unchanged. The XML must contain that one datasource.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| 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. |
Tableau XML for this datasource. The file must contain exactly one datasource, and its internal name must match the id.
{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}Returns the logical tables in the datasource, with each table's id and caption.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "tables": [
- {
- "id": "string",
- "caption": "string"
}
]
}Returns rows from one logical table in the datasource.
| 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. |
| maxRows | integer Maximum number of rows to return. |
| columnsToIncludeByFieldName | Array of strings Field names that limit which columns are returned. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "columns": [
- {
- "name": "string",
- "dataType": "string"
}
], - "rows": [
- [
- 0
]
]
}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.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
| 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. |
{- "formula": "string",
- "caption": "string",
- "fieldName": "string"
}{- "isValid": true,
- "errors": [
- {
- "position": 0,
- "length": 0,
- "message": "string"
}
], - "isAggregate": true,
- "dataType": "string"
}Checks the fields used on each worksheet and reports any that are invalid. This check does not run the query.
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}Returns the open workbook as Tableau XML.
| 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. |
{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}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.
| 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. |
The workbook as Tableau XML.
{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}Checks the submitted Tableau XML and reports problems without changing the open workbook.
| 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. |
The workbook as Tableau XML.
{- "isValid": true,
- "issues": [
- {
- "severity": "string",
- "message": "string",
- "line": 0,
- "column": 0,
- "element": "string"
}
]
}Returns the extensions placed on sheets in the open workbook.
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "extensions": [
- {
- "instanceId": "string",
- "sheet": {
- "id": "string",
- "kind": "worksheet"
}, - "extension": {
- "id": "string",
- "version": "string",
- "url": "string"
}, - "packagePath": "string"
}
]
}Closes the open workbook. Studio asks to save when there are unsaved changes.
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}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.
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
| 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. |
{- "filePath": "string",
- "format": "pdf",
- "targetVersion": "string"
}{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}Makes the identified worksheet, dashboard, or storyboard the active sheet.
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
| id required | string The identifier of the sheet to activate. |
{- "id": "string"
}{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}Reapplies the change most recently undone on the open workbook, equivalent to Edit > Redo.
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}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.
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
| 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. |
{- "filePath": "string"
}{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}Reverses the most recent change to the open workbook, equivalent to Edit > Undo.
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}With Worksheets operations, you can:
Lists the worksheets contained in the open workbook.
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "worksheets": [
- {
- "type": "string",
- "id": "string",
- "name": "string",
- "hidden": true,
- "isActiveSheet": true,
- "index": 0,
- "isAutoUpdatesPaused": true,
- "datasources": [
- "string"
]
}
]
}Returns the metadata for a single worksheet in the open workbook identified by its id.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "type": "string",
- "id": "string",
- "name": "string",
- "hidden": true,
- "isActiveSheet": true,
- "index": 0,
- "isAutoUpdatesPaused": true,
- "datasources": [
- "string"
]
}Checks the fields used on the worksheet and reports any that are invalid. This check does not run the query.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}Returns the worksheet as Tableau XML.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| 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. |
{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}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.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| 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. |
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.
{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}Renders a single worksheet (resolved by id) as an image, returned inline as base64 or written to a caller-supplied file path.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| 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. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "filePath": "string",
- "effectiveMimeType": "string",
- "width": 0,
- "height": 0
}Lists the logical table ids and captions available for a worksheet's underlying data.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "tables": [
- {
- "id": "string",
- "caption": "string"
}
]
}Returns the underlying data for one logical table of a worksheet as JSON.
| 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. |
| 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. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "columns": [
- {
- "name": "string",
- "dataType": "string"
}
], - "rows": [
- [
- 0
]
]
}Returns the Show Me choices for the worksheet, and whether each choice applies.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| 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. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "worksheet": {
- "id": "string",
- "name": "string"
}, - "options": [
- {
- "showMeType": "text",
- "isApplicable": true,
- "vizHasRequiredFields": true,
- "dataSourceHasRequiredFields": true,
- "helpUrl": "string"
}
]
}Returns the worksheet's summary data as rows and columns.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| 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. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "columns": [
- {
- "name": "string",
- "dataType": "string"
}
], - "rows": [
- [
- 0
]
]
}Deletes a single worksheet by id. Deleting the workbook's last visible sheet is a no-op.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}Pauses automatic query execution for a worksheet so several edits can be batched before the next refresh.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}Refreshes the worksheet without changing the active sheet.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}Reloads the extension on the worksheet. Succeeds with nothing to do when the worksheet has no extension.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}Renames a worksheet identified by id.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
| name required | string The new name of the sheet. |
{- "name": "string"
}{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}Resumes automatic query execution for a worksheet.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}Applies a concrete Show Me visualization type to a worksheet using optional datasource and fully qualified selected-field context.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
| 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. |
{- "showMeType": "text",
- "dataSource": "string",
- "fieldsSelectedInSchemaViewer": [
- "string"
]
}{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}Applies a sort by field, direction, and type to a worksheet without opening the sort dialog.
| id required | string The resource's stable id as returned in its list or GET response, not its display name or caption. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
| 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. |
{- "fieldName": "string",
- "direction": "asc",
- "sortType": "data-source-order",
- "clearSort": true
}{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}Creates a single blank worksheet with a generated name. Any request body is ignored.
| index | integer Tab position for the new sheet, starting at 0. Omit it to add the sheet at the end. |
| User-Agent required | string Names the calling client, for example my-client/1.2.0. A missing or empty value is rejected. |
{- "id": "string",
- "kind": "string",
- "state": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "completedAt": "string",
- "uiSnapshotAvailable": true,
- "error": {
- "code": "string",
- "message": "string",
- "tableauErrorCode": "string"
}, - "result": {
- "document": "string",
- "payloadVersion": "string"
}, - "diagnostics": {
- "worksheets": [
- {
- "worksheetId": "string",
- "status": "complete",
- "invalidFields": [
- {
- "fieldName": "string",
- "fieldCaption": "string",
- "shelf": "string",
- "marksSpecificationId": "string",
- "encodingType": "string",
- "reason": "string"
}
], - "message": "string"
}
]
}, - "warnings": [
- {
- "code": "string",
- "message": "string"
}
], - "blockingWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
], - "progressWindows": [
- {
- "objectName": "string",
- "title": "string",
- "className": "string",
- "sessionId": "string",
- "revision": 0,
- "family": "qt",
- "mode": "string",
- "status": "preparing",
- "messageText": "string",
- "informativeText": "string",
- "detailedText": "string",
- "detailedTextTruncated": true,
- "iconLevel": "string",
- "buttons": [
- "string"
], - "actions": [
- {
- "kind": "button",
- "label": "string",
- "enabled": true,
- "filters": [ ],
- "selectedFilterId": "string",
- "defaultFilterId": "string",
- "minimumPaths": 0,
- "maximumPaths": 0,
- "overwriteConfirmationRequired": true,
- "alphaSupported": true,
- "printers": [ ],
- "minimumPage": 0,
- "maximumPage": 0,
- "minimumCopies": 0,
- "maximumCopies": 0,
- "ranges": [ ],
- "sheetScopes": [ ],
- "supportsCollation": true,
- "supportsPrintToFile": true,
- "supportsExportSelection": true
}
]
}
]
}