Custom API Action

DataGrail APIに対してカスタムの認証済みHTTP呼び出しを行います。

オプション

フィールド 定義 タイプ 必須
Request Type(リクエストタイプ) これはカスタムAPI呼び出しでサポートされる以下のいずれかのHTTPリクエストメソッド、つまりHTTP動詞です(「HTTPリクエストメソッド」を参照)。
  • GET:パラメーターに基づいてWebサーバーからデータを取得します。このメソッドは指定されたリソースの表現を要求します。リクエストが成功した場合、要求したコンテンツとともに200 (OK)レスポンスメッセージが返されます。
  • POST:パラメーターに基づいてWebサーバーにデータを送信します(ファイルのアップロードなど)。複数のPOSTリクエストは、単一のPOSTとは異なる結果になる場合があります。意図せず複数のPOSTリクエストを送信することを避けるために注意する必要があります。リクエストが成功した場合、200 (OK)レスポンスメッセージが返されます。
ドロップダウン

入力

フィールド 定義 タイプ 必須
Relative URL(相対URL)

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

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

たとえば、DataGrailエンドポイントがhttps://api.datagrail.io/v1/privacy_requestsであれば、相対URLは/privacy_requestsとなります。

テキスト TRUE
Query(クエリ) オブジェクト形式 (キーと値のペア) で含める必要がある追加のクエリーパラメーターを指定します。 オブジェクト
Headers(ヘッダー) すでにコネクターが対応している認可またはコンテンツタイプ以外に、必要な任意のヘッダーを指定します。 オブジェクト
Body(本文) リクエストボディーをJSON形式で指定します。POSTリクエストでのみ使用できます。 オブジェクト

出力

フィールド 定義 タイプ

Response (レスポンス)

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

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

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

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

数値

Headers(ヘッダー)

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

オブジェクト

Body(本文)

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

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

オブジェクト

関連項目

DataGrailコネクター

Workflows要素

DataGrail APIのドキュメント