カスタムAPIアクション

Adobe User Management APIに対して認証済みHTTPリクエストを行います。Adobe User Management APIを参照してください。

オプション

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

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

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

  • GET:パラメーターに応じてWebサーバーからデータを取得します。このメソッドは指定されたリソースの表現を要求します。リクエストが成功した場合、要求したコンテンツとともに200 (OK)レスポンスメッセージが返されます。
  • POST:パラメーターに応じてWebサーバーにデータを送信します (たとえば、ファイルのアップロード)。複数のPOSTリクエストは、単一のPOSTとは異なる結果になる場合があります。意図せず複数のPOSTリクエストを送信することを避けるために注意する必要があります。リクエストが成功した場合、200 (OK)レスポンスメッセージが返されます。
ドロップダウン

入力

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

相対URL(Relative URL)

呼び出すWebサーバーのURLアドレス。/{insert_remaining_URL}のように相対URLを指定します。

?を使用して相対URL内にクエリパラメーターを指定したり、クエリ(Query)入力内のキーと値のペアとしてクエリパラメーターを指定したりすることができます。

たとえば、Adobe User Management APIエンドポイントでは、https://usermanagement.adobe.io/v2/usermanagement/groups/{orgId}/{page}であれば、相対URLは/usermanagement/groups/{orgId}/{page}となります。

テキスト

ヘッダー(Headers)

authorizationまたはcontent-typeのヘッダーにはすでにコネクターが対応しているので、これ以外に必要な任意のヘッダーを指定します。

オブジェクト FALSE

クエリ(Query)

キー/値のペアとして含める必要がある追加のクエリパラメーターを指定します。

例:{"name":"something-urgent"}

オブジェクト FALSE

本文(Body)

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

このフィールドはGETリクエストタイプには使用できません。

テキスト FALSE

出力

フィールド 定義 タイプ

レスポンス(Response )

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

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

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

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

数値

ヘッダー(Headers)

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

オブジェクト

本文(Body)

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

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

オブジェクト