Zendesk API リクエスト
Zendesk API リクエスト シナリオ ブロックを使用すると、JSON を使用して Zendesk に対して自由形式の API リクエストを行うことができ、連携済みのアカウントでさまざまなアクションを実行することが可能になります。このブロックでは、あらかじめ設定された Zendesk 連携アカウント を使用して認証などを行います。なお、HTTPメソッドは設定可能であり、返された結果は処理中です。 「Fetch URL」 シナリオブロックと同様に処理されます。
設定
タイトルテキスト
ブロックのインスタンスの名前です。
リクエストタイプ
指定された Zendesk URL からコンテンツを取得するために使用するメソッドの種類です。
以下のリクエストタイプから選択するか、別のメソッドを手動で入力してください：
- GET（既定(デフォルト））
- POST
- PUT
- PATCH
- DELETE
URL
このフィールドには、Zendesk にエンティティを作成するために requests.json を設定してください。
このシナリオブロックが実行されると、Zendesk API へのリクエストが生成されます。このブロックは、連携アカウントの設定 URL（https://<YOURCOMPANY>.zendesk.com）を取得し、その末尾に「/api/v2/」と「requests.json」を追加します。
追加ヘッダー
追加ヘッダーとは 、リクエストに追加する HTTP ヘッダーのことです（例：認証目的など）。 ヘッダーは名前と値のペアで指定され、名前はヘッダー名（例：「Authorization」）、値はヘッダーの値（例：「Bearer D18273561286FE9」）となります。 ヘッダーの値には変数を含めることができ、ブロックが実行されると、変数はその値に置き換えられます。既定では、追加ヘッダーのリストは空になっています。任意のユーザーに代わって API リクエストを行うために追加ヘッダーを使用する例については、『Zendesk 統合ガイド 』の「Zendesk シナリオの例」のセクションをご覧ください。
ヘッダーを定義するには、「追加」 をクリックし、名前と値を入力してください。
フィールドの設定
この設定は予約済みです。
生の JSON
オブジェクトのプロパティが JSON フォーマットで指定される場所です。
注 ：コードおよび受信した HTTP レスポンスの本文は、それぞれローカル変数 $(integrationResultCode) および $(integrationResultBody) に格納されます。トラブルシューティングの目的で、使用します。 「メール」 または 内線メッセージ ブロックを使用して、オブジェクトの作成試行に失敗したことを示すコンテンツを取得してください。詳細については、変数の説明をご覧ください。 $(integrationResultBody).
結果の JSON 内の初期パス
レスポンス本文に JSON が含まれている場合、この設定を使用して、データの特定の部分をシナリオ変数に保存することができます。例：myobject.node.list[4]。既定は「なし」です。パスは、返された JSON のルートから始まります。
JSON データ用のシナリオ変数プレフィックス
この文字列は、解析された JSON データを受け取る変数の名前として使用されます。なお、上記の初期パスが配列を指している場合、後述の「GetNext」オプションの値に応じて、この変数には配列全体、またはその最初のエレメント（およびそれ以降のエレメント）が格納されることにご注意ください。
GetNext ブロックを使用してデータをループ処理する
（初期パスにある）JSONレスポンスデータが配列である場合、このチェックボックスが選択済になります。シナリオ変数には配列の最初のエレメントが設定され、「GetNext」ブロックを使用して配列のエレメントを順に処理し、シナリオ変数を次のエレメントに設定することができます。
条件付き終了
失敗
API メソッドの実行中にエラーが発生した場合、「失敗」の条件付き終了が実行されます。
データなし
HTTPレスポンスの本文にデータが返されなかった場合、「データなし」の条件付き終了が実行されます。