この記事のコマンドは、Workiva チェーンコネクター で使用します。チェーンIDを検索するには、WorkivaでIDを検索上でこの記事をご覧になれます。
Workiva Rest APIへのコネクター
特に指示がない限り、Appspotに合わせて値を設定してください。
| 入力 | タイプ | AppSpot | 詳細 |
| ベースURL | テキストフィールド | プロッド（米国） | https://h.app.wdesk.com/s/wdata/oc/api/ |
| ベースURL | テキストフィールド | Prod-EU | https://h.eu.wdesk.com/s/wdata/oc/api/ |
| ベースURL | テキストフィールド | Prod-APAC | https://h.apac.wdesk.com/s/wdata/oc/api/ |
チェーンの実行
チェーンを実行し、完了するまで待機する。
同等のAPIコール:https://developers.workiva.com/chains-v1/chains-startchain/
メモ: このコマンドはダイナミック・チェーンIDが必要な場合に使用できるが、ほとんどの場合、Run Chain イベント を使用することをお勧めする。チェーン実行イベントは、実行中のチェーンとより密接に結びつき、よりシンプルなユーザーエクスペリエンスを提供する。
入力
| 入力 | タイプ | 詳細 |
| 環境ID | テキストフィールド | 環境のID。 |
| チェーンID | テキストフィールド | チェーンのID。 |
| ランタイム変数 | グループフィールド | チェーンで使用されるランタイム変数の値。 |
| ポーリング間隔 | ナンバーフィールド | オプション ：チェーンが完了したかどうかを確認するまでの待機時間（秒）。デフォルトは5秒で、チェーンが長時間実行されることが予想される場合のみ調整してください。 |
出力
| 出力 | 出力タイプ |
| チェーン実行 | ファイル |
閉じるコード
| 閉じるコード | タイプ | 詳細 |
| 0 | 成功 | 成功 |
| 1 | エラー | 一般的な失敗 |
| 2 | エラー | 認証に失敗 |
入力値によるチェーン実行の検索
プロバイダーのテキストを含むすべてのチェーン実行を検索します。
同等のAPIコール:https://developers.workiva.com/chains-v1/chains-chaininputssearch/
入力
| 入力 | タイプ | 詳細 |
| 環境ID | テキストフィールド | 検索する環境のID。 |
| 検索テキスト | テキストフィールド | 検索する入力値。 |
| 最大の成果 | ナンバーフィールド | 検索する結果の最大数。すべてのアイテムを取得するには0を使用する。 |
出力
| 出力 | 出力タイプ |
| チェーン実行 | ファイル |
| チェーン実行回数 | 整数 |
閉じるコード
| 閉じるコード | タイプ | 詳細 |
| 0 | 成功 | 成功 |
| 1 | エラー | 一般的な失敗 |
| 2 | エラー | 認証に失敗 |
チェーンを手に入れる
チェーンのプロパティを取得します。
同等のAPIコール：https://developers.workiva.com/chains-v1/chains-getchain/
入力
| 入力 | タイプ | 詳細 |
| 環境ID | テキストフィールド | 対象環境のID。 |
| チェーンID | テキストフィールド | チェーンのID。 |
出力
| 出力 | 出力タイプ |
| チェーン | ファイル |
閉じるコード
| 閉じるコード | タイプ | 詳細 |
| 0 | 成功 | 成功 |
| 1 | エラー | 一般的な失敗 |
| 2 | エラー | 認証に失敗 |
チェーンコマンド取得
チェーン内のすべてのコマンドのプロパティを取得する。
同等のAPIコール:https://developers.workiva.com/chains-v1/chains-getcommands/
入力
| 入力 | タイプ | 詳細 |
| 環境ID | テキストフィールド | 対象環境のID。 |
| チェーンID | テキストフィールド | チェーンのID。 |
出力
| 出力 | 出力タイプ |
| コマンド | ファイル |
閉じるコード
| 閉じるコード | タイプ | 詳細 |
| 0 | 成功 | 成功 |
| 1 | エラー | 一般的な失敗 |
| 2 | エラー | 認証に失敗 |
チェーン履歴を見る
チェーンの実行履歴を取得します。
同等のAPIコール:https://developers.workiva.com/chains-v1/chains-chainrunhistory/
入力
| 入力 | タイプ | 詳細 |
| 環境ID | テキストフィールド | 対象環境のID。 |
| チェーンID | テキストフィールド | チェーンのID。 |
| 最大の成果 | ナンバーフィールド | 検索する結果の最大数。すべてのアイテムを取得するには0を使用する。 |
| 開始日 | テキストフィールド | 指定した開始日以降に実行されたチェーンを絞込みます。この値にはISO8601の書式設定か、Unixのタイムスタンプを使うことができる。 |
| 終了日 | テキストフィールド | 指定された終了日より前に実行されたチェーンを絞込みます。この値にはISO8601の書式設定か、Unixのタイムスタンプを使うことができる。 |
出力
| 出力 | 出力タイプ |
| チェーン実行 | ファイル |
| チェーン実行回数 | 整数 |
閉じるコード
| 閉じるコード | タイプ | 詳細 |
| 0 | 成功 | 成功 |
| 1 | エラー | 一般的な失敗 |
| 2 | エラー | 認証に失敗 |
チェーン実行を得る
チェーン実行の詳細を得る。
同等のAPIコール:https://developers.workiva.com/chains-v1/chains-getchainrun/
入力
| 入力 | タイプ | 詳細 |
| チェーン実行ID | テキストフィールド | チェーン実行のID。 |
出力
| 出力 | 出力タイプ |
| チェーン実行 | ファイル |
閉じるコード
| 閉じるコード | タイプ | 詳細 |
| 0 | 成功 | 成功 |
| 1 | エラー | 一般的な失敗 |
| 2 | エラー | 認証に失敗 |
チェーンをノードで実行
ノードの詳細を含むチェーン実行の詳細を取得する。
同等のAPIコール:https://developers.workiva.com/chains-v1/chains-getchainrunnodes/
入力
| 入力 | タイプ | 詳細 |
| チェーン実行ID | テキストフィールド | チェーン実行のID。 |
出力
| 出力 | 出力タイプ |
| チェーン実行 | ファイル |
閉じるコード
| 閉じるコード | タイプ | 詳細 |
| 0 | 成功 | 成功 |
| 1 | エラー | 一般的な失敗 |
| 2 | エラー | 認証に失敗 |
チェーンを手に入れる
特定の環境におけるすべてのチェーンとそのプロパティを取得します。
同等のAPIコール:https://developers.workiva.com/chains-v1/chains-getchains/
入力
| 入力 | タイプ | 詳細 |
| 環境ID | テキストフィールド | 対象環境のID。 |
出力
| 出力 | 出力タイプ |
| チェーン | ファイル |
| チェーン数 | 整数 |
閉じるコード
| 閉じるコード | タイプ | 詳細 |
| 0 | 成功 | 成功 |
| 1 | エラー | 一般的な失敗 |
| 2 | エラー | 認証に失敗 |
環境を手に入れる
特定の環境のプロパティを取得します。
同等のAPIコール:https://developers.workiva.com/chains-v1/chains-getenvironment/
入力
| 入力 | タイプ | 詳細 |
| ワークスペースID | テキストフィールド | 環境が存在するワークスペースのID。 |
| 環境ID | テキストフィールド | 対象環境のID。 |
出力
| 出力 | 出力タイプ |
| 環境 | ファイル |
閉じるコード
| 閉じるコード | タイプ | 詳細 |
| 0 | 成功 | 成功 |
| 1 | エラー | 一般的な失敗 |
| 2 | エラー | 認証に失敗 |
環境を手に入れる
ワークスペース内のエンバイロメントのリストを取得します。
同等のAPIコール:https://developers.workiva.com/chains-v1/chains-getenvironments/
入力
| 入力 | タイプ | 詳細 |
| ワークスペースID | テキストフィールド | 環境を含むワークスペースのID。 |
出力
| 出力 | 出力タイプ |
| 環境 | ファイル |
| 環境数 | 整数 |
閉じるコード
| 閉じるコード | タイプ | 詳細 |
| 0 | 成功 | 成功 |
| 1 | エラー | 一般的な失敗 |
| 2 | エラー | 認証に失敗 |
ワークスペース取得
ワークスペースとそのプロパティを取得します。
同等のAPIコール:https://developers.workiva.com/chains-v1/chains-getworkspace/
入力
| 入力 | タイプ | 詳細 |
| ワークスペースID | テキストフィールド | ワークスペースのID。 |
出力
| 出力 | 出力タイプ |
| ワークスペース | ファイル |
閉じるコード
| 閉じるコード | タイプ | 詳細 |
| 0 | 成功 | 成功 |
| 1 | エラー | 一般的な失敗 |
| 2 | エラー | 認証に失敗 |
ワークスペース取得
会社のすべてのワークスペースのリストを取得します。
同等のAPIコール:https://developers.workiva.com/chains-v1/chains-getworkspaces/
入力
なし
出力
| 出力 | 出力タイプ |
| ワークスペース | ファイル |
| ワークスペース数 | 整数 |
閉じるコード
| 閉じるコード | タイプ | 詳細 |
| 0 | 成功 | 成功 |
| 1 | エラー | 一般的な失敗 |
| 2 | エラー | 認証に失敗 |
マッピンググループの更新
マッピンググループGUIDで指定されたマッピンググループを更新します。
同等のAPIコール:https://developers.workiva.com/chains-v1/chains-publish/
入力
| 入力 | タイプ | 詳細 |
| マッピンググループGUID | テキストフィールド | マッピンググループのGUID。 |
出力
なし
閉じるコード
| 閉じるコード | タイプ | 詳細 |
| 0 | 成功 | 成功 |
| 1 | エラー | 一般的な失敗 |
| 2 | エラー | 認証に失敗 |
検索チェーン実行
与えられたフィルターに合致するチェーン実行を検索する。
同等のAPIコール:https://developers.workiva.com/chains-v1/chains-chainfiltersearch/
メモ:environment_id パラメータ は、スーパーユーザーや組織管理者には必要ありません。
入力
| 入力 | タイプ | 詳細 |
| フィルター | グループフィールド | 検索に適用するフィルター。 |
| 最大の成果 | ナンバーフィールド | 検索する結果の最大数。すべてのアイテムを取得するには0を使用する。 |
出力
| 出力 | 出力タイプ |
| チェーン実行 | ファイル |
| チェーン実行回数 | 整数 |
閉じるコード
| 閉じるコード | タイプ | 詳細 |
| 0 | 成功 | 成功 |
| 1 | エラー | 一般的な失敗 |
| 2 | エラー | 認証に失敗 |
ストップチェーン
実行中のチェーンを停止する。
同等のAPIコール:https://developers.workiva.com/chains-v1/chains-stopchain/
入力
| 入力 | タイプ | 詳細 |
| チェーン実行ID | テキストフィールド | 停止するチェーン実行のID。 |
出力
| 出力 | 出力タイプ |
| チェーン実行 | ファイル |
閉じるコード
| 閉じるコード | タイプ | 詳細 |
| 0 | 成功 | 成功 |
| 1 | エラー | 一般的な失敗 |
| 2 | エラー | 認証に失敗 |
マッピングルールのアップロード
マッピンググループGUIDで指定されたマッピンググループルールセットをアップロードします。
同等のAPIコール:https://developers.workiva.com/chains-v1/chains-updaterules/
入力
| 入力 | タイプ | 詳細 |
| マッピンググループGUID | テキストフィールド | マッピンググループのGUID。 |
| アップロードモード | ドロップダウンフィールド | アップロードモード。mode=published の場合、現在公開されているバージョンが更新され、再公開される。mode=draft の場合、ドラフトのみが更新される。mode=both の場合、公開版とドラフトの両方が更新される。 |
| マップリングルールファイル | ファイルフィールド | アップロードするマッピングルールを含むファイル。 |
出力
| 出力 | 出力タイプ |
| アップロードエラー | ファイル |
| アップロード結果 | ファイル |
| アップロードされたルール数 | 整数 |
| エラー数 | 整数 |
閉じるコード
| 閉じるコード | タイプ | 詳細 |
| 0 | 成功 | 成功 |
| 1 | エラー | 一般的な失敗 |
| 2 | エラー | 認証に失敗 |