若要作為連鎖的一部分與 Tableau® 互動,請新增包含 Tableau 連線指令的步驟。例如:
- 自動化 Tableau 並將其與一系列資料來源連接,包括 Anaplan®、Oracle® HFM 和 IBM Cognos® Planning Analytics Cloud (TM1)
- 動態刷新舊版和新版報表,整合終端使用者存取管理,同時支援雲端版和內部部署版的 Tableau
若要啟用這些指令,IT 管理員首先建立 Tableau 連結器 。該連線可與這些版本 Tableau 的內部部署和雲端部署互動:
- 8.3
- 9.x
- 10.x
- 2018.x
- 2019.x
- 2020.x
- Tableau Online®
將使用者加入群組
要將使用者加入指定的群組,請使用Add User to Group 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 群組 ID |
輸入要新增使用者的群組 ID |
| 使用者識別碼 |
輸入要新增使用者的 ID -而非 名稱 |
输出
| 輸出 |
輸出類型 |
| 使用者 |
JSON |
| 使用者識別碼 |
字串 |
| 使用者名稱 |
字串 |
| 使用者網站角色 |
字串 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 214 |
錯誤 |
請求正文中的群組名稱與現有群組不符 |
| 240 |
警告 |
指定的使用者已經是該群組的成員 |
將使用者新增至網站
要将用户添加到 Tableau Server 并将其分配到指定站点,请使用Add User to Site 命令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 使用者名稱 |
輸入使用者名稱。如果 Tableau 伺服器使用本機驗證,您可以使用任何名稱;如果使用 Active Directory (AD) 驗證,請使用 AD 中現有使用者的名稱。如果不同網域的使用者名稱不唯一,請包含網域,例如domain\Adam 或adam@domain.com 。 |
| 角色 |
選擇要指派給使用者的網站角色:創造者、探索者、探索者可發表、僅限閱讀、SiteAdministratorExplorer、SiteAdministratorCreator、未授權或檢視者 |
| 驗證類型 |
選擇是否透過安全聲明標記語言 (SAML) 或 ServerDefault 驗證使用者。 注意: 在 Tableau Online 中,这些值显示在设置页面上的身份验证 选项卡中-SAML 对应于单点登录 (SSO);ServerDefault 为 TableauID。 |
输出
| 輸出 |
輸出類型 |
| 使用者 |
JSON |
| 使用者識別碼 |
字串 |
| 使用者名稱 |
字串 |
| 使用者網站角色 |
字串 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 204 |
錯誤 |
伺服器設定為使用活動目錄驗證,且請求體中指定的使用者名稱與 AD 中的使用者不匹配 |
| 229 |
錯誤 |
指定的用戶已經存在於網站中 |
| 234 |
錯誤 |
Tabeleau 服务器 API 不允许在网站上添加访客角色的用户 |
建立 Hyper Extract
要從逗號分隔值 (CSV) 檔案建立 Hyper Extract,請使用Build Hyper Extract 指令。
注意: 要在 GroundRunner 上使用此命令,,在其服务器上安装 Tableau Extract API ,并将其动态链接库 (DLL) 文件移动到注册表使用的文件夹,如C:\Windows\System32 。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 來源 CSV 檔案 |
輸入用於建立 Hyper 檔案中資料的檔案。 |
| 檔案格式 |
選擇 CSV 檔案的格式。 |
| 資料欄類型 |
輸入 CSV 檔案中每一列的 Tableau 列類型:INTEGER,DOUBLE,BOOLEAN,DATE,DATETIME,DURATION,CHAR_STRING,UNICODE_STRING, 或SPATIAL 。 |
输出
| 輸出 |
輸出類型 |
| 超級檔案 |
檔案 |
| 超文件大小 |
整數 |
| 已處理記錄 |
整數 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 4 |
錯誤 |
建立 Extact 時發生一般錯誤 |
| 5 |
錯誤 |
無法找到 CSV 輸入檔案 |
| 6 |
錯誤 |
CSV 檔案格式不正確,或指定了錯誤的檔案格式 |
| 11 |
錯誤 |
列類型的數量與 CSV 中標頭列的數量不匹配 |
| 12 |
錯誤 |
無效列類型 |
建立 TDE 擷取
要從 CSV 檔案建立 Tableau Desktop (TDE) 檔案,請使用Build TDE Extract 指令。
注意: 要在 GroundRunner 上使用此命令,在其服务器上安装 Tableau Extract API ,并将其 DLL 文件移动到注册表使用的文件夹中,如C:\Windows\System32 。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 來源 CSV 檔案 |
輸入用於建立 TDE 檔案中資料的檔案。 |
| 檔案格式 |
選擇 CSV 檔案的格式。 |
| 資料欄類型 |
輸入 CSV 檔案中每一列的 Tableau 列類型:INTEGER,DOUBLE,BOOLEAN,DATE,DATETIME,DURATION,CHAR_STRING,UNICODE_STRING, 或SPATIAL 。 |
输出
| 輸出 |
輸出類型 |
| TDE 檔案 |
檔案 |
| TDE 檔案大小 |
整數 |
| 已處理記錄 |
整數 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 4 |
錯誤 |
建立 Extact 時發生一般錯誤 |
| 5 |
錯誤 |
無法找到 CSV 輸入檔案 |
| 6 |
錯誤 |
CSV 檔案格式不正確,或指定了錯誤的檔案格式 |
| 11 |
錯誤 |
列類型的數量與 CSV 中標頭列的數量不匹配 |
| 12 |
錯誤 |
無效列類型 |
大量刪除預設權限
要刪除以 CSV 檔案為資料來源的使用者或群組工作簿或資料來源的預設權限,請使用Bulk Delete Default Permissions 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 來源資料 |
以符合 RFC-4180 標準的 CSV 檔輸入大量更新的來源資料。 |
| 使用者或群組 |
選擇來源資料是「使用者」或「群組」清單。 |
| 資源類型 |
選擇要設定預設權限的資源類型:工作簿或資料來源。 |
| 專案 ID |
輸入要更新的專案 ID。 |
输出
無
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 137 |
錯誤 |
使用者嘗試新增權限到資料來源,但呼叫者沒有權限設定資料來源的權限 |
| 204 |
錯誤 |
請求體中指定的使用者與現有使用者不符 |
| 214 |
錯誤 |
請求體中指定的群組與現有群組不一致 |
| 215 |
錯誤 |
請求體中指定的能力與定義的能力不符。這可能適用於無效的能力名稱,或任何模式值的允許或拒絕以外的能力。 |
大量刪除權限
若要刪除以 CSV 檔案為資料來源的多個使用者或群組的資料來源、工作簿或專案的權限,請使用Bulk Delete Permissions 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 來源資料 |
以符合 RFC-4180 標準的 CSV 檔輸入大量更新的來源資料。 |
| 使用者或群組 |
選擇來源資料是「使用者」或「群組」清單。 |
| 資源類型 |
選擇要設定預設權限的資源類型 - 工作簿、資料來源或專案。 |
| 專案 ID |
輸入要更新的資料來源、工作簿或專案的 ID。 |
输出
無
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 137 |
錯誤 |
使用者嘗試新增權限到資料來源,但呼叫者沒有權限設定資料來源的權限 |
| 204 |
錯誤 |
請求正文中指定的使用者與現有使用者不符 |
| 206 |
錯誤 |
資料來源 ID 與現有資料來源不符 |
| 207 |
錯誤 |
專案 ID 與現有專案不符 |
| 208 |
錯誤 |
工作簿 ID 與現有工作簿不一致 |
| 214 |
錯誤 |
請求體中指定的群組與現有群組不一致 |
| 215 |
錯誤 |
請求體中指定的能力與定義的能力不符。這可能適用於無效的功能名稱,或任何模式值的 Allow 或 Deny 以外的功能。 |
大量更新預設權限
要更新以 CSV 檔案為資料來源的使用者或群組工作簿或資料來源的預設權限,請使用Bulk Update Default Permissions 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 來源資料 |
以符合 RFC-4180 標準的 CSV 檔輸入大量更新的來源資料。 |
| 使用者或群組 |
選擇來源資料是「使用者」或「群組」清單。 |
| 資源類型 |
選擇要設定預設權限的資源類型:工作簿或資料來源。 |
| 專案 ID |
輸入要更新的專案 ID。 |
输出
無
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 137 |
錯誤 |
使用者嘗試新增權限到資料來源,但呼叫者沒有權限設定資料來源的權限 |
| 204 |
錯誤 |
請求體中指定的使用者與現有使用者不符 |
| 214 |
錯誤 |
請求體中指定的群組與現有群組不一致 |
| 215 |
錯誤 |
請求體中指定的能力與定義的能力不符。這可能適用於無效的能力名稱,或任何模式值的 Allow 或 Deny 以外的能力。 |
大量更新權限
若要更新以 CSV 檔案為資料來源的多個使用者或群組的資料來源、工作簿或專案的權限,請使用Bulk Update Permissions 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 來源資料 |
以符合 RFC-4180 標準的 CSV 檔輸入大量更新的來源資料。 |
| 使用者或群組 |
選擇來源資料是「使用者」或「群組」清單。 |
| 資源類型 |
選擇要設定預設權限的資源類型 - 工作簿、資料來源或專案 |
| 專案 ID |
輸入要更新的資料來源、工作簿或專案的 ID。 |
输出
無
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 137 |
錯誤 |
使用者嘗試新增權限到資料來源,但呼叫者沒有權限設定資料來源的權限 |
| 204 |
錯誤 |
請求正文中指定的使用者與現有使用者不符 |
| 206 |
錯誤 |
資料來源 ID 與現有資料來源不符 |
| 207 |
錯誤 |
專案 ID 與現有專案不符 |
| 208 |
錯誤 |
工作簿 ID 與現有工作簿不一致 |
| 214 |
錯誤 |
請求體中指定的群組與現有群組不一致 |
| 215 |
錯誤 |
請求體中指定的能力與定義的能力不符。這可能適用於無效的能力名稱,或任何模式值的 Allow 或 Deny 以外的能力。 |
建立群組
若要在 Tableau 中建立群組,請使用Create Group 指令。
摘要資訊
输出
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 238 |
警告 |
具有指定名稱的群組已存在 |
建立專案
若要在 Tableau 中建立專案,請使用Create Project 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 專案名稱 |
輸入新專案的名稱。 |
| 說明 |
輸入新專案的描述(選填)。 |
| 父專案 ID |
若要建立專案層級,請輸入父專案的識別碼 (選用)。 |
| 管理員模式 |
選擇使用者的權限管理層級。
- 若要鎖定權限,使使用者無法覆寫專案的預設權限設定,請選取 LockedToProject。
- 若要啟用使用者管理其擁有內容的權限,請選擇 ManagedByOwner。
|
| 使用樣本 |
要將 Tableau 提供的範例工作簿發佈到專案,請勾選此方塊。 |
输出
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 141 |
錯誤 |
無法發佈樣本,因為伺服器上的儲存空間不足 |
| 235 |
錯誤 |
請求中的專案名稱已屬於指定的網站。為確保唯一性,專案名稱不區分大小寫。 |
建立網站
若要在 Tableau 中建立網站,請使用Create Site 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 網站名稱 |
輸入新網站的名稱。 |
| 內容 URL |
輸入網站的 URL,僅包含 URL 中有效的字元。 |
| 管理員模式 |
選擇管理員的網站存取層級 (選用):
- 若要讓網站管理員使用伺服器介面和 TABCMD 指令 - 但而非 REST API - 來新增和移除使用者,請選擇 ContentAndUsers。
- 若要阻止網站管理員新增或移除使用者,請選擇「僅限內容」。
注意: 伺服器管理員總是可以新增或移除使用者。 |
| 啟用訂閱 |
若要阻止使用者訂閱網站中的工作簿,請勾選此方塊。 |
输出
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法使用 Tableau 進行驗證 |
| 50 |
錯誤 |
儲存空間或使用者配額值不是正數 |
| 63 |
錯誤 |
使用者提供的管理員模式不是「僅限內容」或「內容使用者」模式 |
| 230 |
錯誤 |
請求中的網站名稱已屬於現有網站 |
| 231 |
錯誤 |
請求中的內容 URI 已屬於現有網站 |
刪除資料源
要從 Tableau 網站刪除 Datasource,請使用Delete Datasource 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 資料來源 ID |
輸入要刪除的資料來源 ID。 |
输出
無
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 213 |
警告 |
找不到資料來源 |
刪除群組
若要從 Tableau 網站刪除群組,請使用Delete Group 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 群組 ID |
輸入要刪除群組的 ID。 |
输出
無
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 214 |
警告 |
找不到群組 |
刪除專案?
若要從 Tableau 網站刪除專案,請使用Delete Project 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 專案 ID |
輸入要刪除專案的 ID。 |
输出
無
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 207 |
警告 |
找不到專案 |
刪除工作簿
若要從 Tableau 網站刪除工作簿,請使用Delete Workbook 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 工作簿 ID |
輸入要刪除工作簿的 ID。 |
输出
無
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 208 |
警告 |
找不到工作簿 |
下載資料來源
若要從 Tableau 下載資料來源,請使用Download Datasource 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 資料來源 ID |
輸入要下載的資料來源 ID。 |
| 包含摘要 |
若要在下載的檔案中包含資料來源的摘要,請勾選此方塊。 |
输出
| 輸出 |
輸出類型 |
| 資料來源檔案 |
檔案 |
| 檔案大小 |
整數 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 206 |
錯誤 |
找不到資料來源 |
下載檢視資料
要以 CSV 格式傳回指定檢視的資料,請使用Download View Data 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 檢視 ID |
輸入要渲染為資料的檢視的 ID。 |
输出
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 165 |
錯誤 |
非管理員使用者嘗試查詢工作簿檢視,但呼叫者沒有讀取權限 |
下載檢視影像
若要傳回以 PNG 格式渲染的指定檢視影像,請使用Download View Image 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 檢視 ID |
輸入要渲染為影像的檢視 ID。 |
输出
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 201 |
錯誤 |
端點已在伺服器上停用。若要啟用端點,伺服器管理員必須使用tabadmin 來設定sheet_image.enabled 設定。 |
下載檢視 PDF
若要傳回以可攜式文件格式 (PDF) 檔案呈現的指定檢視,請使用Download View PDF 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 檢視 ID |
輸入要渲染為 PDF 的檢視的 ID。 |
输出
| 輸出 |
輸出類型 |
| 檢視 PDF |
檔案 |
| 檔案大小 |
整數 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 165 |
錯誤 |
非管理員使用者嘗試查詢工作簿檢視,但呼叫者沒有讀取權限 |
下載工作簿
若要從 Tableau 下載工作簿,請使用Download Workbook 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 工作簿 ID |
輸入要下載的工作簿 ID |
| 包含摘要 |
若要在下載的檔案中包含工作簿的摘要,請勾選此方塊 |
输出
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 208 |
錯誤 |
找不到指定的工作簿 |
取得資料來源
要擷取 Datasource 的詳細資訊,請使用Get Datasource 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 資料來源 ID |
輸入要擷取詳細資訊的資料來源 ID |
输出
| 輸出 |
輸出類型 |
| DataSource |
JSON |
| 資料來源 ID |
字串 |
| 資料來源名稱 |
字串 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 206 |
錯誤 |
URI 中的資料來源 ID 與現有資料來源不符 |
取得資料來源連線
要擷取與資料來源關聯的連線清單,請使用Get Datasource Connections 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 資料來源 ID |
輸入要擷取連線的資料來源 ID。 |
输出
| 輸出 |
輸出類型 |
| 連線清單 |
JSON |
| 連線 ID |
陣列 |
| 連線名稱 |
陣列 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 213 |
錯誤 |
URI 中的資料來源 ID 與現有資料來源不符 |
取得資料來源
若要擷取連線器的整合使用者可以存取的資料來源清單,請使用Get Datasources 指令。
摘要資訊
無
输出
| 輸出 |
輸出類型 |
| 資料來源清單 |
JSON |
| 資料來源 ID |
陣列 |
| 資料來源名稱 |
陣列 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 10 |
警告 |
未找到資料來源 |
| 56 |
錯誤 |
頁碼參數不是整數,小於 1,或大於所要求頁面大小的資料來源最終頁數 |
| 57 |
錯誤 |
頁數大小不是整數,或小於 1 |
| 147 |
錯誤 |
指定的頁面大小大於最大頁面大小 |
取得群組
要檢索連接器的整合使用者可以存取的群組清單,請使用Get Groups 指令。
摘要資訊
無
输出
| 輸出 |
輸出類型 |
| 群組清單 |
JSON |
| 群組 ID |
陣列 |
| 群組名稱 |
陣列 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 10 |
警告 |
未找到資料來源 |
| 56 |
錯誤 |
頁碼參數不是整數,小於 1,或大於所要求頁面大小的資料來源最終頁數 |
| 57 |
錯誤 |
頁面大小參數不是整數,或小於 1 |
| 147 |
錯誤 |
指定的頁面大小大於最大頁面大小 |
取得專案
要檢索連接器的整合使用者可以存取的專案清單,請使用Get Projects 指令。
摘要資訊
無
输出
| 輸出 |
輸出類型 |
| 專案清單 |
JSON |
| 專案 ID |
陣列 |
| 專案名稱 |
陣列 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 10 |
警告 |
未找到資料來源 |
| 56 |
錯誤 |
頁碼參數不是整數,小於 1,或大於所要求頁面大小的資料來源最終頁數 |
| 57 |
錯誤 |
頁面大小參數不是整數,或小於 1 |
| 147 |
錯誤 |
指定的頁面大小大於最大頁面大小 |
取得伺服器資訊
若要擷取您 Tableau 伺服器的 API 版本和產品建置,請使用Get Server Info 指令。
摘要資訊
無
输出
| 輸出 |
輸出類型 |
| REST API 版本 |
字串 |
| 產品建立 |
字串 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法使用 Tableau 進行驗證 |
取得網站資訊
若要擷取網站資訊,請使用Get Site Info 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 網站 ID |
輸入要擷取資訊的網站 ID。 |
| 網站名稱 |
如果沒有Site ID, 輸入要擷取資訊的網站名稱。 |
| 內容 URL |
如果沒有網站 ID 或網站名稱 ,請輸入要擷取資訊的網站網址。 |
输出
| 輸出 |
輸出類型 |
| 網站 |
JSON |
| 網站 ID |
字串 |
| 網站名稱 |
字串 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 202 |
錯誤 |
指定的網站不對應於現有的網站 |
取得網站
要檢索連接器的整合使用者可以存取的網站清單,請使用Get Sites 指令。
摘要資訊
無
输出
| 輸出 |
輸出類型 |
| 網站清單 |
JSON |
| 網站 ID |
陣列 |
| 網站名稱 |
陣列 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 10 |
警告 |
未找到網站 |
| 56 |
錯誤 |
頁碼參數不是整數,小於 1,或大於所要求頁面大小的資料來源最終頁數 |
| 57 |
錯誤 |
頁面大小參數不是整數,或小於 1 |
| 147 |
錯誤 |
指定的頁面大小大於最大頁面大小 |
取得使用者
若要擷取 Tableau 使用者 ID 的相關資訊,請使用Get User 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 使用者識別碼 |
輸入要擷取資訊的使用者 ID。 |
输出
| 輸出 |
輸出類型 |
| 使用者 |
JSON |
| 使用者識別碼 |
字串 |
| 使用者名稱 |
字串 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 204 |
錯誤 |
URI 中的使用者 ID 與現有使用者不符 |
取得群組中的使用者
要檢索群組中的使用者清單,請使用Get Users in Group 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 群組 ID |
輸入要擷取使用者的群組 ID。 |
输出
| 輸出 |
輸出類型 |
| 使用者清單 |
JSON |
| 使用者 ID |
陣列 |
| 使用者名稱 |
陣列 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 56 |
錯誤 |
頁碼參數不是整數,小於 1,或大於所要求頁面大小的資料來源最終頁數 |
| 57 |
錯誤 |
頁面大小參數不是整數,或小於 1 |
| 147 |
錯誤 |
指定的頁面大小大於最大頁面大小 |
| 214 |
錯誤 |
URI 中的群組 ID 與現有群組不符 |
Get users in site
要擷取整個網站的使用者清單,請使用Get Users in Site 指令。
摘要資訊
無
输出
| 輸出 |
輸出類型 |
| 使用者清單 |
JSON |
| 使用者 ID |
陣列 |
| 使用者名稱 |
陣列 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 56 |
錯誤 |
頁碼參數不是整數,小於 1,或大於所要求頁面大小的資料來源最終頁數 |
| 57 |
錯誤 |
頁面大小參數不是整數,或小於 1 |
| 147 |
錯誤 |
指定的頁面大小大於最大頁面大小 |
依網站取得瀏覽次數
若要擷取整個網站的所有檢視和選用的使用統計資料,請使用Get Views by Site 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 包含使用量 |
若要傳回使用量統計,請勾選此方塊。 |
输出
| 輸出 |
輸出類型 |
| 檢視清單 |
JSON |
| 檢視 ID |
陣列 |
| 檢視名稱 |
陣列 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 137 |
錯誤 |
非管理員使用者嘗試查詢工作簿檢視,但呼叫者沒有讀取權限 |
依工作簿取得檢視
若要傳回指定工作簿的所有檢視和選用的使用統計資料,請使用Get Views by Workbook 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 工作簿 ID |
輸入要取得檢視的工作簿 ID。 |
| 包含使用量 |
若要傳回使用量統計,請勾選此方塊。 |
输出
| 輸出 |
輸出類型 |
| 檢視清單 |
JSON |
| 檢視 ID |
陣列 |
| 檢視名稱 |
陣列 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 137 |
錯誤 |
非管理員使用者嘗試查詢工作簿檢視,但呼叫者沒有讀取權限 |
| 208 |
錯誤 |
URI 中的工作簿 ID 與現有工作簿不符 |
取得工作簿
若要擷取工作簿的詳細資訊,請使用Get Workbook 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 工作簿 ID |
輸入要取得詳細資訊的工作簿 ID。 |
输出
| 輸出 |
輸出類型 |
| 活頁簿 |
JSON |
| 工作簿 ID |
字串 |
| 工作簿名稱 |
字串 |
| 專案 ID |
字串 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 208 |
錯誤 |
URI 中的工作簿 ID 與現有工作簿不一致 |
取得工作簿
若要擷取連線器的整合使用者可以存取的工作簿清單,請使用Get Workbooks 指令。
摘要資訊
無
输出
| 輸出 |
輸出類型 |
| 工作簿清單 |
JSON |
| 工作簿 ID |
陣列 |
| 工作簿名稱 |
陣列 |
| 工作簿專案 ID |
陣列 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 10 |
警告 |
找不到工作簿 |
| 56 |
錯誤 |
頁碼參數不是整數,小於 1,或大於所要求頁面大小的資料來源最終頁數 |
| 57 |
錯誤 |
頁面大小參數不是整數,或小於 1 |
| 147 |
錯誤 |
指定的頁面大小大於最大頁面大小 |
發佈資料來源
若要將資料來源檔案發佈到您的 Tableau 伺服器,請使用Publish Datasource 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| DataSource |
輸入要發佈的資料來源。 |
| 資料來源類型 |
選擇要發佈的資料來源類型 - Hyper、TDS、TDSX 或 TDE。 |
| 資料來源名稱 |
輸入 Tableau Server 上資料來源的名稱。 |
| 專案 ID |
輸入要發佈資料來源的專案 ID。 |
| 覆寫 |
若要覆寫已存在的同名資料來源,請勾選此方塊。 |
输出
| 輸出 |
輸出類型 |
| 資料源 ID |
字串 |
| 資料來源名稱 |
字串 |
| 專案 ID |
字串 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 5 |
錯誤 |
未找到資料來源檔案 |
| 140 |
錯誤 |
非管理員使用者嘗試開始上傳檔案,但呼叫者在網站上沒有發佈權限 |
| 149 |
錯誤 |
由於其他原因無法上傳檔案 |
發佈工作簿
要將工作簿檔案發佈到您的 Tableau 伺服器,請使用Publish Workbook 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 活頁簿 |
輸入要發佈的工作簿。 |
| 工作簿類型 |
選擇工作簿類型是 TWBX 或 TWB。 |
| 工作簿名稱 |
輸入 Tableau Server 上工作簿的名稱。 |
| 專案 ID |
輸入要將工作簿發佈到的專案 ID。 |
| 覆寫 |
若要覆寫現有的同名工作簿,請勾選此方塊。 |
输出
| 輸出 |
輸出類型 |
| 工作簿 ID |
字串 |
| 工作簿名稱 |
字串 |
| 專案 ID |
字串 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 5 |
錯誤 |
找不到工作簿檔案 |
| 140 |
錯誤 |
非管理員使用者嘗試開始上傳檔案,但呼叫者在網站上沒有發佈權限 |
| 149 |
錯誤 |
由於其他原因無法上傳檔案 |
移除資料來源權限
要移除資料源上群組或使用者的權限,請使用Remove Datasource Permissions 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 資料來源 ID |
輸入要更新資料來源的 ID。 |
| ID 類型 (使用者或群組) |
選擇是否更新與使用者或群組相關的權限。 |
| ID |
輸入要更新權限的使用者或群組的 ID。 |
| 能力名稱 |
選擇要新增的能力名稱。 |
| 模式 |
選擇是否允許或拒絕此功能。 |
输出
無
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 137 |
錯誤 |
使用者嘗試新增資料來源的權限,但呼叫者沒有此項權限 |
| 204 |
錯誤 |
指定的使用者與現有使用者不符 |
| 206 |
錯誤 |
指定的資料來源與現有的資料來源不一致 |
| 214 |
錯誤 |
指定的群組與現有的群組不一致 |
| 215 |
錯誤 |
功能未以指定模式指派給指定的使用者或群組 |
移除預設資料來源權限
要移除專案 Datasources 的預設權限,請使用Remove Default Datasource Permissions 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 專案 ID |
輸入要更新的專案 ID。 |
| ID 類型 (使用者或群組) |
選擇是否更新與使用者或群組相關的權限。 |
| ID |
輸入要更新權限的使用者或群組的 ID。 |
| 能力名稱 |
選擇要新增的能力名稱。 |
| 模式 |
選擇是否允許或拒絕此功能。 |
输出
無
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 137 |
錯誤 |
使用者嘗試新增資料來源的權限,但呼叫者沒有此項權限 |
| 204 |
錯誤 |
指定的使用者與現有使用者不符 |
| 206 |
錯誤 |
指定的資料來源與現有的資料來源不一致 |
| 214 |
錯誤 |
指定的群組與現有的群組不一致 |
| 215 |
錯誤 |
功能未以指定模式指派給指定的使用者或群組 |
移除預設工作簿權限
若要移除專案工作簿的預設權限,請使用Remove Default Workbook Permissions 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 專案 ID |
輸入要更新的專案 ID。 |
| ID 類型 (使用者或群組) |
選擇是否更新與使用者或群組相關的權限。 |
| ID |
輸入要更新權限的使用者或群組的 ID。 |
| 能力名稱 |
選擇要新增的能力名稱。 |
| 模式 |
選擇是否允許或拒絕此功能。 |
输出
無
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 137 |
錯誤 |
使用者嘗試新增資料來源的權限,但呼叫者沒有此項權限 |
| 204 |
錯誤 |
指定的使用者與現有使用者不符 |
| 206 |
錯誤 |
指定的資料來源與現有的資料來源不一致 |
| 214 |
錯誤 |
指定的群組與現有的群組不一致 |
| 215 |
錯誤 |
功能未指定給指定模式的指定使用者或群組 |
移除專案權限
若要移除專案中群組或使用者的權限,請使用Remove Project Permission 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 專案 ID |
輸入要更新的專案 ID。 |
| ID 類型 (使用者或群組) |
選擇是否更新與使用者或群組相關的權限。 |
| ID |
輸入要更新權限的使用者或群組的 ID。 |
| 能力名稱 |
選擇要新增的能力名稱。 |
| 模式 |
選擇是否允許或拒絕此功能。 |
输出
無
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 137 |
錯誤 |
使用者嘗試新增資料來源的權限,但呼叫者沒有此項權限 |
| 204 |
錯誤 |
指定的使用者與現有使用者不符 |
| 206 |
錯誤 |
指定的資料來源與現有的資料來源不一致 |
| 214 |
錯誤 |
指定的群組與現有的群組不一致 |
| 215 |
錯誤 |
功能未以指定的模式指派給指定的使用者或群組 |
從群組移除使用者
要從指定的群組移除使用者,請使用Remove User From Group 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 群組 ID |
輸入要從群組移除使用者的 ID。 |
| 使用者識別碼 |
輸入要從群組移除的使用者 ID。 |
输出
無
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 82 |
錯誤 |
出現問題導致無法從網站移除使用者 |
| 204 |
錯誤 |
指定的使用者與現有使用者不符 |
| 214 |
錯誤 |
指定的群組與現有的群組不一致 |
| 224 |
警告 |
使用者不是指定群組的成員 |
從網站移除使用者
要從指定的網站刪除使用者,請使用Remove User From Site 指令。
注意: 如果使用者在 Tableau Server 上仍擁有內容或資產,則除非先重新分配所有權,否則無法刪除該使用者。若要刪除使用者,請將其從其所屬的所有網站中移除。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 使用者識別碼 |
輸入要從網站移除的使用者 ID。 |
输出
無
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法使用 Tableau 進行驗證 |
| 50 |
錯誤 |
出現問題導致無法從網站移除使用者 |
| 204 |
錯誤 |
指定的使用者與現有使用者不符 |
| 232 |
錯誤 |
URI 中的使用者名稱與現有使用者不符 |
移除工作簿權限
要移除工作簿上使用者或群組的權限,請使用Remove Workbook Permissions 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 工作簿 ID |
輸入要更新的工作簿 ID。 |
| ID 類型 (群組或使用者) |
選擇是否更新與使用者或群組相關的權限。 |
| ID |
輸入要更新權限的使用者或群組的 ID。 |
| 能力名稱 |
選擇要新增的能力名稱。 |
| 模式 |
選擇是否允許或拒絕此功能。 |
输出
無
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 137 |
錯誤 |
使用者嘗試為工作簿新增權限,但呼叫者沒有此項權限 |
| 204 |
錯誤 |
指定的使用者與現有使用者不符 |
| 208 |
錯誤 |
工作簿 ID 與現有工作簿不一致 |
| 214 |
錯誤 |
指定的群組與現有的群組不一致 |
| 215 |
錯誤 |
功能未指定給指定模式的指定群組或使用者 |
顯示資料來源權限
若要檢視指定給資料來源的所有權限,請使用Show Datasource Permissions 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 資料來源 ID |
輸入要更新的資料來源 ID。 |
输出
無
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 206 |
錯誤 |
指定的資料來源與現有的資料來源不一致 |
顯示預設權限
若要檢視指定給專案的 Datasources 或工作簿的預設權限,請使用Show Default Permissions 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 專案 ID |
輸入要更新的專案 ID。 |
| 資源類型 |
選擇是否顯示工作簿或資料源的權限。 |
输出
無
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 207 |
錯誤 |
專案 ID 與現有專案不符 |
顯示專案權限
若要檢視指定給專案的所有權限,請使用Show Project Permissions 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 專案 ID |
輸入要顯示權限的專案 ID。 |
输出
無
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 207 |
錯誤 |
專案 ID 與現有專案不符 |
顯示工作簿權限
若要檢視指定給工作簿的所有權限,請使用 Show Workbook Permissions 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 工作簿 ID |
輸入要顯示權限的工作簿 ID。 |
输出
無
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 208 |
錯誤 |
工作簿 ID 與現有工作簿不符 |
更新資料源
若要更新資料源的 Project、Owner 或 Certification,請使用Update Datasource 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 資料來源 ID |
輸入要更新的資料來源 ID。 |
| 專案 ID |
要更新專案,請輸入要新增資料來源的專案 ID (選用)。 |
| 物件識別碼 |
若要更新擁有者,請輸入要將資料來源的擁有權指派給的使用者 ID(可選)。 |
| 已認證 |
如果資料來源已經過認證,請勾選此方塊(可選)。 |
| 認證備註 |
輸入關於資料來源驗證的任何其他資訊(如適用)(可選)。 |
输出
| 輸出 |
輸出類型 |
| 更新資料來源 |
JSON |
| 資料來源名稱 |
字串 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 160 |
錯誤 |
非管理員使用者試圖變更資料來源的擁有者 |
| 163 |
錯誤 |
非管理員使用者嘗試變更資料來源的專案,但呼叫者沒有專案的寫入權限 |
| 165 |
錯誤 |
非管理員使用者嘗試更新資料來源,但呼叫者沒有寫入權限 |
| 204 |
錯誤 |
擁有者 ID 與現有使用者不符 |
| 206 |
錯誤 |
資料來源 ID 與現有資料來源不符 |
| 207 |
錯誤 |
專案 ID 與現有專案不符 |
| 244 |
錯誤 |
請求中的資料來源名稱已屬於指定的網站。為確保唯一性,資料來源名稱不區分大小寫。 |
更新資料來源權限
要更新資料源上的群組或使用者的權限,請使用Update Datasource Permissions 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 資料來源 ID |
輸入要更新的資料來源 ID。 |
| ID 類型 (群組或使用者) |
選擇是否更新使用者或群組的權限。 |
| ID |
輸入群組的 ID 或用於更新權限的 ID。 |
| 能力名稱 |
選擇要新增的能力名稱。 |
| 模式 |
選擇是否允許或拒絕此功能。 |
输出
無
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 137 |
錯誤 |
使用者嘗試新增資料來源的權限,但呼叫者沒有此項權限 |
| 204 |
錯誤 |
擁有者 ID 與現有使用者不符 |
| 206 |
錯誤 |
資料來源 ID 與現有資料來源不符 |
| 214 |
錯誤 |
群組 ID 與現有群組不符 |
| 215 |
錯誤 |
由於無效的權限名稱或任何模式值的 Allow 或 Deny 以外的權限,請求正文中指定的權限不符合已定義的權限 |
更新預設資料來源權限
若要更新專案資料來源的預設權限,請使用Update Default Datasource Permissions 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 專案 ID |
輸入要更新的專案 ID。 |
| ID 類型 (群組或使用者) |
選擇是否更新使用者或群組的權限。 |
| ID |
輸入群組的 ID 或用於更新權限的 ID。 |
| 能力名稱 |
選擇要新增的能力名稱。 |
| 模式 |
選擇是否允許或拒絕此功能。 |
输出
無
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 137 |
錯誤 |
使用者嘗試新增資料來源的權限,但呼叫者沒有此項權限 |
| 204 |
錯誤 |
擁有者 ID 與現有使用者不符 |
| 206 |
錯誤 |
資料來源 ID 與現有資料來源不符 |
| 214 |
錯誤 |
群組 ID 與現有群組不符 |
| 215 |
錯誤 |
由於無效的功能名稱或任何模式值的允許或拒絕以外的功能,請求正文中指定的功能與已定義的功能不一致 |
更新預設工作簿權限
若要更新專案工作簿的預設權限,請使用 更新預設工作簿權限 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 專案 ID |
輸入要更新的專案 ID。 |
| ID 類型 (群組或使用者) |
選擇是否更新使用者或群組的權限。 |
| ID |
輸入群組的 ID 或用於更新權限的 ID。 |
| 能力名稱 |
選擇要新增的能力名稱。 |
| 模式 |
選擇是否允許或拒絕此功能。 |
输出
無
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 137 |
錯誤 |
使用者嘗試新增資料來源的權限,但呼叫者沒有此項權限 |
| 204 |
錯誤 |
擁有者 ID 與現有使用者不符 |
| 206 |
錯誤 |
資料來源 ID 與現有資料來源不符 |
| 214 |
錯誤 |
群組 ID 與現有群組不符 |
| 215 |
錯誤 |
由於能力名稱無效,或對於任何模式值,能力不是「允許」或「拒絕」,因此請求正文中指定的能力與已定義的能力不符。 |
更新群組
要更新組名稱,請使用Update Group 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 群組 ID |
輸入要更新的群組 ID。 |
| 名稱 |
輸入專案的新名稱 (選用)。 |
输出
| 輸出 |
輸出類型 |
| 更新群組 |
JSON |
| 群組 ID |
字串 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 207 |
錯誤 |
URI 中的專案 ID 與現有專案不符 |
| 214 |
錯誤 |
群組 ID 與現有群組不符 |
| 235 |
錯誤 |
請求中的專案名稱已屬於指定的網站。為確保唯一性,專案名稱不區分大小寫 |
| 238 |
錯誤 |
請求中的群組名稱已在指定的網站中使用。為了確保唯一性,群組名稱不區分大小寫。 |
更新 Hyper Extract
若要從 CSV 檔案新增額外資料到 Hyper Extract,請使用Update Hyper Extract 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| Tableau 摘要 |
輸入要使用新資料更新的 Extract 檔案。 |
| 源 CSV 檔案 |
輸入用於在 Hyper 檔案中建立資料的檔案。 |
| 檔案格式 |
選擇 CSV 檔案的格式。 |
| 資料欄類型 |
在源 CSV 檔案 中輸入每一列的類型:INTEGER,DOUBLE,BOOLEAN,DATE,DATETIME,DURATION,CHAR_STRING,UNICODE_STRING, 或SPATIAL 。 |
输出
| 輸出 |
輸出類型 |
| 擷取檔案 |
檔案 |
| 擷取大小 (位元組) |
整數 |
| 已處理記錄 |
整數 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 4 |
錯誤 |
建立 Hyper Extract 時發生一般錯誤 |
| 5 |
錯誤 |
無法找到 CSV 輸入檔案 |
| 6 |
錯誤 |
CSV 格式不正確,或指定了錯誤的檔案格式 |
| 11 |
錯誤 |
列類型的數量與 CSV 中標頭列的數量不匹配 |
| 12 |
錯誤 |
無效列類型 |
更新專案
若要更新專案的父專案、名稱、權限或描述,請使用Update Project 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 專案 ID |
輸入要更新專案的 ID。 |
| 父專案 ID |
要建立專案層級,請輸入父專案的識別碼(選用)。 |
| 名稱 |
輸入專案的新名稱 (選用)。 |
| 內容權限 |
選擇專案的新權限設定 (選用):
- 若要鎖定權限,使使用者無法覆寫專案的預設權限設定,請選取 LockedToProject。
- 若要讓使用者管理其擁有內容的權限,請選擇由擁有者管理。
|
| 說明 |
輸入專案的新說明(選填)。 |
输出
| 輸出 |
輸出類型 |
| 更新的專案 |
JSON |
| 專案 ID |
字串 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 138 |
錯誤 |
嘗試重新命名無法重新命名的預設專案 |
| 141 |
錯誤 |
無法發佈樣本,因為伺服器上剩餘的儲存空間不足以容納樣本 |
| 207 |
錯誤 |
專案 ID 與現有專案不符 |
| 235 |
錯誤 |
請求中的專案名稱已屬於指定的網站。為確保唯一性,專案名稱不區分大小寫。 |
更新專案權限
若要更新專案中群組或使用者的權限,請使用更新專案權限 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 專案 ID |
輸入要更新的專案 ID。 |
| ID 類型 (群組或使用者) |
選擇是否更新使用者或群組的權限。 |
| ID |
輸入要更新權限的使用者或群組的 ID。 |
| 能力名稱 |
選擇要新增的能力名稱。 |
| 模式 |
選擇是否允許或拒絕此功能。 |
输出
無
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 137 |
錯誤 |
使用者嘗試新增專案權限,但呼叫者沒有此權限 |
| 204 |
錯誤 |
指定的使用者與現有使用者不符 |
| 207 |
錯誤 |
專案 ID 與現有專案不符 |
| 214 |
錯誤 |
指定的群組與現有的群組不一致 |
| 215 |
錯誤 |
指定的功能不符合已定義的功能,原因是功能名稱無效,或任何模式值的 Alllow 或 Deny 以外的功能。 |
更新 TDE 摘要
若要從 CSV 檔案新增額外資料到 TDE 檔案,請使用Update TDE Extract 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| Tableau 摘要 |
輸入要使用新資料更新的 Extract 檔案。 |
| 源 CSV 檔案 |
選擇用於建立 TDE 檔案中資料的檔案。 |
| 檔案格式 |
選擇 CSV 檔案的格式。 |
| 資料欄類型 |
在源 CSV 檔案 中選擇每一列的類型:INTEGER,DOUBLE,BOOLEAN,DATE,DATETIME,DURATION,CHAR_STRING,UNICODE_STRING, 或SPATIAL 。 |
| 模式 |
選擇是否允許或拒絕此功能。 |
输出
| 輸出 |
輸出類型 |
| 擷取檔案 |
檔案 |
| 擷取大小 (位元組) |
整數 |
| 已處理記錄 |
整數 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 4 |
錯誤 |
建立 TDE 檔案時發生一般錯誤 |
| 5 |
錯誤 |
無法找到 CSV 輸入檔案 |
| 6 |
錯誤 |
CSV 格式不正確,或指定了錯誤的檔案格式 |
| 11 |
錯誤 |
列類型的數量與 CSV 中標頭列的數量不匹配 |
| 12 |
錯誤 |
指定的欄位類型之一不是有效類型 |
更新工作簿
若要更新工作簿的專案、擁有者或顯示標籤設定,請使用Update Workbook 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 工作簿 ID |
輸入要更新工作簿的 ID。 |
| 專案 ID |
輸入要指定工作簿的專案 ID (選用)。 |
| 擁有者 ID |
輸入要指定工作簿為擁有者的使用者 ID (選用)。 |
| 顯示標籤 |
若要讓已發佈的工作簿以標籤顯示檢視,請勾選此方塊(選用)。 |
输出
| 輸出 |
輸出類型 |
| 更新工作簿 |
JSON |
| 工作簿 ID |
字串 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 150 |
錯誤 |
非管理員嘗試變更工作簿擁有者 |
| 158 |
錯誤 |
非管理員嘗試變更工作簿專案,但呼叫者沒有目標專案的寫入權限 |
| 160 |
錯誤 |
非管理員嘗試變更工作簿,但呼叫者沒有工作簿的寫入權限 |
| 204 |
錯誤 |
所有者 ID 與現有使用者不符 |
| 207 |
錯誤 |
專案 ID 與現有專案不符 |
| 208 |
錯誤 |
工作簿 ID 與現有工作簿不一致 |
| 244 |
錯誤 |
請求中的資料來源名稱已屬於指定的網站。為確保唯一性,資料來源名稱不區分大小寫。 |
更新工作簿權限
要更新工作簿上使用者或群組的權限,請使用Update Workbook Permissions 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 工作簿 ID |
輸入要更新的工作簿 ID。 |
| ID 類型 (群組或使用者) |
選擇是否更新與群組或使用者相關的權限。 |
| ID |
輸入要更新權限的群組或使用者的 ID。 |
| 能力名稱 |
選擇要新增的能力名稱。 |
| 模式 |
選擇是否允許或拒絕此功能。 |
输出
無
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效輸入 |
| 2 |
錯誤 |
無法驗證 Tableau |
| 137 |
錯誤 |
使用者嘗試新增專案權限,但呼叫者沒有此權限 |
| 204 |
錯誤 |
所有者 ID 與現有使用者不符 |
| 207 |
錯誤 |
專案 ID 與現有專案不符 |
| 208 |
錯誤 |
工作簿 ID 與現有工作簿不符 |
| 214 |
錯誤 |
指定的群組與現有的群組不一致 |
| 215 |
錯誤 |
指定的功能不符合已定義的功能,原因是功能名稱無效或任何模式值的 Alllow 或 Deny 以外的功能 |