カスタムAPIアクション

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

オプション

フィールド	定義	タイプ	必須
リクエストタイプ	カスタムAPI呼び出しでサポートされているHTTPリクエストメソッド、つまりHTTP動詞を以下に示します（「HTTPリクエストメソッド」を参照）。 GET：パラメーターに基づいてWebサーバーからデータを取得します。このメソッドは指定されたリソースの表現を要求します。リクエストが成功した場合、要求したコンテンツとともに200 (OK)レスポンスメッセージが返されます。 POST：パラメーターに基づいてWebサーバーにデータを送信します（ファイルのアップロードなど）。複数のPOSTリクエストは、単一のPOSTとは異なる結果になる場合があります。意図せず複数のPOSTリクエストを送信することを避けるために注意します。リクエストが成功した場合、200 (OK)レスポンスメッセージが返されます。 PUT：パラメーターに基づいてWebサーバーの特定の場所に格納されるデータを送信します （ファイルのアップロードなど）。POSTリクエストとは異なり、PUTリクエストは冪等です。リクエストが成功する場合、単一のPUTリクエストの結果は同一のPUTリクエストを何回行っても同じです。リクエストが成功した場合、200 (OK)、201 (Created)、または204 (No Content)レスポンスメッセージを受信します。 PATCH：パラメーターに基づいてWebサーバー上のリソースに部分的な変更を適用します。PATCHは冪等ではありません。複数のPATCHリクエストによって意図しない結果が生じる可能性があります。PATCHが成功した場合、200 (OK)または204 (No Content)レスポンスメッセージを受信します。 DELETE：パラメーターに基づいてWebサーバーから特定のリソース（存在する場合）を削除します。DELETEが成功した場合、200 (OK)レスポンスメッセージが返されます。	ドロップダウン	TRUE

入力

フィールド	定義	タイプ	必須
Relative URL（相対URL）	対話を試みるWebサーバーのURLアドレス。/{insert_remaining_URL}のように相対URLを指定します。「?」を使用して相対URL内にクエリパラメーターを指定したり、クエリ入力内のオブジェクトキーペアとしてクエリパラメーターを指定したりすることができます。 たとえば、Box APIエンドポイントがhttps://api.box.com/2.0であれば、相対URLは/usersとなります。 「Box API」を参照してください。	文字列	TRUE
Query（クエリ）	URLで実行されるアクションを定めるJSONオブジェクト。	オブジェクトまたは文字列	FALSE
ヘッダー	リクエストのコンテンツタイプを定めるJSONオブジェクト。これは通常、次の例の複製です。例：{"Content-type":"application/json"}	オブジェクト	FALSE

出力

フィールド	定義	タイプ
Response （レスポンス）
ステータスコード	操作の結果。コネクターは、カードによって実行されたアクションが成功したか失敗したかを示す、HTTPステータスコードを返します。例： 201 Createdステータスコードは、新しいリソースが作成された場合の成功を示します。 403 Forbiddenエラーは、必要な権限が不足していたためにHTTPリクエストが処理されなかったことを示します。 発生する可能性があるステータスコードの完全なリストについては、「HTTPステータスコード」を参照してください。	数値
ヘッダー	出力ボディーとは関係のない、ステータスコードの詳細なコンテキスト。レスポンスヘッダーは、選択したHTTPリクエストオプションによって決定します。すべてのヘッダーがレスポンスヘッダーというわけではありません。これは、{"Content-type":"application/json"}のようになります。	オブジェクト
本文	選択したHTTPリクエストから返されたデータ。 たとえば、GETリクエストからのデータ。	オブジェクト

関連項目

Boxコネクター

Workflows要素

Box APIのドキュメント