カスタムAPIアクション
DataGrail APIに対してカスタムの認証済みHTTP呼び出しを行います。
オプション
フィールド | 定義 | タイプ | 必須 |
---|---|---|---|
Request Type(リクエストタイプ) |
これはカスタムAPI呼び出しでサポートされる以下のいずれかのHTTPリクエストメソッド、つまりHTTP動詞です(「HTTPリクエストメソッド」を参照)。
|
ドロップダウン | TRUE |
入力
フィールド | 定義 | タイプ | 必須 |
---|---|---|---|
Relative URL(相対URL) |
対話を試みるWebサーバーのURLアドレス。 「?」を使用して相対URL内にクエリパラメーターを指定したり、クエリ入力内のオブジェクトキーペアとしてクエリパラメーターを指定したりすることができます。 たとえば、DataGrailエンドポイントがhttps://api.datagrail.io/v1/privacy_requestsであれば、相対URLは/privacy_requestsとなります。 |
文字列 | TRUE |
クエリ | オブジェクト形式 (キーと値のペア) で含める必要がある追加のクエリーパラメーターを指定します。 | オブジェクト | FALSE |
Headers(ヘッダー) | すでにコネクターが対応している承認またはコンテンツタイプ以外に、必要な任意のヘッダーを指定します。 | オブジェクト | FALSE |
本文 | リクエストボディーをJSON形式で指定します。POSTリクエストでのみ使用できます。 | オブジェクト | FALSE |
出力
フィールド | 定義 | タイプ |
---|---|---|
Response (レスポンス) | ||
ステータスコード | 操作の結果。コネクターは、カードによって実行されたアクションが成功したか失敗したかを示す、HTTPステータスコードを返します。例:
発生する可能性があるステータスコードの完全なリストについては、「HTTPステータスコード」を参照してください。 |
数値 |
ヘッダー | 出力ボディーとは関係のない、ステータスコードの詳細なコンテキスト。レスポンスヘッダーは、選択したHTTPリクエストオプションによって決定します。すべてのヘッダーがレスポンスヘッダーというわけではありません。これは、{"Content-type":"application/json"}のようになります。 | オブジェクト |
本文 |
選択したHTTPリクエストから返されたデータ。 たとえば、GETリクエストからのデータ。 |
オブジェクト |