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

get

https://api.box.com/2.0

/file_requests/:file_request_id

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

関連するガイド

リクエスト

authorizationbearer [ACCESS_TOKEN]

content-typeapplication/json

パスパラメータ

file_request_id stringパス内必須

例123

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

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

レスポンス

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

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

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

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

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

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

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

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

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

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

get

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

このドキュメント内で一部のAPIを試せるようになりました。

ログイン

リクエストの例

cURL

curl -i -X GET "https://api.box.com/2.0/file_requests/42037322" \
     -H "authorization: Bearer <ACCESS_TOKEN>"

TypeScript Gen

await client.fileRequests.getFileRequestById(updatedFileRequest.id);

Python Gen

client.file_requests.get_file_request_by_id(updated_file_request.id)

.NET Gen

await client.FileRequests.GetFileRequestByIdAsync(fileRequestId: updatedFileRequest.Id);

Java

BoxFileRequest fileRequest = new BoxFileRequest(api, "id");
BoxFileRequest.Info fileRequestInfo = fileRequest.getInfo();

Python

file_request = client.file_request(file_request_id='123456').get()
print(f'File request {file_request.id} on folder {file_request.folder.name}')

.NET

BoxFileRequestObject fileRequest = await client.FileRequestsManager.GetFileRequestByIdAsync("12345");

Node

client.fileRequests.getById(fileRequestId)

iOS

client.fileRequests.get(fileRequestId: "123456") { result in
    guard case let .success(fileRequest) = result else {
        print("Error getting file request")
        return
    }
    
    print("File request title: \(fileRequest.title ?? "n/a"), description: \(fileRequest.description ?? "n/a")")
}

レスポンスの例

{
  "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"
}