ファイルリクエスト

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

string
42037322

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

string
file_request

file_request

次の値に固定: file_request

string / date-time
2020-09-28T10:53:43-08:00

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

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

Following documents are requested for your process

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

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

string
1

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

string / date-time
2020-09-28T10:53:43-08:00

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

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

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

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

true

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

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

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

true

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

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

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

string
active

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

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

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

次の値のいずれか1つ: active,inactive

string
Please upload documents

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

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

string / date-time
2020-09-28T10:53:43-08:00

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

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

string
/f/19e57f40ace247278a8e3d336678c64a

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

レスポンスの例

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