Box Developerドキュメント
ログイン
最新バージョン

ファイルリクエストを取得

get
https://api.box.com/2.0
/file_requests/:file_request_id

このエンドポイントはバージョン2024.0です。引き続き使用するために 変更は必要ありません。詳細については、 **Box APIのバージョン管理**を参照してください。

ファイルリクエストに関する情報を取得します。

関連するガイド

リクエスト

bearer [ACCESS_TOKEN]
application/json

パスパラメータ

stringパス内必須
123

ファイルリクエストを表す一意の識別子。

ファイルリクエストのIDを確認するには、ウェブアプリケーションでファイルリクエストの作成画面にアクセスして、そのURLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/filerequest/123の場合、file_request_idは123です。

レスポンス

application/jsonファイルリクエスト

ファイルリクエストオブジェクトを返します。

application/jsonクライアントエラー

Authorizationヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。

application/jsonクライアントエラー

ファイルリクエストが見つからない場合、または関連付けられたフォルダへのアクセス権限がユーザーに与えられていない場合に返されます。

application/jsonクライアントエラー

file_request_idが認識されていない形式で指定されている場合に返されます。

application/jsonクライアントエラー

予期しないクライアントエラー。

get
ファイルリクエストを取得
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

cURLTypeScript GenPython Gen.NET GenJavaPython.NETNodeiOS
cURL
curl -i -X GET "https://api.box.com/2.0/file_requests/42037322" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
Python Gen
.NET Gen
Java
Python
.NET
Node
iOS

レスポンスの例

{
  "id": "42037322",
  "type": "file_request",
  "created_at": "2020-09-28T10:53:43-08:00",
  "created_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "description": "Following documents are requested for your process",
  "etag": "1",
  "expires_at": "2020-09-28T10:53:43-08:00",
  "folder": {
    "id": "12345",
    "type": "folder",
    "etag": "1",
    "name": "Contracts",
    "sequence_id": "3"
  },
  "is_description_required": true,
  "is_email_required": true,
  "status": "active",
  "title": "Please upload documents",
  "updated_at": "2020-09-28T10:53:43-08:00",
  "updated_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "url": "/f/19e57f40ace247278a8e3d336678c64a"
}