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

このリソースは、バージョン2024.0のエンドポイントで使用されています。詳細については、 Box APIのバージョン管理を参照してください。「Box SDKのバージョニング戦略について詳しく学ぶ。」

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

file_request_id

string

required

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

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

Response

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

任意のファイルリクエストAPIエンドポイントからデフォルトで返されるファイルリクエストのStandard版の表示。

string

required

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

Example:

"42037322"

type

enum<string>

required

値は常にfile_requestになります。

利用可能なオプション:

file_request

Example:

"file_request"

folder

フォルダ (Mini) · object

required

このファイルリクエストが関連付けられているフォルダ。

ファイルリクエストフォームを使用して送信されたファイルは、このフォルダにアップロードされます。

表示子属性

created_at

string<date-time>

required

ファイルリクエストが作成された日時。

Example:

"2020-09-28T10:53:43-08:00"

updated_at

string<date-time>

required

ファイルリクエストが最後に更新された日時。

Example:

"2020-09-28T10:53:43-08:00"

title

string

ファイルリクエストのタイトル。これは、Box UIで、ファイルをアップロードしているユーザーに表示されます。

デフォルトでは、このファイルリクエストを作成するためにコピーされたファイルリクエストのタイトルになります。

Example:

"Please upload documents"

description

string | null

このファイルリクエストの説明 (省略可)。これは、Box UIで、ファイルをアップロードしているユーザーに表示されます。

デフォルトでは、このファイルリクエストを作成するためにコピーされたファイルリクエストの説明になります。

Example:

"Following documents are requested for your process"

status

enum<string>

ファイルリクエストのステータス。デフォルトではactiveになります。

このステータスをinactiveに設定すると、ファイルリクエストでは新しい送信を受け付けなくなり、ファイルリクエストのURLにアクセスした場合はHTTP 404ステータスコードが返されます。

デフォルトでは、このファイルリクエストを作成するためにコピーされたファイルリクエストのステータスになります。

利用可能なオプション:

active,

inactive

Example:

"active"

is_email_required

boolean

ファイルリクエストの送信者に、メールアドレスの指定を義務付けるかどうか。

これをtrueに設定すると、Box UIのファイルリクエストフォームにメールフィールドが表示されます。

デフォルトでは、このファイルリクエストを作成するためにコピーされたファイルリクエストの設定になります。

Example:

true

is_description_required

boolean

ファイルリクエストの送信者に、送信するファイルの説明の指定を義務付けるかどうか。

これをtrueに設定すると、Box UIのファイルリクエストフォームに説明フィールドが表示されます。

デフォルトでは、このファイルリクエストを作成するためにコピーされたファイルリクエストの設定になります。

Example:

true

expires_at

string<date-time>

ファイルリクエストが新しい送信を受け付けなくなる日付。

この日付を過ぎると、statusは自動的にinactiveに設定されます。

Example:

"2020-09-28T10:53:43-08:00"

url

string

このファイルリクエストに対して生成されたURL。このURLをユーザーと共有すると、ユーザーが関連付けられたフォルダにファイルをアップロードできるようになります。

Example:

"/f/19e57f40ace247278a8e3d336678c64a"

etag

string | null

このファイルのHTTP etag。これは、ファイルリクエストの更新時にIf-Matchヘッダーと組み合わせて使用できます。そのヘッダーを指定すると、If-Matchヘッダーで指定されたetagとファイルリクエストのetagがまだ一致している場合のみ、ファイルリクエストが変更されます。

Example:

"1"

created_by

ユーザー (Mini) · object

このファイルリクエストを作成したユーザー。

表示子属性

updated_by

ユーザー (Mini) · object

このファイルリクエストを最後に変更したユーザー。

表示子属性