他のデータソースとのデータ交換を可能にするなど、チェーンの一部として Workiva プラットフォーム内のタスクを自動化するには、Workiva 接続コマンドを含むステップを追加します。
これらのコマンドを有効にするには、IT 管理者がまずWorkiva コネクタ を設定します。
クリアシートのデータ
シート内のすべてのデータを消去するには、シート・データの消去 コマンドを使用します。
同等のAPIコール: https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatedataasync/
プロパティ
プロパティ | 詳細 |
---|---|
スプレッドシート ID | クリアするシートのスプレッドシートの一意の識別子を入力します。 |
シートID/名前 | クリアするシートの名前または一意の識別子を入力します。 |
出力
なし
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
ファイル作成
カンマ区切り値(CSV)、Javascriptオブジェクト記法(JSON)、または圧縮ZIPファイルをアップロードし、そのレコードを一覧表示するには、Create file コマンドを使用します。また、S3バケット内のファイルへのAmazon S3®署名付きURLなど、ファイルへのURLをアップロードすることもできます。
- JSONファイルは、改行文字で区切られた一連のJSONオブジェクトです。
- ZIPファイルの場合、CSVまたはJSONファイルが1つ含まれていなければならず、そのファイル名がインポートされたファイルの名前に使用される。ファイルを再度ダウンロードすると、ソースがダウンロードされる。
- URLの場合、エンドポイントは単純な認証されていない
GET
リクエストを使ってファイルを取得するリクエストを行う。
同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-uploadfile/
プロパティ
プロパティ | 詳細 |
---|---|
テーブル ID | ファイルの一覧を表示するテーブルのIDを入力します。 |
ファイル | アップロードするファイルを入力します。ダウンロードURL が入力されている場合は無視される。注: 拡張子が.CSVまたは.JSONのファイル、または拡張子が.CSVまたは.JSONのファイルを含むZIPファイルである必要があります。 |
名称 | ダウンロードURL が入力されている場合、アップロードするファイル名を入力する。デフォルトでは、ダウンロードURL がベース名となる。 |
ダウンロードURL | Amazon S3の署名付きURLなど、ダウンロードするファイルを指すURLを入力します。File 。 注: このコマンドは、認証なしで、URLに対して単純な |
出力
出力 | 出力タイプ |
---|---|
結果 | JSON |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
新規レコードの編集
与えられたプロパティを指定して新しいレコード編集を作成するには、Create new record edits コマンドを使用します。各編集には少なくともoperationとtargetIdが必要である。
制限:
- 1回のリクエストにつき1000回まで編集できます。
同等のAPIコール: https://developers.workiva.com/platform-v1/platform-createedits/
プロパティ
プロパティ | 詳細 |
---|---|
オペレーション |
実行する操作を選択します。 オプション :
|
ラベル | 2つのレコードの関係を示すラベルを入力する。リレーションシップを作成または削除するために使用します。 |
プロパティ | レコードタイプに関連するプロパティを入力する。レコードの作成やプロパティの設定に使用する。 |
レコードID | ソースのIDまたは一時レコードIDを入力します。リレーションシップを作成または削除するために使用します。 |
ターゲット ID | 対象レコードのIDを入力してください。レコードを作成する場合は、レコードIDまたは一時レコードIDのいずれかを使用できますが、レコードを削除する場合は、実際のレコードIDを使用する必要があります。 |
一時レコードID | レコード作成時に使用されるテンポラリIDを入力します。このテンポラリIDは処理時に置き換えられます。作成されたレコード間のリレーションシップを作成するために、同じリクエスト内でこのIDを使用することができます。 |
タイプ | 作成するレコードのタイプを入力します。 |
出力
出力 | 出力タイプ |
---|---|
ピボットビュー | JSON |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
ピボットビューの作成
クエリとクエリ結果を指定して新しい Wdata ビューを作成するには、Create pivot view コマンドを使用します。
同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-createpivotview/
プロパティ
プロパティ | 詳細 |
---|---|
名称 | ビューを識別するための一意の名前を入力します。 |
クエリーID | ビューを作成するクエリの ID を入力します。 |
クエリー結果ID | ビューを作成するクエリ結果の ID を入力します。 |
追加メタデータ | JSONオブジェクトとしてビューに添付するユーザー定義のメタデータを入力します(オプション)。 |
出力
出力 | 出力タイプ |
---|---|
ピボットビュー | JSON |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
プレビュークエリの作成
テーブルに一時的なプレビュー・クエリを作成して実行するには、Create preview query コマンドを使用します。
同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-previewqueryusingpost/
プロパティ
プロパティ | 詳細 |
---|---|
テーブル ID | クエリーするテーブルのIDを入力してください。 |
制限 | 返す結果の最大数を入力します。 |
ファイル | 指定する場合は、クエリーするテーブルのファイル名を入力する。 |
出力
出力 | 出力タイプ |
---|---|
クエリ | JSON |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
クエリの作成
新しい Wdata クエリーを作成するには、Create query コマンドを使用します。
同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-createquery/
プロパティ
プロパティ | 詳細 |
---|---|
名称 | クエリを識別するための一意の名前を入力します。 |
説明 | クエリの説明を入力します。 |
主な結果ID | 指定されている場合は、クエリ結果に入力するデフォルトの結果の ID を入力します。 |
クエリーテキスト | Presto SQL構文としてクエリ定義を入力します。クエリのSQLエディタ と同じように入力します。 |
臨時 | クエリを一時的に生成してワークスペースに 表示しないようにするには、このボックスをオンにします。 |
パラメータ | クエリの実行に必要なパラメータを入力します。 |
出力
出力 | 出力タイプ |
---|---|
クエリ | JSON |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
レコードの作成
このコマンドは、Platform APIを通じてのみ利用できる。新しいレコードを作成するには、Create new record edits エンドポイントを使用します。
選択リストの作成
複数選択クエリ・パラメータの値のリストを作成するには、Create select list コマンドを使用します。
同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-createselectlist/
プロパティ
プロパティ | 詳細 |
---|---|
名称 | セレクトリストの識別に役立つユニークな名前を入力します。 |
説明 | セレクトリストをさらに識別しやすくするために、その値やパラメーターの説明を入力します。 |
値のタイプ | 文字列や整数など、リストの値のデータ型を選択する。 |
値 | リストの値を入力する。 |
出力
出力 | 出力タイプ |
---|---|
セレクトリストのメタデータを作成する | JSON |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー |
エラー |
シート作成
スプレッドシートに新しいシートを追加するには、Create sheet 。
同等のAPIコール: https://developers.workiva.com/spreadsheets-v1/spreadsheets-createsheet/
プロパティ
プロパティ | 詳細 |
---|---|
スプレッドシート ID | シートを追加するスプレッドシートの一意の識別子を入力します。 |
名称 | シートを識別するための固有の名前を入力します。 |
シート索引 | スプレッドシート内の新しいシートのインデックスを入力する。注: デフォルトでは、このコマンドはシートをトップシートとして追加します。 |
親シートのID | シートを作成する親シートのIDを入力します。ルートスプレッドシートに追加する場合は、空白のままにする。 |
出力
出力 | 出力タイプ |
---|---|
シートのメタデータ | JSON |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
スプレッドシートの作成
新しいスプレッドシートを作成するには、Create spreadsheet コマンドを使用する。
同等のAPIコール: https://developers.workiva.com/spreadsheets-v1/spreadsheets-createspreadsheet/
プロパティ
プロパティ | 詳細 |
---|---|
名称 | スプレッドシートを識別するための固有の名前を入力します。 |
出力
出力 | 出力タイプ |
---|---|
シートのメタデータ | JSON |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
テーブルを作成
ワークスペースに新しい Wdata テーブルを作成するには、Create table コマンドを使用します。
同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-createtable/
プロパティ
プロパティ | 詳細 |
---|---|
名称 | テーブルを識別するための一意の名前を入力します。 |
説明 | 新しいテーブルの説明を入力する。 |
タイプ | データ・テーブル (またはファクト) とルックアップ・テーブル (またはディメンジョン) のどちらを作成するかを選択します。 |
列 | テーブルに含める列を追加する:
|
出力
出力 | 出力タイプ |
---|---|
テーブル | JSON |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
ファイルを削除
Wdataワークスペースからファイルを削除するには、Delete file コマンドを使用します。
同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-deletefile/
プロパティ
プロパティ | 詳細 |
---|---|
ファイルID | 削除するファイルのIDを入力します。 |
出力
なし
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
ピボットビューの削除
ワークスペースから Wdata ビューを削除するには、削除ピボット・ビュー コマンドを使用します。
同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-deletepivotview/
プロパティ
プロパティ | 詳細 |
---|---|
身分証明書 | 削除するビューのIDを入力します。 |
出力
なし
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
クエリの削除
ワークスペースから Wdata クエリを削除するには、 Delete query コマンドを使用します。
同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-deletequery/
プロパティ
プロパティ | 詳細 |
---|---|
クエリーID | 削除するクエリのIDを入力してください。 |
出力
なし
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
レコードの削除
このコマンドは、Platform APIを通じてのみ利用できる。レコードを削除するには、Create new record edits エンドポイント。シート削除
スプレッドシートからシートとその子シートを(再帰的に)削除するには、シートの削除コマンドを使用します。プロパティ
プロパティ | 詳細 |
---|---|
スプレッドシート ID | 削除するシートのあるスプレッドシートの一意の識別子を入力します。 |
シートID/名前 | 削除するシートの名前または一意の識別子を入力します。 |
出力
なし
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
スプレッドシートの削除
ワークスペースからスプレッドシートを削除するには、Delete spreadsheet コマンドを使用します。
同等のAPIコール: https://developers.workiva.com/spreadsheets-v1/spreadsheets-deletespreadsheet/
プロパティ
プロパティ | 詳細 |
---|---|
スプレッドシート ID | 削除するスプレッドシートの一意の識別子を入力します。 |
出力
なし
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
テーブルを削除
ワークスペースから Wdata テーブルを削除するには、Delete table コマンドを使用します。
同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-deletetable/
プロパティ
プロパティ | 詳細 |
---|---|
テーブル ID | 削除するテーブルの一意な識別子を入力する。 |
出力
なし
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
ファイルをダウンロード
Wdataワークスペースからデータセットをダウンロードするには、Download file コマンドを使う。
注: このコマンドは、スプレッドシート、テーブル、クエリなどの他のオブジェクト・タイプとは互換性がありません。
同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-downloadfile_1/
プロパティ
プロパティ | 詳細 |
---|---|
ファイルID | ダウンロードするファイルのIDを入力してください。 |
出力
出力 | 出力タイプ |
---|---|
ファイル | ファイル |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
<!--
Download Pivot View
Downloads the content from a pivot view
Inputs
Input | Detail |
ID | Enter the ID of the pivot view to download |
Outputs
Output | Output Type |
Pivot View Content | File |
Exit Codes
Code | Type | Detail |
0 | Success | Success |
1 | Error | Error |
Download pivot view
To download the contents of a view, use a Download pivot view command.
Properties
Property | Detail |
---|---|
ID | Enter the ID of the view to download. |
Outputs
Output | Output Type |
---|---|
Pivot view content | File |
Exit codes
Code | Type | Detail |
---|---|---|
0 | Success | Success |
1 | Error | Error |
クエリ結果のダウンロード
Wdataクエリの結果をファイルにダウンロードするには、クエリ結果のダウンロード コマンドを使用する。
同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-downloadqueryresult/
プロパティ
プロパティ | 詳細 |
---|---|
クエリー結果ID | ダウンロードするクエリー結果のIDを入力してください。 |
出力
出力 | 出力タイプ |
---|---|
クエリー結果 | ファイル |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
編集
このコマンドは、Platform APIを通じてのみ利用できる。レコードを編集するには、Create new record edits エンドポイントを使用します。
ファイルをスプレッドシートにエクスポート
Wdataテーブルから新規または既存のスプレッドシートにデータセットをエクスポートするには、Export file to spreadsheet コマンドを使用する。
同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-exportfiletospreadsheets/
プロパティ
プロパティ | 詳細 |
---|---|
ファイルID | エクスポートするテーブル・データセットのIDを入力してください。 |
スプレッドシートのURL | エクスポート先のスプレッドシートのURLを入力してください。新しいスプレッドシートを作成する場合は、空白のままにする。 |
出力
出力 | 出力タイプ |
---|---|
シート情報 | ファイル |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
クエリー結果のエクスポート
Wdata のクエリー結果を新規または既存のスプレッドシートにエクスポートするには、Export query result コマンドを使用します。
同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-exportqueryresulttospreadsheets/
プロパティ
プロパティ | 詳細 |
---|---|
クエリー結果ID | エクスポートするクエリ結果のIDを入力します。 |
スプレッドシートのURL |
エクスポート先のスプレッドシートのURLを入力してください。新しいスプレッドシートを作成する場合は、空白のままにする。 |
データセットとしてエクスポート |
チェックすると、データは連結されたデータセットとしてエクスポートされ、セルの編集はスプレッドシートのデータセットを更新することによってのみ可能になります。 |
出力
なし
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
ファイルのプロパティを取得する
Wdataワークスペース内のファイルのプロパティを取得するには、Get file properties コマンドを使用します。
同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-getfile/
プロパティ
プロパティ | 詳細 |
---|---|
ファイルID | プロパティを取得するファイルのIDを入力します。 |
出力
出力 | 出力タイプ |
---|---|
ファイルのプロパティ | JSON |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
ピボットビューの取得
Wdata ビューのメタデータを取得するには、Get pivot view コマンドを使用します。
同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-getpivotview/
プロパティ
プロパティ | 詳細 |
---|---|
身分証明書 | メタデータを取得するピボット・ビューの ID を入力します。 |
出力
出力 | 出力タイプ |
---|---|
ピボットビュー | JSON |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
クエリのメタデータを取得する
Wdataクエリのメタデータを取得するには、Get query metadata コマンドを使用する。
同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-getquery/
プロパティ
プロパティ | 詳細 |
---|---|
クエリーID | メタデータを取得するクエリのIDを入力します。 |
出力
出力 | 出力タイプ |
---|---|
クエリ | JSON |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
レコードを取得する
このコマンドは、Platform APIを通じてのみ利用できる。レコードを取得するには、単一レコードの取得 エンドポイントを使用します。
レコードを取得する
このコマンドは、Platform APIを通じてのみ利用できる。複数のレコードを取得するには、Retrieve a list of records エンドポイントを使用します。
レポートを入手する
組織のSOXおよび内部監査データベース・アカウントからすべてのレポートを取得するには、Get reports コマンドを使用します。
同等のAPIコール: https://developers.workiva.com/platform-v1/platform-graphreportexport/
プロパティ
なし
出力
出力 | 出力タイプ |
---|---|
レポート | ファイル |
レポート数 | 整数 |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
選択リストの取得
リストのIDに基づいて複数選択クエリ・パラメータの値のリストを取得するには、Get select list コマンドを使用します。
同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-getselectlist/
プロパティ
プロパティ | 詳細 |
---|---|
リストIDを選択 | 検索するセレクトリストの一意な識別子を入力してください。 |
出力
出力 | 出力タイプ |
---|---|
セレクトリストのペイロードを取得 | JSON |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
シートデータ取得
シートの指定領域内の全データを取得するには、Get sheet data コマンドを使用します。
同等のAPIコール: https://developers.workiva.com/spreadsheets-v1/spreadsheets-getdata/
プロパティ
プロパティ | 詳細 |
---|---|
スプレッドシート ID | データを取得するシートのあるスプレッドシートの一意の識別子を入力します。 |
シートID/名前 | データを取得するシートの名前または一意の識別子を入力します。 |
地域 |
[開始列][開始行]:[停止列][停止行] のように、セルまたは範囲のA1スタイルの表現を入力する。任意の方向またはすべての方向に範囲を制限しないようにするには、対応する列または行を削除します。 |
バリュー・スタイル | 生のセル値を返すか、計算されたセル値を返すかを選択する。例えば、セルの値が=1+:1 の場合、=1+1ならRawを、計算値2ならCalculatedを選択する。 |
リビジョン | データを取得するシートのバージョンを入力します。現在のバージョンには-1を入力する。 |
出力
出力 | 出力タイプ |
---|---|
行数 | 整数 |
データ | ファイル |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
シートのメタデータを取得する
スプレッドシート内のシートのメタデータを取得するには、Get sheet metadata コマンドを使用します。
同等のAPIコール: https://developers.workiva.com/spreadsheets-v1/spreadsheets-getsheet/
プロパティ
プロパティ | 詳細 |
---|---|
スプレッドシート ID | メタデータを取得するシートのあるスプレッドシートの一意な識別子を入力します。 |
シートID/名前 | メタデータを取得するシートの名前または一意の識別子を入力します。 |
出力
出力 | 出力タイプ |
---|---|
シートのメタデータ | JSON |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
スプレッドシートのメタデータを取得する
スプレッドシートのメタデータを取得するには、Get spreadsheet metadata コマンドを使用する。
同等のAPIコール: https://developers.workiva.com/spreadsheets-v1/spreadsheets-getspreadsheet/
プロパティ
プロパティ | 詳細 |
---|---|
スプレッドシート ID | メタデータを取得するスプレッドシートの一意な識別子を入力します。 |
出力
出力 | 出力タイプ |
---|---|
スプレッドシートのメタデータ | JSON |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
テーブルのメタデータを取得する
Wdataテーブルのメタデータを取得するには、Get table metadata コマンドを使用する。
同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-gettable/
プロパティ
プロパティ | 詳細 |
---|---|
テーブル ID | メタデータを取得するテーブルの一意な識別子を入力します。 |
出力
出力 | 出力タイプ |
---|---|
テーブル | JSON |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
タイプを取得する
このコマンドは、Platform APIを通じてのみ利用できる。レコードを取得するには、単一レコードの取得 エンドポイントを使用します。
タイプを取得する
このコマンドは、Platform APIを通じてのみ利用できる。複数のレコード・タイプを取得するには、タイプのリストを取得 エンドポイントを使用します。
<!-- display page content -->
健康チェック
Wdata API の健全性をチェックするには、Health check コマンドを使用する。
同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-healthcheck/
プロパティ
なし
出力
出力 | 出力タイプ |
---|---|
応答 | JSON |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
ファイルをテーブルにインポートする
ファイルを Wdata テーブルにインポートするには、ファイルをテーブルにインポート コマンドを使用する。
同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-importfile/
プロパティ
プロパティ | 詳細 |
---|---|
テーブル ID | ファイルをインポートするテーブルのIDを入力します。 |
ファイルID | テーブルにインポートするファイルのIDを入力してください。 |
カラムマッピング | ファイルの各カラムをテーブルのカラムにマッピングする。 |
非同期実行 | コマンドを非同期で実行し、 、インポートが完了するまで待ってからチェインを続行するには、このボックスにチェックを入れます。 |
タグ | あなたの組織がデータについて追跡しているメタデータを含めるには、タグを追加し、その名前と値を選択します。 |
出力
出力 | 出力タイプ |
---|---|
ファイルインポート | JSON |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
スプレッドシートをテーブルにインポートする
スプレッドシートをテーブルにインポートし、ファイルメタ結果を返すには、インポート・スプレッドシートをテーブルにインポート コマンドを使用する。
同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-importfromspreadsheets/
プロパティ
プロパティ | 詳細 |
---|---|
テーブル ID | ファイルをインポートするテーブルの一意の識別子を入力します。 |
ファイルID | スプレッドシートをインポートするファイルの一意の識別子を入力します(オプション)。 |
ファイル名 | テーブルにインポートする際にファイルに付ける一意の名前を入力します。 |
スプレッドシートのURL | データをインポートするスプレッドシートの完全なURLを入力します。 |
非同期実行 | コマンドを非同期で実行し、 、インポートが完了するまで待ってからチェインを続行するには、このボックスにチェックを入れます。 |
タグ | あなたの組織がデータについて追跡しているメタデータを含めるには、タグを追加し、その名前と値を選択します。 |
出力
出力 | 出力タイプ |
---|---|
ファイルインポート | JSON |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
リスト接続
Workiva プラットフォームの機能間のデータを一覧表示するには、List connections コマンドを使用します。
同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-listconnections/
プロパティ | 詳細 |
---|---|
ソース・タイプ | ドロップダウンメニューを使用して、データをプルするファイルまたはアイテムのタイプを選択します。 |
デスティネーション・タイプ | ドロップダウンメニューを使用して、データを送信するファイルまたはアイテムのタイプを選択します。 |
ソースID | データを取得するファイルまたはアイテムの一意の識別子を入力します。 |
デスティネーションID | データを送信するファイルまたはアイテムの一意の識別子を入力します。 |
注: リクエストは、Source Type + Source ID 、またはDestination Type + Destination ID 、これらのペアのいずれかが存在しないと、リクエストは失敗する。
出力
出力 | 出力タイプ |
---|---|
接続 | JSON |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
ファイルエラー一覧
インポートなどによるファイルに関連するエラーを一覧表示するには、List file errors コマンドを使用します。
同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-geterrors/
プロパティ
プロパティ | 詳細 |
---|---|
ファイルID | エラーを取得するファイルのIDを入力します。 |
出力
出力 | 出力タイプ |
---|---|
エラーリスト | JSON |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
ファイル一覧
Wdataテーブル内のファイルとそのメタデータのリストを取得するには、List files コマンドを使用する。
同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-getfiles/
プロパティ
プロパティ | 詳細 |
---|---|
テーブル ID | ファイルを取得するテーブルのIDを入力します。 |
出力
出力 | 出力タイプ |
---|---|
ファイル一覧 | ファイル |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
ピボットビューの一覧表示
ワークスペース内の Wdata ビューを一覧表示してそのメタデータを取得するには、List pivot views コマンドを使用します。
同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-listpivotviews/
プロパティ
なし
出力
出力 | 出力タイプ |
---|---|
ピボット・ビュー | JSON |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
クエリの一覧表示
ワークスペース内の Wdata クエリを一覧表示し、そのメタデータを取得するには、List queries コマンドを使用します。
同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-listqueries/
プロパティ
なし
出力
出力 | 出力タイプ |
---|---|
クエリ | JSON |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
クエリ結果の一覧表示
Wdataクエリで利用可能な結果を一覧表示するには、List query results コマンドを使用します。
同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-listqueryresults/
プロパティ
プロパティ | 詳細 |
---|---|
クエリーID | 結果を取得するクエリのIDを入力します。 |
出力
出力 | 出力タイプ |
---|---|
クエリー結果 | JSON |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
選択リストの一覧表示
ワークスペース内の複数選択クエリ・パラメータの値のリストをすべて表示し、そのメタデータを取得するには、List select lists コマンドを使用します。
同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-listselectlists/
プロパティ
なし
出力
出力 | 出力タイプ |
---|---|
選択リストの一覧表示 | JSON |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
リストシート
スプレッドシート内のすべてのシートを一覧表示し、そのメタデータを取得するには、List sheets コマンドを使用します。
同等のAPIコール: https://developers.workiva.com/spreadsheets-v1/spreadsheets-getspreadsheet/
プロパティ
プロパティ | 詳細 |
---|---|
スプレッドシート ID | シートを一覧表示するスプレッドシートの一意の識別子を入力します。 |
出力
出力 | 出力タイプ |
---|---|
シート | JSON |
枚数 | 整数 |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
リストテーブル
ワークスペース内のすべてのWdataテーブルを一覧表示し、そのメタデータを取得するには、List tables コマンドを使用する。
同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-gettables/
プロパティ
なし
出力
出力 | 出力タイプ |
---|---|
テーブルリスト | JSON |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
ユーザー一覧
組織のユーザーに関する詳細のリストを取得するには、List users コマンドを使用する。このコマンドを実行するには、割り当てられた統合ユーザが組織管理者ロールを持っている必要があります。
組織管理者の "People View "エクスポートと同様に、詳細は表示名でソートされ、ユーザーのものも含まれます:
- ユーザー名
- メールアドレス
- SAML ID
- 最終ログイン
- ワークスペース会員
- ライセンスと役割
同等のAPIコール: https://developers.workiva.com/admin-v1/admin-getorgreportusers/
プロパティ
プロパティ | 詳細 |
---|---|
組織の ID | ユーザーをリストアップする組織の一意の識別子を入力します。 |
出力
出力 | 出力タイプ |
---|---|
ユーザーレポート | ファイル |
レコード数 | 整数 |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
シートデータの上書き
シート内のすべてのセルを消去し、ファイルで提供された値に置き換えるには、シート・データを上書きする コマンドを使用します。
同等のAPIコール: https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatedata/
プロパティ
プロパティ | 詳細 |
---|---|
スプレッドシート ID | シートデータを上書きするスプレッドシートの一意の識別子を入力します。 |
シートID/名前 | データを上書きするシートの名前または一意の識別子を入力します。 |
データファイル | シートに入力するデータを含むCSVファイルを入力します。 |
区切り記号 | データファイル で使用されている区切り記号を入力する。 |
プラットフォームAPIを使用する | スプレッドシートのセル値のEntered in フォーマットを使用するには、このボックスをチェックします。 |
出力
出力 | 出力タイプ |
---|---|
列 | 整数 |
書かれた細胞 | 整数 |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
スプレッドシートの公開
スプレッドシートのリンクを公開するには、Publish spreadsheet コマンドを使用します。
同等のAPIコール: https://developers.workiva.com/spreadsheets-v1/spreadsheets-publish/
プロパティ
プロパティ | 詳細 |
---|---|
スプレッドシート ID | 公開するスプレッドシートの一意の識別子を入力します。 |
すべてのリンクを更新 | スプレッドシートのどのリンクを公開するかを選択する:
|
出力
出力 | 出力タイプ |
---|---|
メッセージ | 文字列 |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
接続を更新
IDに基づいて特定の接続をリフレッシュするには、Refresh connection コマンドを使用します。
同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-refreshconnection/
プロパティ
プロパティ | 詳細 |
---|---|
接続 ID | リフレッシュする接続の一意の識別子を入力します。 |
以前のソース・パラメータを使用する | 前回実行時のソース・パラメータを使用する場合は、このボックスにチェックを入れます。 この入力は "Refresh batch of connections "エンドポイントでは無視される。 |
ソース・パラメーター |
リフレッシュ成功時にソースに送信するパラメータを入力します。 (これらのパラメータは、"Use previous source parameters "が有効な場合、無視される)。 |
以前のデスティネーション・パラメーターを使用する | 指定した他のデスティネーションパラメータよりも優先されます。 この入力は "Refresh batch of connections "エンドポイントでは無視される。 |
デスティネーション・パラメーター |
リフレッシュ成功時にデスティネーションに送信するパラメータを入力する。 (これらのパラメータは、"Use previous destination parameters "が有効になっている場合、無視される)。 |
注: マルチセレクトパラメーターは現在サポートされていません。
出力
出力 | 出力タイプ |
---|---|
リフレッシュ状況 | JSON |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
接続の一括更新
複数の接続を一度にリフレッシュするには、Refresh batch of connections コマンドを使用します。
同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-refreshbatch/
プロパティ
プロパティ | 詳細 |
---|---|
接続 |
変数の使用の有効/無効を切り替える。 有効な場合:
|
接続 ID | リフレッシュする接続の一意の識別子を入力します。 |
以前のソース・パラメータを使用する | 前回実行時のソース・パラメータを使用する場合は、このボックスにチェックを入れます。 この入力は "Refresh batch of connections "エンドポイントでは無視される。 |
ソース・パラメーター |
リフレッシュ成功時にソースに送信するパラメータを入力します。 (これらのパラメータは、"Use previous source parameters "が有効な場合、無視される)。 |
以前のデスティネーション・パラメーターを使用する | 指定した他のデスティネーションパラメータよりも優先されます。 この入力は "Refresh batch of connections "エンドポイントでは無視される。 |
目的地パラメーター |
リフレッシュ成功時にデスティネーションに送信するパラメータを入力する。 (これらのパラメータは、"Use previous destination parameters "が有効になっている場合、無視される)。 |
出力
出力 | 出力タイプ |
---|---|
バッチ・リフレッシュ・ステータス | JSON |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
エッジの除去
このコマンドは、Platform APIを通じてのみ利用できる。エッジを削除するには、Create new record edits エンドポイントを使用します。
レコードのリストを取得する
指定されたフィルターに一致するレコードのリストを返すには、Retrieve a list of records コマンドを使用します。少なくとも1つのフィルターは常に必要である。
同等のAPIコール: https://developers.workiva.com/platform-v1/platform-getrecords/
プロパティ
プロパティ | 詳細 |
---|---|
展開 |
関連リソースをメインリソースとインラインで返します。 オプション :
|
フィルター | 結果をフィルタリングするプロパティ。 |
出力
出力 | 出力タイプ |
---|---|
バッチ・リフレッシュ・ステータス | JSON |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
タイプのリストを取得する
レコード・タイプとその属性のリストを返すには、Retrieve a list of types コマンドを使用する。このコマンドを使えば、レコードを検索する際の注意点を知ることができる。
同等のAPIコール: https://developers.workiva.com/platform-v1/platform-gettypes/
プロパティ
プロパティ | 詳細 |
---|---|
展開 |
関連リソースをメインリソースとインラインで返します。 オプション :
|
出力
出力 | 出力タイプ |
---|---|
バッチ・リフレッシュ・ステータス | JSON |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
単一のレコードを取得する
単一のレコードを検索するには、Retrieve a list of records コマンドを使用する。一意な識別子は通常UUIDであるが、これは様々である。
同等のAPIコール: https://developers.workiva.com/platform-v1/platform-getrecordbyid/
プロパティ
プロパティ | 詳細 |
---|---|
展開 |
関連リソースをメインリソースとインラインで返します。 オプション :
|
レコードID | レコードの一意の識別子を入力します。 |
出力
出力 | 出力タイプ |
---|---|
バッチ・リフレッシュ・ステータス | JSON |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
単一の型を取得する
単一のレコードを検索するには、Retrieve a list of records コマンドを使用する。一意な識別子は通常UUIDであるが、これは様々である。
同等のAPIコール: https://developers.workiva.com/platform-v1/platform-gettypebyid/
プロパティ
プロパティ | 詳細 |
---|---|
展開 |
関連リソースをメインリソースとインラインで返します。 オプション :
|
レコードID | レコードの一意の識別子を入力します。 |
出力
出力 | 出力タイプ |
---|---|
バッチ・リフレッシュ・ステータス | JSON |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
クエリの実行
Wdata クエリを実行し、その結果を取得するには、Run query コマンドを使用する。
同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-runquery/
プロパティ
プロパティ | 詳細 |
---|---|
クエリーID | 実行するクエリのIDを入力します。 |
パラメータ | クエリにパラメータが定義されている場合は、その名前と値のマップを追加します。注: Multi-select params に、マルチセレクトパラメーターの値を入力する。 |
非同期実行 | クエリーを非同期で実行し、 クエリーが終了するまでコマンドを完了するまで待たないようにするには、このボックスをチェックします。 |
マルチセレクトパラメータ | クエリに複数の選択パラメータが定義されている場合は、それぞれの名前と値を追加します。 |
出力
出力 | 出力タイプ |
---|---|
クエリー結果 | JSON |
注: Query Result 出力にはIDが含まれており、これを使用して結果をダウンロードおよびエクスポートすることができる。
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
レポートの実行
組織のSOXおよび内部監査データベースアカウントに保存されたレポートを実行し、その結果をCSVファイルとして返すには、Run report コマンドを使用します。
同等のAPIコール: https://developers.workiva.com/platform-v1/platform-getreportascsv/
プロパティ
プロパティ | 詳細 |
---|---|
レポートID | 保存されたレポートを含むレポートの一意の識別子を入力します。 |
コンテンツのプレビュー | レポート結果のプレビューをコマンドのログに含めるには、このボックスをチェックする。 |
出力
出力 | 出力タイプ |
---|---|
レポート | ファイル |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
セットエッジ
このコマンドは、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/
プロパティ
プロパティ | 詳細 |
---|---|
テーブル ID | ファイルを削除するテーブルの一意な識別子を入力する。 |
ファイルID | テーブルから削除するファイルの一意な識別子を入力します。 |
出力
出力 | 出力タイプ |
---|---|
ファイルのインポート | JSON |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
ピボットビューの更新
Wdata ビューのメタデータを更新するには、ピボット・ビューの更新 コマンドを使用します。
同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-updatepivotview/
プロパティ
プロパティ | 詳細 |
---|---|
身分証明書 | 更新するビューのIDを入力します。 |
名称 | ビューの新しい名前を入力します。 |
クエリーID | ビューを作成するクエリの ID を入力します。 |
クエリー結果ID | ビューを作成するクエリ結果の ID を入力します。 |
追加メタデータ | ビューに添付するユーザー定義のメタデータを JSON オブジェクトとして入力します(オプション)。 |
出力
出力 | 出力タイプ |
---|---|
ピボットビュー | JSON |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
クエリ定義の更新
Wdataクエリのプロパティを更新するには、クエリ定義の更新 コマンドを使用します。
同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-updatequery/
プロパティ
プロパティ | 詳細 |
---|---|
クエリーID | 更新するクエリのIDを入力してください。 |
名称 | クエリの新しい名前を入力します。 |
説明 | クエリの新しい説明を入力します。 |
主な結果ID | 指定する場合は、クエリ結果に入力する既定の結果の ID を入力します。 |
クエリーテキスト | PrestoのSQL構文として、クエリのSQLエディタで入力するように、クエリの定義を入力します。 |
臨時 | ワークスペースに 表示されないように、クエリを一時的にのみ生成するには、このボックスをオンにします。 |
パラメータ | クエリの実行に必要なパラメータを入力します。 |
出力
出力 | 出力タイプ |
---|---|
クエリ | JSON |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
選択リストの更新
複数選択クエリ・パラメータの値のリストのプロパティまたは項目を更新するには、選択リストの更新 コマンドを使用します。
同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-updateselectlist/
プロパティ
プロパティ | 詳細 |
---|---|
身分証明書 | 更新するセレクトリストのIDを入力します。 |
名称 | セレクトリストの新しい名前を入力する。 |
説明 | セレクトリストの新しい説明を入力する。 |
値のタイプ | 文字列や整数など、リストの値のデータ型を選択する。 |
値 | 更新を含むリストの値を入力する。 |
出力
出力 | 出力タイプ |
---|---|
選択リストの更新 | JSON |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
シートのメタデータを更新する
スプレッドシート内のシートのメタデータを更新するには、シートメタデータの更新 コマンドを使用します。
同等のAPIコール: https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatesheet/
プロパティ
プロパティ | 詳細 |
---|---|
スプレッドシート ID | メタデータを更新するシートのあるスプレッドシートの一意の識別子を入力します。 |
シートID/名前 | メタデータを更新するシートの名前または一意の識別子を入力します。 |
名称 | シートの新しい名前を入力します。 |
シート索引 | スプレッドシート内のシートの新しいインデックスを入力する。デフォルトでは、コマンドはシートをトップシートとして更新します。 |
親シートのID | シートを作成する親シートのIDを入力します。ルートスプレッドシートに追加する場合は、空白のままにする。 |
出力
なし
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
スプレッドシートのメタデータを更新する
スプレッドシートのメタデータを更新するには、スプレッドシートのメタデータを更新 コマンドを使用します。
同等のAPIコール: https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatespreadsheet/
プロパティ
プロパティ | 詳細 |
---|---|
スプレッドシート ID | メタデータを更新するシートのあるスプレッドシートの一意の識別子を入力します。 |
名称 | スプレッドシートの新しい名前を入力する。 |
出力
なし
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
テーブルの更新
Wdataテーブルのカラムを更新するには、Update table コマンドを使用する。
同等のAPIコール: https://developers.workiva.com/wdata-v1/wdata-updatetable/
プロパティ
プロパティ | 詳細 |
---|---|
テーブル ID | 更新するテーブルの一意な識別子を入力します。 |
名称 | 更新するテーブルの名前を入力します。 |
説明 | 更新するテーブルの説明を入力します。 |
タイプ | データまたはファクト-ルックアップまたはディメンジョン-テーブルを更新するかどうかを選択します。 |
列 | テーブルを更新するカラムを追加する。各カラムについて、名前、データタイプ、エイリアス、説明を入力する。Mode 、デフォルトのNullableのままにする。 |
出力
出力 | 出力タイプ |
---|---|
テーブル | JSON |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |
シートデータの書き込み
CSV データセットのデータをシートの特定の領域に書き込むには、Write sheet data コマンドを使用します。
同等のAPIコール: https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatedata/
プロパティ
プロパティ | 詳細 |
---|---|
スプレッドシート ID | データを書き込むシートのあるスプレッドシートの一意な識別子を入力する。 |
シートID/名前 | データを書き込むシートの一意な識別子を入力します。 |
データファイル | シートに書き込むデータのCSVファイルを入力します。データの範囲は 領域 を超えてはならない。 |
区切り記号 | データファイル で使用されている区切り記号を入力する。 |
地域 | データを書き込むシートのセルまたはセル範囲をA1で表す。任意の方向またはすべての方向に範囲を制限しないようにするには、対応する列または行を空白にします。 |
非同期を使用する |
大規模なデータセットなど、非同期でデータをロードするには、このボックスをチェックする。 注: 非同期を使用する場合は、ジョブのステータスを決定するために独自のポーリングを追加する必要があります。 |
プラットフォームAPIを使用する |
Region セル値の ntered-in フォーマットを使用するには、このボックスにチェックを入れます。 これにより、コマンドは、スプレッドシートAPIの領域エンドポイント へのデータ書き込みではなく、範囲エンドポイント の更新値を使用するようになる。 注: プラットフォームAPIを使用する場合、このコマンドは常に非同期で実行される。ジョブのステータスを判断するには、独自のポーリングを追加する必要がある。 |
出力
出力 | 出力タイプ |
---|---|
行数 | 整数 |
書かれた細胞 | 整数 |
終了コード
コード | タイプ | 詳細 |
---|---|---|
0 | 成功 | 成功 |
1 | エラー | エラー |