チェーンの一部として Tableau® と対話するには、Tableau 接続コマンドを含むステップを追加します。例：
- Anaplan®、Oracle® HFM、IBM Cognos® Planning Analytics Cloud (TM1)など、さまざまなデータソースとTableauを自動化および接続します。
- 統合されたエンドユーザーアクセス管理とTableauのクラウド版とオンプレミス版の両方をサポートすることで、従来のレポートも新しいレポートも動的にリフレッシュします。
これらのコマンドを有効にするには、IT 管理者がまずTableau コネクタ を作成します。この接続は、これらのバージョンのTableauのオンプレミスおよびクラウド展開と相互作用する：
- 8.3
- 9.x
- 10.x
- 2018.x
- 2019.x
- 2020.x
- Tableauオンライン
ユーザーをグループに追加する
ユーザーを指定されたグループに追加するには、Add User to Group コマンドを使用する。
プロパティ
| プロパティ |
詳細 |
| グループID |
ユーザーを追加するグループのIDを入力してください。 |
| ユーザ ID |
追加するユーザーのID（ 、名前ではない）を入力する。 |
出力
| 出力 |
出力タイプ |
| ユーザー |
JSON |
| ユーザ ID |
文字列 |
| ユーザー名 |
文字列 |
| ユーザーサイトの役割 |
文字列 |
終了コード
| コード |
タイプ |
詳細 |
| 0 |
成功 |
成功 |
| 1 |
エラー |
無効な入力 |
| 2 |
エラー |
Tableauで認証できませんでした |
| 214 |
エラー |
リクエスト本文のグループ名が既存のグループと一致しない。 |
| 240 |
警告 |
指定されたユーザーはすでにグループのメンバーです。 |
ユーザーをサイトに追加する
ユーザーを Tableau Server に追加し、指定したサイトに割り当てるには、Add User to Site コマンドを使用します。
プロパティ
| プロパティ |
詳細 |
| ユーザー名 |
ユーザー名を入力してください。Active Directory (AD) 認証の場合は、AD 内の既存のユーザー名を使用します。ユーザー名がドメイン間で一意でない場合、domainAdam またはadam@domain.com のようにドメインを含める。 |
| 役割 |
ユーザに割り当てるサイトの役割を選択します：Creator、Explorer、ExplorerCanPublish、ReadOnly、SiteAdministratorExplorer、SiteAdministratorCreator、Unlicensed、またはViewer。 |
| 認証タイプ |
SAML（Security Assertion Markup Language）または ServerDefault のどちらでユーザを認証するかを選択します。 注: Tableau Online では、これらの値は Settings ページのAuthentication タブに表示されます。SAML は Single Sign-on (SSO) に対応し、ServerDefault は TableauID に対応します。 |
出力
| 出力 |
出力タイプ |
| ユーザー |
JSON |
| ユーザ ID |
文字列 |
| ユーザー名 |
文字列 |
| ユーザーサイトの役割 |
文字列 |
終了コード
| コード |
タイプ |
詳細 |
| 0 |
成功 |
成功 |
| 1 |
エラー |
無効な入力 |
| 2 |
エラー |
Tableauで認証できませんでした |
| 204 |
エラー |
サーバーがActive Directory認証を使用するように設定されており、リクエスト本文で指定されたユーザー名がADのユーザーと一致しない。 |
| 229 |
エラー |
指定されたユーザーはすでにサイトに存在しています |
| 234 |
エラー |
Tabeleau Server APIでは、guestロールを持つユーザーをサイトに追加できません。 |
ハイパーエキスを作る
カンマ区切り値（CSV）ファイルからHyper Extractを構築するには、Build Hyper Extract コマンドを使用します。
注： GroundRunner でこのコマンドを使用するには、Tableau Extract API をそのサーバーにインストールし、そのダイナミックリンクライブラリ (DLL) ファイルをレジストリで使用されるフォルダ、たとえばC:˶WindowsSystem32 に移動します。
プロパティ
| プロパティ |
詳細 |
| ソースCSVファイル |
ハイパーファイルのデータ作成に使用したファイルを入力します。 |
| ファイル形式 |
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:˶WindowsSystem32 に移動します。
プロパティ
| プロパティ |
詳細 |
| ソース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 |
エラー |
リクエストボディで指定されたケーパビリティが、定義されたケーパビリティに対応していない。これは、無効なケイパビリティ名、あるいは、どのようなモード値であっても、 AllowまたはDeny以外のケイパビリティに適用できる。 |
一括削除許可
データソースとして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 コマンドを使用します。
プロパティ
| プロパティ |
詳細 |
| グループ名 |
新しいグループの名前を入力します。 |
出力
| 出力 |
出力タイプ |
| グループ |
JSON |
| グループID |
文字列 |
終了コード
| コード |
タイプ |
詳細 |
| 0 |
成功 |
成功 |
| 1 |
エラー |
無効な入力 |
| 2 |
エラー |
Tableauで認証できませんでした |
| 238 |
警告 |
指定された名前のグループがすでに存在する |
プロジェクトの作成
Tableau でプロジェクトを作成するには、Create Project コマンドを使用します。
プロパティ
| プロパティ |
詳細 |
| プロジェクト名 |
新しいプロジェクトの名前を入力します。 |
| 説明 |
新しいプロジェクトの説明を入力します（オプション）。 |
| 親プロジェクトID |
プロジェクト階層を作成するには、親プロジェクトの識別子を入力します（オプション）。 |
| 管理者モード |
ユーザーの権限管理のレベルを選択します。
- プロジェクトに設定されたデフォルトのパーミッションをユーザーが上書きできないようにパーミッションをロックするには、LockedToProjectを選択します。
- ユーザーが所有するコンテンツのパーミッションを管理できるようにするには、ManagedByOwnerを選択します。
|
| サンプル付き |
Tableau が提供するサンプル ワークブックをプロジェクトに公開するには、このチェック ボックスをオンにします。 |
出力
| 出力 |
出力タイプ |
| プロジェクト |
JSON |
| プロジェクトID |
文字列 |
終了コード
| コード |
タイプ |
詳細 |
| 0 |
成功 |
成功 |
| 1 |
エラー |
無効な入力 |
| 2 |
エラー |
Tableauで認証できませんでした |
| 141 |
エラー |
サーバーに十分なストレージ容量が残っていないため、サンプルを公開できませんでした。 |
| 235 |
エラー |
リクエストのプロジェクト名はすでに指定されたサイトに属しています。一意性を確保するため、プロジェクト名は大文字と小文字を区別しない。 |
サイト作成
Tableau でサイトを作成するには、Create Site コマンドを使用します。
プロパティ
| プロパティ |
詳細 |
| サイト名 |
新しいサイトの名前を入力します。 |
| コンテンツURL |
サイトのURLを、URLとして有効な文字のみで入力してください。 |
| 管理者モード |
管理者のサイトアクセスレベルを選択します（オプション）：
- サイト管理者がサーバー・インターフェースとTABCMDコマンド（ただし、REST APIは使用しない）を使用してユーザーを追加および削除できるようにするには、ContentAndUsersを選択します。
- サイト管理者がユーザを追加または削除できないようにするには、ContentOnlyを選択してください。
注： サーバー管理者は、常にユーザーを追加または削除することができる。 |
| 購読を有効にする |
ユーザーがサイト上のワークブックを購読できないようにするには、このボックスにチェックを入れます。 |
出力
| 出力 |
出力タイプ |
| サイト |
JSON |
| サイトID |
文字列 |
終了コード
| コード |
タイプ |
詳細 |
| 0 |
成功 |
成功 |
| 1 |
エラー |
無効な入力 |
| 2 |
エラー |
Tableauで認証できませんでした |
| 50 |
エラー |
ストレージクォータまたはユーザークォータの値が正数でなかった。 |
| 63 |
エラー |
ContentOnlyでもContentAndUsersでもない管理者モードをユーザーが指定した。 |
| 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をダウンロードする
指定されたビューを Portable Document Format (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を入力してください。 |
出力
| 出力 |
出力タイプ |
| データソース |
JSON |
| データソースID |
文字列 |
| データソース名 |
文字列 |
終了コード
| コード |
タイプ |
詳細 |
| 0 |
成功 |
成功 |
| 1 |
エラー |
無効な入力 |
| 2 |
エラー |
Tableauで認証できませんでした |
| 206 |
エラー |
URIのデータソースIDが既存のデータソースに対応していない。 |
データソース接続の取得
Datasource に関連付けられた接続のリストを取得するには、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 またはサイト名 がない場合は、情報を取得するサイトの URL を入力します。 |
出力
| 出力 |
出力タイプ |
| サイト |
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 |
情報を取得したいユーザーのIDを入力してください。 |
出力
| 出力 |
出力タイプ |
| ユーザー |
JSON |
| ユーザ ID |
文字列 |
| ユーザー名 |
文字列 |
終了コード
| コード |
タイプ |
詳細 |
| 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 コマンドを使用します。
プロパティ
なし
出力
| 出力 |
出力タイプ |
| ユーザーリスト |
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 |
エラー |
指定されたページサイズが最大ページサイズより大きい |
データソースの公開
Datasource ファイルを Tableau Server に発行するには、Publish Datasource コマンドを使用します。
プロパティ
| プロパティ |
詳細 |
| データソース |
公開するデータソースを入力します。 |
| データソースの種類 |
公開するデータソースのタイプ（Hyper、TDS、TDSX、TDE）を選択します。 |
| データソース名 |
Tableau Server上のデータソース名を入力します。 |
| プロジェクトID |
データソースを公開するプロジェクトのIDを入力してください。 |
| 上書き |
同じ名前の既存のデータソースが存在する場合に上書きするには、このボックスにチェックを入れます。 |
出力
| 出力 |
出力タイプ |
| データソースID |
文字列 |
| データソース名 |
文字列 |
| プロジェクトID |
文字列 |
終了コード
| コード |
タイプ |
詳細 |
| 0 |
成功 |
成功 |
| 1 |
エラー |
無効な入力 |
| 2 |
エラー |
Tableauで認証できませんでした |
| 5 |
エラー |
データソース・ファイルが見つかりません |
| 140 |
エラー |
管理者でないユーザーがファイルのアップロードを開始しようとしましたが、発信者にはサイトの公開権限がありません。 |
| 149 |
エラー |
何らかの理由でファイルをアップロードできませんでした。 |
ワークブックの発行
Workbook ファイルを Tableau Server に発行するには、Publish Workbook コマンドを使用します。
プロパティ
| プロパティ |
詳細 |
| ブック |
公開するワークブックを入力します。 |
| ワークブックの種類 |
ワークブックのタイプがTWBXかTWBかを選択する。 |
| ワークブック名 |
Tableau Server上のワークブックの名前を入力します。 |
| プロジェクトID |
ワークブックを公開するプロジェクトのIDを入力します。 |
| 上書き |
同じ名前の既存のワークブックが存在する場合に上書きするには、このボックスにチェックを入れます。 |
出力
| 出力 |
出力タイプ |
| ワークブックID |
文字列 |
| ワークブック名 |
文字列 |
| プロジェクトID |
文字列 |
終了コード
| コード |
タイプ |
詳細 |
| 0 |
成功 |
成功 |
| 1 |
エラー |
無効な入力 |
| 2 |
エラー |
Tableauで認証できませんでした |
| 5 |
エラー |
ワークブックファイルが見つかりません |
| 140 |
エラー |
管理者でないユーザーがファイルのアップロードを開始しようとしましたが、発信者にはサイトの公開権限がありません。 |
| 149 |
エラー |
何らかの理由でファイルをアップロードできませんでした。 |
データソースの権限を削除する
Datasource 上の Group または User の権限を削除するには、Remove Datasource Permissions コマンドを使用します。
プロパティ
| プロパティ |
詳細 |
| データソースID |
更新するデータソースのIDを入力してください。 |
| IDタイプ（ユーザーまたはグループ） |
ユーザーまたはグループに関連付けられた権限を更新するかどうかを選択します。 |
| 身分証明書 |
権限を更新するユーザーまたはグループのIDを入力します。 |
| 能力名 |
追加するケイパビリティの名前を選択します。 |
| モード |
ケイパビリティを許可するか拒否するかを選択します。 |
出力
なし
終了コード
| コード |
タイプ |
詳細 |
| 0 |
成功 |
成功 |
| 1 |
エラー |
無効な入力 |
| 2 |
エラー |
Tableauで認証できませんでした |
| 137 |
エラー |
ユーザーがデータソースに権限を追加しようとしたが、呼び出し元にはその権限がない。 |
| 204 |
エラー |
指定されたユーザーが既存のユーザーと一致しない。 |
| 206 |
エラー |
指定されたデータソースが既存のデータソースに対応していない。 |
| 214 |
エラー |
指定されたグループが既存のグループと一致しない。 |
| 215 |
エラー |
指定されたユーザーまたはグループに、指定されたモードのケイパビリティが割り当てられていない。 |
デフォルトのデータソース権限を削除する
プロジェクトのデータソースのデフォルト権限を削除するには、Remove Default Datasource Permissions コマンドを使用します。
プロパティ
| プロパティ |
詳細 |
| プロジェクトID |
更新するプロジェクトのIDを入力します。 |
| IDタイプ（ユーザーまたはグループ） |
ユーザーまたはグループに関連付けられた権限を更新するかどうかを選択します。 |
| 身分証明書 |
権限を更新するユーザーまたはグループのIDを入力します。 |
| 能力名 |
追加するケイパビリティの名前を選択します。 |
| モード |
ケイパビリティを許可するか拒否するかを選択します。 |
出力
なし
終了コード
| コード |
タイプ |
詳細 |
| 0 |
成功 |
成功 |
| 1 |
エラー |
無効な入力 |
| 2 |
エラー |
Tableauで認証できませんでした |
| 137 |
エラー |
ユーザーがデータソースに権限を追加しようとしたが、呼び出し元にはその権限がない。 |
| 204 |
エラー |
指定されたユーザーが既存のユーザーと一致しない。 |
| 206 |
エラー |
指定されたデータソースが既存のデータソースに対応していない。 |
| 214 |
エラー |
指定されたグループが既存のグループと一致しない。 |
| 215 |
エラー |
指定されたユーザーまたはグループに、指定されたモードのケイパビリティが割り当てられていない。 |
デフォルトのワークブック権限を削除する
プロジェクトのワークブックのデフォルト権限を削除するには、Remove Default Workbook Permissions コマンドを使用します。
プロパティ
| プロパティ |
詳細 |
| プロジェクトID |
更新するプロジェクトのIDを入力します。 |
| IDタイプ（ユーザーまたはグループ） |
ユーザーまたはグループに関連付けられた権限を更新するかどうかを選択します。 |
| 身分証明書 |
権限を更新するユーザーまたはグループのIDを入力します。 |
| 能力名 |
追加するケイパビリティの名前を選択します。 |
| モード |
ケイパビリティを許可するか拒否するかを選択します。 |
出力
なし
終了コード
| コード |
タイプ |
詳細 |
| 0 |
成功 |
成功 |
| 1 |
エラー |
無効な入力 |
| 2 |
エラー |
Tableauで認証できませんでした |
| 137 |
エラー |
ユーザーがデータソースに権限を追加しようとしたが、呼び出し元にはその権限がない。 |
| 204 |
エラー |
指定されたユーザーが既存のユーザーと一致しない。 |
| 206 |
エラー |
指定されたデータソースが既存のデータソースに対応していない。 |
| 214 |
エラー |
指定されたグループが既存のグループと一致しない。 |
| 215 |
エラー |
指定されたユーザーまたはグループに、指定されたモードのケイパビリティが割り当てられていない。 |
プロジェクトの許可を削除する
プロジェクト上のグループまたはユーザーのパーミッションを削除するには、Remove Project Permission コマンドを使用します。
プロパティ
| プロパティ |
詳細 |
| プロジェクトID |
更新するプロジェクトのIDを入力します。 |
| IDタイプ（ユーザーまたはグループ） |
ユーザーまたはグループに関連付けられた権限を更新するかどうかを選択します。 |
| 身分証明書 |
権限を更新するユーザーまたはグループのIDを入力します。 |
| 能力名 |
追加するケイパビリティの名前を選択します。 |
| モード |
ケイパビリティを許可するか拒否するかを選択します。 |
出力
なし
終了コード
| コード |
タイプ |
詳細 |
| 0 |
成功 |
成功 |
| 1 |
エラー |
無効な入力 |
| 2 |
エラー |
Tableauで認証できませんでした |
| 137 |
エラー |
ユーザーがデータソースに権限を追加しようとしたが、呼び出し元にはその権限がない。 |
| 204 |
エラー |
指定されたユーザーが既存のユーザーと一致しない。 |
| 206 |
エラー |
指定されたデータソースが既存のデータソースに対応していない。 |
| 214 |
エラー |
指定されたグループが既存のグループと一致しない。 |
| 215 |
エラー |
指定されたユーザーまたはグループに、指定されたモードのケイパビリティが割り当てられていない。 |
グループからユーザーを削除
指定したグループからユーザーを削除するには、Remove User From Group コマンドを使用します。
プロパティ
| プロパティ |
詳細 |
| グループID |
ユーザーを削除するグループのIDを入力してください。 |
| ユーザ ID |
グループから削除するユーザーのIDを入力してください。 |
出力
なし
終了コード
| コード |
タイプ |
詳細 |
| 0 |
成功 |
成功 |
| 1 |
エラー |
無効な入力 |
| 2 |
エラー |
Tableauで認証できませんでした |
| 82 |
エラー |
ユーザーをサイトから削除できない問題が発生した |
| 204 |
エラー |
指定されたユーザーが既存のユーザーと一致しない。 |
| 214 |
エラー |
指定されたグループが既存のグループと一致しない。 |
| 224 |
警告 |
そのユーザーは指定されたグループのメンバーではありません。 |
ユーザーをサイトから削除する
指定したサイトからユーザーを削除するには、Remove User From Site コマンドを使用します。
注: ユーザーが Tableau Server 上でコンテンツまたはアセットをまだ所有している場合、最初に所有権が再割り当てされない限り、それらを削除することはできません。ユーザーを削除するには、そのユーザーがメンバーであるすべてのサイトから削除してください。
プロパティ
| プロパティ |
詳細 |
| ユーザ ID |
サイトから削除するユーザーのIDを入力してください。 |
出力
なし
終了コード
| コード |
タイプ |
詳細 |
| 0 |
成功 |
成功 |
| 1 |
エラー |
無効な入力 |
| 2 |
エラー |
Tableauで認証できませんでした |
| 50 |
エラー |
ユーザーをサイトから削除できない問題が発生した |
| 204 |
エラー |
指定されたユーザーが既存のユーザーと一致しない。 |
| 232 |
エラー |
URIのユーザー名が既存のユーザーと一致しない。 |
ワークブックの権限を削除する
ワークブックのユーザーまたはグループの権限を削除するには、Remove Workbook Permissions コマンドを使用します。
プロパティ
| プロパティ |
詳細 |
| ワークブックID |
更新するワークブックのIDを入力します。 |
| IDタイプ（グループまたはユーザー） |
ユーザーまたはグループに関連付けられている権限を更新するかどうかを選択します。 |
| 身分証明書 |
権限を更新するユーザーまたはグループのIDを入力します。 |
| 能力名 |
追加するケイパビリティの名前を選択します。 |
| モード |
ケイパビリティを許可するか拒否するかを選択します。 |
出力
なし
終了コード
| コード |
タイプ |
詳細 |
| 0 |
成功 |
成功 |
| 1 |
エラー |
無効な入力 |
| 2 |
エラー |
Tableauで認証できませんでした |
| 137 |
エラー |
ユーザーがワークブックに権限を追加しようとしましたが、呼び出し元にはその権限がありません。 |
| 204 |
エラー |
指定されたユーザーが既存のユーザーと一致しない。 |
| 208 |
エラー |
ワークブックIDが既存のワークブックに対応していない。 |
| 214 |
エラー |
指定されたグループが既存のグループと一致しない。 |
| 215 |
エラー |
ケイパビリティが指定されたグループまたはユーザーに、指定されたモードで割り当てられていない。 |
データソースのアクセス許可を表示する
Datasourceに割り当てられたすべての権限を表示するには、Show Datasource Permissions コマンドを使用します。
プロパティ
| プロパティ |
詳細 |
| データソースID |
更新するデータソースのIDを入力してください。 |
出力
なし
終了コード
| コード |
タイプ |
詳細 |
| 0 |
成功 |
成功 |
| 1 |
エラー |
無効な入力 |
| 2 |
エラー |
Tableauで認証できませんでした |
| 206 |
エラー |
指定されたデータソースが既存のデータソースに対応していない。 |
デフォルトのアクセス許可を表示する
プロジェクトのデータソースやワークブックに割り当てられたデフォルトのパーミッションを表示するには、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が既存のワークブックに対応していない。 |
データソースの更新
データソースのプロジェクト、所有者、または認証を更新するには、データソースの更新 コマンドを使用します。
プロパティ
| プロパティ |
詳細 |
| データソースID |
更新するデータソースのIDを入力してください。 |
| プロジェクトID |
プロジェクトを更新するには、データソースを追加するプロジェクトのIDを入力します（オプション）。 |
| オブジェクトID |
所有者を更新するには、データソースの所有権を割り当てるユーザーのIDを入力します（オプション）。 |
| 公認 |
データソースが認証されている場合は、このボックスにチェックを入れます（オプション）。 |
| 証明書 |
該当する場合は、データソースの認証に関する追加情報を入力してください（オプション）。 |
出力
| 出力 |
出力タイプ |
| 更新されたデータソース |
JSON |
| データソース名 |
文字列 |
終了コード
| コード |
タイプ |
詳細 |
| 0 |
成功 |
成功 |
| 1 |
エラー |
無効な入力 |
| 2 |
エラー |
Tableauで認証できませんでした |
| 160 |
エラー |
管理者でないユーザーがデータソースの所有者を変更しようとしました。 |
| 163 |
エラー |
管理者以外のユーザーがデータソースのプロジェクトを変更しようとしましたが、呼び出し元にはプロジェクトの書き込み権限がありません。 |
| 165 |
エラー |
管理者以外のユーザーがデータソースを更新しようとしましたが、呼び出し元には書き込み権限がありません。 |
| 204 |
エラー |
オーナーIDが既存のユーザーと一致しない。 |
| 206 |
エラー |
データソースIDが既存のデータソースに対応していない。 |
| 207 |
エラー |
プロジェクトIDが既存のプロジェクトに対応していない |
| 244 |
エラー |
リクエストのデータソース名はすでに指定されたサイトに属しています。一意性を確保するため、データソース名は大文字と小文字を区別しません。 |
データソースの権限を更新する
Datasource 上の Group または User の権限を更新するには、Update Datasource Permissions コマンドを使用します。
プロパティ
| プロパティ |
詳細 |
| データソース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を入力してください。 |
| 能力名 |
追加するケイパビリティの名前を選択します。 |
| モード |
ケイパビリティを許可するか拒否するかを選択します。 |
出力
なし
終了コード
| コード |
タイプ |
詳細 |
| 0 |
成功 |
成功 |
| 1 |
エラー |
無効な入力 |
| 2 |
エラー |
Tableauで認証できませんでした |
| 137 |
エラー |
ユーザーがデータソースに権限を追加しようとしたが、呼び出し元にはその権限がない。 |
| 204 |
エラー |
オーナーIDが既存のユーザーと一致しない。 |
| 206 |
エラー |
データソースIDが既存のデータソースに対応していない。 |
| 214 |
エラー |
グループIDが既存のグループと一致しない。 |
| 215 |
エラー |
リクエストボディで指定されたケーパビリティが、定義されたケーパビリティに対応していない。ケーパビリティ名が無効であるか、いずれかのモード値に対してAllowまたはDeny以外のケーパビリティが指定されているため。 |
デフォルトのワークブックの権限を更新する
プロジェクトのワークブックのデフォルト権限を更新するには、 Update Default Workbook Permissions コマンドを使用します。
プロパティ
| プロパティ |
詳細 |
| プロジェクトID |
更新するプロジェクトのIDを入力します。 |
| IDタイプ（グループまたはユーザー） |
ユーザーまたはグループの権限を更新するかどうかを選択します。 |
| 身分証明書 |
権限を更新するグループのIDを入力してください。 |
| 能力名 |
追加するケイパビリティの名前を選択します。 |
| モード |
ケイパビリティを許可するか拒否するかを選択します。 |
出力
なし
終了コード
| コード |
タイプ |
詳細 |
| 0 |
成功 |
成功 |
| 1 |
エラー |
無効な入力 |
| 2 |
エラー |
Tableauで認証できませんでした |
| 137 |
エラー |
ユーザーがデータソースに権限を追加しようとしたが、呼び出し元にはその権限がない。 |
| 204 |
エラー |
オーナーIDが既存のユーザーと一致しない。 |
| 206 |
エラー |
データソースIDが既存のデータソースに対応していない。 |
| 214 |
エラー |
グループIDが既存のグループと一致しない。 |
| 215 |
エラー |
リクエストボディで指定されたケーパビリティが、定義されたケーパビリティに対応していない。ケーパビリティ名が無効であるか、いずれかのモード値に対してAllowまたはDeny以外のケーパビリティが指定されているため。 |
更新グループ
グループ名を更新するには、Update Group コマンドを使用する。
プロパティ
| プロパティ |
詳細 |
| グループID |
更新するグループのIDを入力します。 |
| 名称 |
プロジェクトの新しい名前を入力します（オプション）。 |
出力
| 出力 |
出力タイプ |
| 更新グループ |
JSON |
| グループID |
文字列 |
終了コード
| コード |
タイプ |
詳細 |
| 0 |
成功 |
成功 |
| 1 |
エラー |
無効な入力 |
| 2 |
エラー |
Tableauで認証できませんでした |
| 207 |
エラー |
URIのプロジェクトIDが既存のプロジェクトと一致しない。 |
| 214 |
エラー |
グループIDが既存のグループと一致しない。 |
| 235 |
エラー |
リクエストのプロジェクト名はすでに指定されたサイトに属しています。一意性を確保するため、プロジェクト名は大文字と小文字を区別しません。 |
| 238 |
エラー |
リクエストのグループ名は、指定されたサイトですでに使用されています。一意性を確保するため、グループ名は大文字と小文字を区別しない。 |
ハイパーエクストラクトの更新
CSV ファイルからハイパーエクストラクトにデータを追加するには、Update Hyper Extract コマンドを使用します。
プロパティ
| プロパティ |
詳細 |
| タブロー抜粋 |
新しいデータで更新するExtractファイルを入力します。 |
| ソースCSVファイル |
ハイパーファイルでデータを構築するために使用するファイルを入力します。 |
| ファイル形式 |
CSVファイルの形式を選択します。 |
| カラムの種類 |
ソース CSV ファイル の各列のタイプを入力する：INTEGER,DOUBLE,BOOLEAN,DATE,DATETIME,DURATION,CHAR_STRING,UNICODE_STRING, またはSPATIAL. |
出力
| 出力 |
出力タイプ |
| 解凍ファイル |
ファイル |
| 抽出サイズ（バイト） |
整数 |
| 処理された記録 |
整数 |
終了コード
| コード |
タイプ |
詳細 |
| 0 |
成功 |
成功 |
| 1 |
エラー |
無効な入力 |
| 2 |
エラー |
Tableauで認証できませんでした |
| 4 |
エラー |
ハイパーエクストラクト作成時の一般的なエラー |
| 5 |
エラー |
CSV入力ファイルが見つかりません。 |
| 6 |
エラー |
CSVが正しくフォーマットされていないか、ファイルのフォーマットが間違っている。 |
| 11 |
エラー |
カラムタイプの数がCSVのヘッダーカラムの数と一致しない。 |
| 12 |
エラー |
無効な列タイプ |
プロジェクトの更新
プロジェクトの親プロジェクト、名前、権限、説明を更新するには、Update Project コマンドを使用します。
プロパティ
| プロパティ |
詳細 |
| プロジェクトID |
更新するプロジェクトのIDを入力します。 |
| 親プロジェクトID |
プロジェクト階層を作成するには、親プロジェクトの識別子を入力します（オプション）。 |
| 名称 |
プロジェクトの新しい名前を入力します（オプション）。 |
| コンテンツの許可 |
プロジェクトの新しい権限設定を選択します（オプション）：
- ユーザーがプロジェクトに設定されたデフォルトのパーミッションを上書きできないようにパーミッションをロックするには、LockedToProjectを選択します。
- ユーザーが所有するコンテンツの権限を管理できるようにするには、ManagedByOwnerを選択します。
|
| 説明 |
プロジェクトの新しい説明を入力します（オプション）。 |
出力
| 出力 |
出力タイプ |
| 更新プロジェクト |
JSON |
| プロジェクトID |
文字列 |
終了コード
| コード |
タイプ |
詳細 |
| 0 |
成功 |
成功 |
| 1 |
エラー |
無効な入力 |
| 2 |
エラー |
Tableauで認証できませんでした |
| 138 |
エラー |
デフォルト・プロジェクトの名前を変更しようとした。 |
| 141 |
エラー |
サーバーに十分なストレージ容量が残っていないため、サンプルを公開できませんでした |
| 207 |
エラー |
プロジェクトIDが既存のプロジェクトに対応していない |
| 235 |
エラー |
リクエストのプロジェクト名はすでに指定されたサイトに属しています。一意性を確保するため、プロジェクト名は大文字と小文字を区別しない。 |
プロジェクトの権限を更新する
プロジェクトのグループまたはユーザーの権限を更新するには、Update Project Permissions コマンドを使用します。
プロパティ
| プロパティ |
詳細 |
| プロジェクトID |
更新するプロジェクトのIDを入力します。 |
| IDタイプ（グループまたはユーザー） |
ユーザーまたはグループの権限を更新するかどうかを選択します。 |
| 身分証明書 |
権限を更新するユーザーまたはグループのIDを入力します。 |
| 能力名 |
追加するケイパビリティの名前を選択します。 |
| モード |
ケイパビリティを許可するか拒否するかを選択します。 |
出力
なし
終了コード
| コード |
タイプ |
詳細 |
| 0 |
成功 |
成功 |
| 1 |
エラー |
無効な入力 |
| 2 |
エラー |
Tableauで認証できませんでした |
| 137 |
エラー |
ユーザーがプロジェクトに権限を追加しようとしましたが、呼び出し元にはその権限がありません。 |
| 204 |
エラー |
指定されたユーザーが既存のユーザーと一致しない。 |
| 207 |
エラー |
プロジェクトIDが既存のプロジェクトに対応していない |
| 214 |
エラー |
指定されたグループが既存のグループと一致しない。 |
| 215 |
エラー |
指定されたケイパビリティが定義されたケイパビリティに対応していない。ケイパビリティ名が無効であるか、いずれかのモード値に対してAlllowまたはDeny以外のケイパビリティが指定されているため。 |
TDEエキスの更新
CSV ファイルから TDE ファイルにデータを追加するには、Update TDE Extract コマンドを使用します。
プロパティ
| プロパティ |
詳細 |
| タブロー抜粋 |
新しいデータで更新する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 |
エラー |
TCSVが正しくフォーマットされていないか、ファイルのフォーマットが間違っている。 |
| 11 |
エラー |
カラムタイプの数がCSVのヘッダーカラムの数と一致しない。 |
| 12 |
エラー |
指定された列の型の1つが有効な型ではない |
ワークブックの更新
ワークブックのプロジェクト、所有者、またはタブの表示設定を更新するには、ワークブックの更新 コマンドを使用します。
プロパティ
| プロパティ |
詳細 |
| ワークブックID |
更新するワークブックのIDを入力します。 |
| プロジェクトID |
ワークブックを割り当てるプロジェクトのIDを入力します（オプション）。 |
| オーナーID |
所有者としてワークブックを割り当てるユーザーのIDを入力します（オプション）。 |
| タブを表示する |
公開されたワークブックのビューをタブで表示するには、このチェックボックスをオンにします（オプション）。 |
出力
| 出力 |
出力タイプ |
| ワークブックの更新 |
JSON |
| ワークブックID |
文字列 |
終了コード
| コード |
タイプ |
詳細 |
| 0 |
成功 |
成功 |
| 1 |
エラー |
無効な入力 |
| 2 |
エラー |
Tableauで認証できませんでした |
| 150 |
エラー |
管理者以外がワークブックの所有者を変更しようとしました。 |
| 158 |
エラー |
管理者以外がワークブックのプロジェクトを変更しようとしましたが、呼び出し元には対象プロジェクトの書き込み権限がありません。 |
| 160 |
エラー |
管理者以外がワークブックを変更しようとしましたが、呼び出し元にはワークブックの書き込み権限がありません。 |
| 204 |
エラー |
オーナーIDが既存のユーザーと一致しない。 |
| 207 |
エラー |
プロジェクトIDが既存のプロジェクトに対応していない |
| 208 |
エラー |
ワークブックIDが既存のワークブックに対応していない。 |
| 244 |
エラー |
リクエストのデータソース名はすでに指定されたサイトに属しています。一意性を確保するため、データソース名は大文字と小文字を区別しません。 |
ワークブックの権限を更新する
ワークブックのユーザーまたはグループの権限を更新するには、Workbook Permissions コマンドを使用します。
プロパティ
| プロパティ |
詳細 |
| ワークブックID |
更新するワークブックのIDを入力します。 |
| IDタイプ（グループまたはユーザー） |
グループまたはユーザーに関連付けられている権限を更新するかどうかを選択します。 |
| 身分証明書 |
権限を更新するグループまたはユーザーのIDを入力します。 |
| 能力名 |
追加するケイパビリティの名前を選択します。 |
| モード |
ケイパビリティを許可するか拒否するかを選択します。 |
出力
なし
終了コード
| コード |
タイプ |
詳細 |
| 0 |
成功 |
成功 |
| 1 |
エラー |
無効な入力 |
| 2 |
エラー |
Tableauで認証できませんでした |
| 137 |
エラー |
ユーザーがプロジェクトに権限を追加しようとしましたが、呼び出し元にはその権限がありません。 |
| 204 |
エラー |
オーナーIDが既存のユーザーと一致しない。 |
| 207 |
エラー |
プロジェクトIDが既存のプロジェクトに対応していない |
| 208 |
エラー |
ワークブックIDが既存のワークブックに対応していない。 |
| 214 |
エラー |
指定されたグループが既存のグループと一致しない。 |
| 215 |
エラー |
指定されたケイパビリティが、定義されたケイパビリティに対応していない。ケイパビリティ名が無効であるか、いずれかのモード値に対してAlllowまたはDeny以外のケイパビリティが指定されているため。 |