Workiva サポートセンター

シート削除

スプレッドシートからシートとその子シートを (再帰的に) 削除するには、Delete sheet コマンドを使用します。

同等の API コール: https://developers.workiva.com/2022-01-01/deletelegacysheet.html

プロパティ

出力

なし

閉じるコード

スプレッドシートの削除

ワークスペースからスプレッドシートを削除するには、Delete spreadsheet コマンドを使用します。

同等のAPIコール： https://developers.workiva.com/spreadsheets-v1/spreadsheets-deletespreadsheet/

プロパティ

出力

なし

閉じるコード

テーブルを削除

ワークスペースからWdataテーブルを削除するには、Delete table コマンドを使用する。

同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-deletetable/

プロパティ

出力

なし

閉じるコード

ファイルをダウンロード

Wdataワークスペースからデータセットをダウンロードするには、Download file コマンドを使う。

メモ： このコマンドは、スプレッドシート、テーブル、クエリなど、他のオブジェクトタイプには対応していません。

同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-downloadfile_1/

プロパティ

出力

閉じるコード

<!--

Download Pivot View

Downloads the content from a pivot view

Inputs

Outputs

Exit Codes

Download pivot view

To download the contents of a view, use a Download pivot view command.

Properties

Outputs

Exit codes

クエリ結果のダウンロード

Wdataクエリの結果をファイルにダウンロードするには、クエリ結果のダウンロードコマンドを使用します。

同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-downloadqueryresult/

プロパティ

出力

閉じるコード

編集

このコマンドはPlatform APIからのみ利用可能です。レコードを編集するには、Create new record edits エンドポイントを使用します。

スプレッドシートへのファイルエクスポート

Wdataテーブルから新規または既存のスプレッドシートにデータセットをエクスポートするには，Export file to spreadsheet コマンドを使用します。

同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-exportfiletospreadsheets/

プロパティ

出力

閉じるコード

クエリ結果のエクスポート

Wdataのクエリ結果を新規または既存のスプレッドシートにエクスポートするには、クエリ結果のエクスポート コマンドを使用します。

同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-exportqueryresulttospreadsheets/

プロパティ

出力

なし

閉じるコード

ファイルプロパティの取得

Wdataワークスペース内のファイルのプロパティを取得するには、Get file properties コマンドを使用する。

同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-getfile/

プロパティ

出力

閉じるコード

ピボットビューの取得

Wdata ビューのメタデータを取得するには、Get pivot view コマンドを使用します。

同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-getpivotview/

プロパティ

出力

閉じるコード

クエリメタデータの取得

Wdataクエリのメタデータを取得するには、Get query metadata コマンドを使用する。

同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-getquery/

プロパティ

出力

閉じるコード

レコードを取得する

このコマンドはPlatform APIからのみ利用可能です。レコードを取得するには、単一レコードの取得 エンドポイントを使用します。

レコードを取得する

このコマンドはPlatform APIからのみ利用可能です。複数のレコードを取得するには、レコードのリストを取得 エンドポイントを使用します。

レポートを入手する

組織のSOXおよび内部監査データベース・アカウントからすべてのレポートを取得するには、Get reports コマンドを使用します。

同等のAPIコール:https://developers.workiva.com/platform-v1/platform-graphreportexport/

プロパティ

なし

出力

閉じるコード

選択リストの取得

リストのIDに基づいて複数選択クエリ・パラメータの値のリストを取得するには、Get select list コマンドを使用します。

同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-getselectlist/

プロパティ

出力

閉じるコード

シートデータ取得

シートの指定領域内の全データを取得するには、シートデータを取得する コマンドを使用します。

同等のAPIコール： https://developers.workiva.com/spreadsheets-v1/spreadsheets-getdata/

プロパティ

出力

閉じるコード

シートのメタデータを取得する

スプレッドシート内のシートのメタデータを取得するには、Get sheet metadata コマンドを使用します。

同等のAPIコール: https://developers.workiva.com/2022-01-01/getsheetdata.html

プロパティ

出力

閉じるコード

スプレッドシートのメタデータを取得

スプレッドシートのメタデータを取得するには、Get spreadsheet metadata コマンドを使用する。

同等のAPIコール: https://developers.workiva.com/2022-01-01/getplatformspreadsheetbyid.html

プロパティ

出力

閉じるコード

テーブルのメタデータを取得する

Wdataテーブルのメタデータを取得するには、Get table metadata コマンドを使用する。

同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-gettable/

プロパティ

出力

閉じるコード

タイプ取得

このコマンドはPlatform APIからのみ利用可能です。レコードを取得するには、単一レコードの取得 エンドポイントを使用します。

タイプを取得する

このコマンドはPlatform APIからのみ利用可能です。複数のレコード・タイプを取得するには、Retrieve a list of types エンドポイントを使用します。
<!-- display page content -->

状態チェック

Wdata API の状態をチェックするには、Health check コマンドを使用する。

同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-healthcheck/

プロパティ

なし

出力

閉じるコード

ファイルをテーブルにインポート

ファイルを Wdata テーブルにインポートするには、ファイルをテーブルにインポート コマンドを使用する。

同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-importfile/

プロパティ

出力

閉じるコード

スプレッドシートをテーブルにインポート

スプレッドシートをテーブルにインポートし、ファイルメタ結果を返却するには、インポートスプレッドシートをテーブルにインポートコマンドを使用します。

同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-importfromspreadsheets/

プロパティ

出力

閉じるコード

接続一覧

Workiva プラットフォームの機能間のデータを一覧表示するには、List connections コマンドを使用します。

同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-listconnections/

注: リクエストは、ソースタイプ + ソースID、またはリンク先タイプ + リンク先ID；のいずれかを含んでいなければなりません。これらのペアのいずれかが存在しない場合、リクエストは失敗します。

出力

閉じるコード

ファイルエラー一覧

インポートなど、ファイルに関連するエラーをリストアップするには、List file errors コマンドを使用する。

同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-geterrors/

プロパティ

出力

閉じるコード

ファイル一覧

Wdataテーブル内のファイルとそのメタデータのリストを取得するには、List filesコマンドを使用します。

同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-getfiles/

プロパティ

出力

閉じるコード

ピボットビューの一覧表示

ワークスペース内の Wdata ビューを一覧表示して、そのメタデータを取得するには、List pivot views コマンドを使用します。

同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-listpivotviews/

プロパティ

なし

出力

閉じるコード

クエリの一覧表示

ワークスペース内のWdataクエリをリストアップし、そのメタデータを取得するには、List queries コマンドを使用します。

同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-listqueries/

プロパティ

なし

出力

閉じるコード

クエリ結果の一覧表示

Wdataクエリの利用可能な結果を一覧表示するには、List query results コマンドを使用します。

同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-listqueryresults/

プロパティ

出力

閉じるコード

選択リストの一覧表示

ワークスペース内の複数選択クエリ・パラメータの値のリストをすべて一覧表示し、そのメタデータを取得するには、List select lists コマンドを使用します。

同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-listselectlists/

プロパティ

なし

出力

閉じるコード

リストシート

スプレッドシート内の全シートを一覧表示し、そのメタデータを取得するには、List sheets コマンドを使用します。

同等のAPIコール: https://developers.workiva.com/2022-01-01/getlegacysheets.html

プロパティ

出力

閉じるコード

リストテーブル

ワークスペース内のすべてのWdataテーブルをリストアップし、そのメタデータを取得するには、List tables コマンドを使用する。

同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-gettables/

プロパティ

なし

出力

閉じるコード

ユーザー一覧

組織のユーザーに関する詳細リストを取得するには、List users コマンドを使用する。このコマンドを実行するには、割り当てられた統合ユーザーが組織の管理者権限を持っている必要があります。

組織管理者の「ピープル・ビュー」エクスポートと同様に、詳細は表示名で並べ替えられ、ユーザーの名前も含まれます：

• ユーザー名
• メールアドレス
• SAML ID
• 最終ログイン
• ワークスペース会員権
• ライセンスと役割

同等のAPIコール： https://developers.workiva.com/admin-v1/admin-getorgreportusers/

プロパティ

出力

閉じるコード

シートデータの上書き

シートのすべてのセルをクリアし、ファイルで提供された値で置換するには、Overwrite sheet data コマンドを使用する。

同等のAPIコール: https://developers.workiva.com/2022-01-01/updatesheet.html#

プロパティ

出力

閉じるコード

スプレッドシートの更新

スプレッドシートのリンクを更新するには、スプレッドシート コマンドを使用します。

同等のAPIコール： https://developers.workiva.com/spreadsheets-v1/spreadsheets-publish/

プロパティ

出力

閉じるコード

接続を更新

ID に基づいて特定の接続を更新するには、Refresh connection コマンドを使用します。

同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-refreshconnection/

プロパティ

メモ： マルチ選択パラメータは現在サポートされていない。

出力

閉じるコード

接続の一括更新

複数の接続を一度に更新するには、Refresh batch of connectionsコマンドを使用します。

同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-refreshbatch/

プロパティ

出力

閉じるコード

エッジの削除

このコマンドはPlatform APIからのみ利用可能です。エッジを削除するには、Create new record edits エンドポイントを使用します。

レコードのリストを取得する

絞込みフィルターに一致するレコードのリストを返却するには、Retrieve a list of records コマンドを使用する。少なくとも1つのフィルターは常に必要である。

同等のAPIコール: https://developers.workiva.com/platform-v1/platform-getrecords/

プロパティ

出力

閉じるコード

タイプ別リストの取得

レコード・タイプとその属性のリストを返却するには、Retrieve a list of types コマンドを使用する。このコマンドを使えば、レコードを検索する際の注意点を知ることができます。

同等のAPIコール: https://developers.workiva.com/platform-v1/platform-gettypes/

プロパティ

出力

閉じるコード

単一のレコードを取得する

単一のレコードを検索するには、Retrieve a list of records コマンドを使用します。一意な識別子は通常UUIDであるが、これは様々である。

同等のAPIコール: https://developers.workiva.com/platform-v1/platform-getrecordbyid/

プロパティ

出力

閉じるコード

タイプ別取得

単一のレコードを検索するには、Retrieve a list of records コマンドを使用します。一意な識別子は通常UUIDであるが、これは様々である。

同等のAPIコール: https://developers.workiva.com/platform-v1/platform-gettypebyid/

プロパティ

出力

閉じるコード

クエリの実行

Wdataクエリを実行し、その結果を取得するには、クエリの実行 コマンドを使用する。

同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-runquery/

プロパティ

出力

メモ： クエリ結果 出力にはIDが含まれ、これを使用して結果をダウンロードおよびエクスポートできる。

閉じるコード

レポートの実行

組織のSOXおよび内部監査データベースアカウントに保存したレポートを実行し、その結果をCSVファイルとして返却するには、Run report コマンドを使用します。

同等のAPIコール: https://developers.workiva.com/platform-v1/platform-getreportascsv/

プロパティ

出力

閉じるコード

設定エッジ

このコマンドはPlatform APIからのみ利用可能です。エッジを設定するには、Create new record edits エンドポイントを使用する。

レコードプロパティの設定

このコマンドはPlatform APIからのみ利用可能です。レコードのプロパティを設定するには、Create new record edits エンドポイントを使用します。

テーブルからのファイルインポート解除

Wdataテーブルからファイルのインポートを解除して削除するには、Un-import file From tableコマンドを使用します。

同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-unimportfile/

プロパティ

出力

閉じるコード

ピボットビューの更新

Wdata ビューのメタデータを更新するには、Update pivot view コマンドを使用します。

同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-updatepivotview/

プロパティ

出力

閉じるコード

クエリ定義の更新

Wdataクエリのプロパティを更新するには、クエリ定義の更新 コマンドを使用します。

同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-updatequery/

プロパティ

出力

閉じるコード

選択リストの更新

複数選択クエリ・パラメータの値のリストのプロパティまたはアイテムを更新するには、選択リストの更新 コマンドを使用します。

同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-updateselectlist/

プロパティ

出力

閉じるコード

シートのメタデータを更新する

スプレッドシートのシートのメタデータを更新するには、シートメタデータの更新 コマンドを使用します。

同等のAPIコール： https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatesheet/

プロパティ

出力

なし

閉じるコード

スプレッドシートのメタデータを更新

スプレッドシートのメタデータを更新するには、スプレッドシートのメタデータを更新 コマンドを使用します。

同等のAPIコール: https://developers.workiva.com/2022-01-01/updatesheet.html

プロパティ

出力

なし

閉じるコード

テーブルの更新

Wdataテーブルの列を更新するには、Update table コマンドを使用する。

同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-updatetable/

プロパティ

出力

閉じるコード

シートデータの書き込み

CSV データセットのデータをシートの特定の領域に書き込むには、Write sheet data コマンドを使用します。

プロパティ

出力

閉じるコード