カスタムAPIアクション

Custom API Actionを使用して、Microsoft Graph REST APIに対する認証済みのカスタムAPIリクエストを発行します。「Microsoft Graph REST API」を参照してください。

オプション

フィールド 定義 タイプ 必須

リクエストタイプ(Request Type)

カスタムAPI呼び出しでサポートされるHTTPリクエストメソッド、つまりHTTP動詞は次のとおりです(「HTTPリクエストメソッド」を参照)。

  • 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リクエストによって意図しない結果が生じる可能性があります。PATCHが成功した場合、200 (OK)または204 (No Content)レスポンスメッセージが返されます。

  • DELETE:パラメーターに応じてWebサーバーから特定のリソース(存在する場合)を削除します。DELETEが成功した場合、200 (OK)レスポンスメッセージが返されます。

ドロップダウン

入力

フィールド 定義 タイプ 必須

相対URL(Relative URL)

呼び出すWebサーバーのURLアドレス。/{insert_remaining_URL}のように相対URLを指定します。「?」を使用して相対URL内にクエリパラメーターを指定したり、クエリ入力内のオブジェクトキーペアとしてクエリパラメーターを指定したりできます。

エンドポイントの例:https://graph.microsoft.com/v1.0/usersであれば、相対URLは/usersとなります。

テキスト

ヘッダー(Headers)

承認またはコンテンツタイプに加えて必要な任意のヘッダーを指定します。

例:{"Content-Type":"application/json"}。

オブジェクト FALSE

クエリ(Query)

オブジェクト形式(キーと値のペア)で含める必要がある追加のクエリパラメーターを指定します。

オブジェクト FALSE

本文(Body)

リクエストボディーをJSON形式で指定します。

オブジェクト FALSE

出力

フィールド 定義 タイプ

レスポンス(Response )

ステータスコード(Status Code)

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

  • 201 Createdステータスコードは、アクションが成功し、新しいリソースが作成されたことを示します。
  • 403 Forbiddenエラーは、必要な権限が不足していたためにHTTPリクエストが処理されなかったことを示します。

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

数値

ヘッダー(Headers)

出力ボディーとは関係のない、ステータスコードの詳細なコンテキスト。レスポンスヘッダーは、選択したHTTPリクエストオプションによって決定します。すべてのヘッダーがレスポンスヘッダーというわけではありません。これは、{"Content-type":"application/json"}のようになります。

オブジェクト

本文(Body)

選択したHTTPリクエストから返されたデータ。

たとえば、GETリクエストからのデータ。

オブジェクト