メインコンテンツへスキップ

Documentation Index

Fetch the complete documentation index at: https://developer.box.com/llms.txt

Use this file to discover all available pages before exploring further.

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

id
string
必須
read-only

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

:

"42037322"

type
enum<string>
必須
read-only

値は常にfile_requestになります。

利用可能なオプション:
file_request
:

"file_request"

folder
フォルダ (Mini) · object
必須

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

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

created_at
string<date-time>
必須

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

:

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

updated_at
string<date-time>
必須

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

:

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

title
string

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

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

:

"Please upload documents"

description
string | null

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

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

:

"Following documents are requested for your process"

status
enum<string>

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

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

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

利用可能なオプション:
active,
inactive
:

"active"

is_email_required
boolean

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

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

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

:

true

is_description_required
boolean

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

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

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

:

true

expires_at
string<date-time>

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

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

:

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

url
string
read-only

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

:

"/f/19e57f40ace247278a8e3d336678c64a"

etag
string | null

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

:

"1"

created_by
ユーザー (Mini) · object

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

updated_by
ユーザー (Mini) · object

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