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