提供: Bright Pattern Documentation
移動先: 案内検索
• English

Zendesk API リクエスト

「Zendesk API リクエスト」ワークフローブロックを使用すると、JSON を使用して Zendesk に対して自由形式の Zendesk API リクエストを行うことができ、連携済みのアカウントでさまざまなアクションを実行することが可能になります。このブロックでは、あらかじめ設定された Zendesk 連携アカウント を使用して認証などを行います。なお、HTTP メソッドは設定可能であり、返される結果は処理中です。 「Fetch URL」 ワークフローブロックと同様に処理される点にご注意ください。


Zendesk API リクエスト ワークフローブロック


条件付き終了

失敗

API メソッドの実行中にエラーが発生した場合、「失敗」の条件付き出口が実行されます。

データなし

HTTP レスポンスの本文にデータが返されなかった場合、「データなし」の条件付き終了が実行されます。

設定

タイトルテキスト

タイトルテキストは 、ブロックのインスタンスの名前です。テキストフィールドに名前を入力し、[編集] ペインの下部にある [保存 ] ボタンをクリックしてください。ブロックの新規名前がフローチャートに表示されます。

リクエストタイプ

リクエストタイプとは 、指定された Zendesk URL からコンテンツを取得するために使用するメソッドの種類です。リクエストタイプはドロップダウンメニューで定義されています。

以下のリクエストタイプから選択するか、別のメソッドを手動で入力してください:

  • GET(既定)
  • POST
  • PUT
  • PATCH
  • DELETE

URL

URL は、リクエスト先の Zendesk API の URL です。クエリ文字列のパラメータは別途指定します。なお、この設定は Zendesk 連携アカウントの URL 設定 を上書きすることにご注意ください。

設定フィールド

この設定は予約済みです。

生のJSON

Raw JSON 」では、オブジェクトのプロパティを JSON フォーマットで指定します。

:コードおよび受信した HTTP レスポンスの本文は、それぞれローカル変数 $(integrationResultCode) および $(integrationResultBody) に格納されます。トラブルシューティングの目的で、使用します。 メール または 内線メッセージ ブロックを使用して、オブジェクトの作成の試行に失敗したことを示すレスポンスのコンテンツを取得してください。詳細については、変数の説明 $(integrationResultBody).

結果のJSONにおける初期パス

レスポンス本文に JSON が含まれている場合、この設定を使用して、データの一部をワークフロー変数に保存することができます。例:myobject.node.list[4]。既定は「なし」です。パスは、返された JSON のルートから始まります。

JSON データ用のシナリオ変数プレフィックス

この文字列は、解析された JSON データを受け取る変数の名前として使用されます。なお、上記の初期パスが配列を指している場合、後述の「GetNext」オプションの値に応じて、この変数には配列全体、またはその最初のエレメント(およびそれ以降のエレメント)が格納されることにご注意ください。

GetNext ブロックを使用してデータをループ処理する

(初期パスにある)JSON レスポンスデータが配列である場合、このチェックボックスが選択済になります。ワークフロー変数には配列の最初のエレメントが設定され、「GetNext」ブロックを使用して配列のエレメントを順に処理し、ワークフロー変数を次のエレメントに設定することができます。


Zendesk API リクエスト ワークフロー ブロックの設定
< 前へ | 次へ >