コネクタービルダーのカスタムAPIカードドキュメント

Custom API Actionカードの参照ヘルプ

コネクターのCustom API Actionカードの参照ヘルプトピックを盛り込みます。

トピックの紹介には次の文を使用します。

  • Custom API Actionを使用して、<サービス名> REST APIに対する認証済みのカスタムAPIリクエストを発行します。

オプション

ヘルプトピックの［Request Type（リクエストタイプ）］フィールドには、使用するCustom API Actionカードでサポートされる方法を指定します。必要に応じて次の定義を使用します。

GET パラメーターに応じてWebサーバーからデータを取得します。このメソッドは指定されたリソースの表現を要求します。リクエストが成功した場合、要求したコンテンツとともに200 (OK)レスポンスメッセージが返されます。
POST パラメーターに応じてWebサーバーにデータを送信します (たとえば、ファイルのアップロード)。複数のPOSTリクエストは、単一のPOSTとは異なる結果になる場合があります。意図せず複数のPOSTリクエストを送信することを避けるために注意する必要があります。リクエストが成功した場合、200 (OK)レスポンスメッセージが返されます。
PUT パラメーターに基づいて、Webサーバーの特定の場所に格納するデータを送信します （ファイルのアップロードなど）。POSTリクエストとは異なり、PUTリクエストは冪等（べきとう）です。リクエストが成功なら、同じPUTリクエストを何回実行しても、1回実行したときと同じ結果になります。リクエストが成功した場合、200 (OK)、201 (Created)、または204 (No Content)レスポンスメッセージを受信します。
PATCH パラメーターに応じてWebサーバー上のリソースに部分的な変更を適用します。PATCHは冪等（べきとう）ではありません。複数のPATCHリクエストによって意図しない結果が生じる可能性があります。PATPATCHが成功した場合、200 (OK)または204 (No Content)レスポンスメッセージが返されます。
DELETE パラメーターに応じてWebサーバーから特定のリソース（存在する場合）を削除します。DELETEが成功した場合、200 (OK)レスポンスメッセージが返されます。

入力

入力フィールドセクションには、次のフィールドの定義を指定します。

  • Relative URL（相対URL）

  • Headers（ヘッダー）

  • Query（クエリ）

  • Body（本文）

次に、Googleカレンダーコネクターの［Relative URL（相対URL）］の定義の例を示します。

Relative URL（相対URL）

対話を試みるWebサーバーのURLアドレス。/{version}/{insert_remaining_URL}のように相対URLを指定します。

「?」を使用して相対URL内にクエリパラメーターを指定したり、［Query（クエリ）］入力内のオブジェクトキーペアとしてクエリパラメーターを指定したりできます。

たとえば、GoogleカレンダーAPIエンドポイントの場合、https://www.googleapis.com/calendar/v3/users/{userId}/calendarListであれば、/v3/users/{userId}/calendarListが相対URLです。

Outputs（出力）

出力フィールドセクションには、次のフィールドの定義を指定します。

  • Status Code（ステータスコード）

  • Headers（ヘッダー）

  • Body（本文）

［Status Code（ステータスコード）］フィールドの場合：

Status Code（ステータスコード）

操作の結果。コネクターは、カードによって実行されたアクションの成否を示すHTTPステータスコードを返します。例：

  • 201 Createdステータスコードは、アクションが成功し、新しいリソースが作成されたことを示します。

  • 403 Forbiddenエラーは、必要な権限が不足していたためにHTTPリクエストが処理されなかったことを示します。

発生する可能性があるステータスコードの完全なリストについては、「HTTPステータスコード」を参照してください。

例

参考情報については、Custom API Actionカードのトピックを参照してください。