CLP - HTTP リクエストリストスプレッドシート – サポートセンター

Workivaの内蔵プレミアムコネクター以外のサードパーティアプリケーションへの接続をお探しですか？これは、HTTP Request Connector コマンドを活用して REST API とやり取りすることで実現できます。この接続学習パスでは、ワークスペース内のスプレッドシートの一覧を取得するために list Spreadsheets エンドポイントを使用するコマンドで Bearer Token を使用するようにチェーンを更新します。

メモ: HTTP Request とラベル付けされていますが、HTTPS (Secure HTTP) がサポートされています (および推奨)。

プライマリビジネスユースケース	サードパーティシステムとの接続
プライマリ学習目標	HTTP Request Connector を使用したチェーンの基本概念の学習
前提条件	Workiva API Grant の構成 HTTP Request Connector の構成 CLP - HTTP Request Token の生成
サポートテンプレート	CLP - HTTP リクエストリストスプレッドシート

ステップ 1：ワークスペース変数の作成

複数のチェーンとコマンドで Workiva API の詳細を使用するために、その情報を格納するワークスペース変数を作成します。Platform API URL の新規ワークスペース変数を作成します。

チェーンビルダー からワークスペース設定 に移動します。
Workspace Variables で、プラス記号をクリックして新規ワークスペース変数を作成します。
以下の情報を使用して変数を構成します：
- 名称： wsv-BaseURL-Platform
- 値：あなたの地域に基づいて、適切な値を使用してください。URL にEU またはAPAC が含まれている場合は、対応する URL を使用してください。それ以外の場合はUS値を使用してください。
メモ: USリージョンには「app」のみが含まれます。
フィールド US値

IAM ベース URL https://api.app.wdesk.com/platform/v1

フィールド EU値

IAM ベース URL https://api.eu.wdesk.com/platform/v1

フィールド APAC値

IAM ベース URL https://api.apac.wdesk.com/platform/v1
保存ワークスペース設定.

メモ: ワークスペース設定に、これらの 4 つの変数がすべて表示されているはずです。表示されない場合は、上記のPrerequisites を参照してください。

ステップ 2: チェーンのコピーと修正

チェーンビルダーに移動し、CLP | Generate a Token という名称のチェーンを探します。
右側の縦の楕円をクリックし、コピー を選択します。
チェーンのコピーが作成されたら、鉛筆のアイコンをクリックしてチェーンを編集します。
右上のチェーン設定 をクリックします。
チェーンの名前を変更します：CLP | HTTP Request List Spreadsheets.
(オプション)説明を入力します："このチェーンは新規 Workiva API アクセストークンを生成します。以下の変数値に、以前に生成された API Grant から有効な Client ID と Client Secret を提供する必要があります。次に、ワークスペース内のすべてのスプレッドシートのリストを取得します。ワークスペースには、少なくとも 1 つ以上のスプレッドシートが必要です。" を参照してください。
チェーンを保存します。

ステップ 3: スプレッドシートのリスト

スプレッドシートのリストを取得するには、このチェーンは HTTP リクエストコネクタからGET Command を使用します。

HTTP Request コネクタからGetCommand をチェーンキャンバスに追加します。
Post - Retrieve a Token Command をGet Command に接続します。
コマンドをダブルクリックして構成します。
1. コマンドの名前を変更します：取得 - スプレッドシートのリスト
2. コマンドを編集するには、コマンドをクリックし、関連する鉛筆アイコンをクリックします。
3. Show Response チェックボックスをチェックします。
4. URL をクリックし、"変数の選択 "パネルでワークスペース をクリックし、ステップ 1 で作成した変数 (wsv-BaseURL-Platform) を選択します。
5. 変数の後に/spreadsheets を追加します。
  
  次へ、Get フォームでHeadersを指定して、エンドポイントに実行方法を伝えます。
  これらのヘッダーは Bearer トークンを API に渡し、スプレッドシートのリストを取得するために使用することを表示します。
6. ヘッダーセクションの次へ、灰色のプラス（+）ボタンを2回クリックし、各フィールドに以下の値を入力します。大文字と小文字の区別、および「ベアラ」の後のスペースに特に注意してください。
  - ヘッダーフィールド 1：
    - キー： キー : 承認
    - 値: application/json
  - ヘッダーフィールド2 ：
    - キー： 作成者
    - 値： Bearer<Post>
      <Post> を POST - Retrieve a Token Command の出力に置換します。
      1. Select a Variable パネルで、Runtime の下矢印をクリックして、POST - Retrieve a Token を展開します。
      2. Response の次へ下矢印をクリックして、変数オプションを展開します。
      3. Access_token を選択します。
コンテンツタイプ を次のように入力します:application/json.

レスポンスに以下のサンプルペイロードを入力します。こうすることで、コマンドの出力に書式を設定し、返却される各変数を使いやすくしています。

{ "data"：[ { "created"：{ "dateTime"："2018-10-21T15:03:27Z" }, "名称"："年末レビュー", "ID"："124efa2a142f472ba1ceab34ed18915f", "modified"：{ "dateTime"："2018-10-21T15:03:27Z" }, "template": false }, { "created"：{ "dateTime"："2020-02-20T15:03:27Z" }, "名称"："Q1 レビュー", "ID"："164cfb2b132c4623a2cfaa31ef13925a", "modified"：{ "dateTime"："2020-03-29T13:15:27Z" }, "template": false }.], "@nextLink"："<opaque_url>"}

(オプション)説明を入力 ："このコマンドはスプレッドシートのリストの1ページを返却します。詳細については、https://developers.workiva.com/platform-v1/platform-getspreadsheets/" の開発者ドキュメントを参照ください。

ヒントヘッダーフィールドとレスポンスフィールドの入力方法を決定するには、接続先の API エンドポイントのデベロッパードキュメントをチェックします。
コマンドを保存する。

ステップ 4：テストの手順

チェーンが完成したら、結果をテストする。

チェーンを更新します。
Execute をクリックしてから、Run Chain を実行します。
チェーンが実行を完了すると、Outputs タブ - Get コマンドの Response Body にスプレッドシートのリストが表示されます。

サードパーティの API に接続するための HTTP リクエストコネクタの使用について詳細は、次へ進んでください：CLP - HTTP Request Get a Single Spreadsheet.

サポート

コミュニティ

Workiva サポートセンター