ファイルリクエストリソース

プロパティ	型	必須	説明
`id`	`string`	はい	このファイルリクエストの一意の識別子。読み取り専用。
`type`	`enum<string>`	はい	値は常に`file_request`になります。使用可能なオプション: `file_request`. 読み取り専用。
`title`	`string`	いいえ	ファイルリクエストのタイトル。これは、Box UIで、ファイルをアップロードしているユーザーに表示されます。デフォルトでは、このファイルリクエストを作成するためにコピーされたファイルリクエストのタイトルになります。
`description`	`string`	いいえ	このファイルリクエストの説明 (省略可)。これは、Box UIで、ファイルをアップロードしているユーザーに表示されます。デフォルトでは、このファイルリクエストを作成するためにコピーされたファイルリクエストの説明になります。 `null` を指定できます。
`status`	`enum<string>`	いいえ	ファイルリクエストのステータス。デフォルトでは`active`になります。このステータスを`inactive`に設定すると、ファイルリクエストでは新しい送信を受け付けなくなり、ファイルリクエストのURLにアクセスした場合は`HTTP 404`ステータスコードが返されます。デフォルトでは、このファイルリクエストを作成するためにコピーされたファイルリクエストのステータスになります。使用可能なオプション: `active`, `inactive`.
`is_email_required`	`boolean`	いいえ	ファイルリクエストの送信者に、メールアドレスの指定を義務付けるかどうか。これをtrueに設定すると、Box UIのファイルリクエストフォームにメールフィールドが表示されます。デフォルトでは、このファイルリクエストを作成するためにコピーされたファイルリクエストの設定になります。
`is_description_required`	`boolean`	いいえ	ファイルリクエストの送信者に、送信するファイルの説明の指定を義務付けるかどうか。これをtrueに設定すると、Box UIのファイルリクエストフォームに説明フィールドが表示されます。デフォルトでは、このファイルリクエストを作成するためにコピーされたファイルリクエストの設定になります。
`expires_at`	`string`	いいえ	ファイルリクエストが新しい送信を受け付けなくなる日付。この日付を過ぎると、`status`は自動的に`inactive`に設定されます。
`folder`	フォルダ (Mini)	はい	このファイルリクエストが関連付けられているフォルダ。ファイルリクエストフォームを使用して送信されたファイルは、このフォルダにアップロードされます。
`url`	`string`	いいえ	このファイルリクエストに対して生成されたURL。このURLをユーザーと共有すると、ユーザーが関連付けられたフォルダにファイルをアップロードできるようになります。読み取り専用。
`etag`	`string`	いいえ	このファイルのHTTP `etag`。これは、ファイルリクエストの更新時に`If-Match`ヘッダーと組み合わせて使用できます。そのヘッダーを指定すると、`If-Match`ヘッダーで指定された`etag`とファイルリクエストの`etag`がまだ一致している場合のみ、ファイルリクエストが変更されます。 `null` を指定できます。
`created_by`	ユーザー (Mini)	いいえ	このファイルリクエストを作成したユーザー。
`created_at`	`string`	はい	ファイルリクエストが作成された日時。
`updated_by`	ユーザー (Mini)	いいえ	このファイルリクエストを最後に変更したユーザー。
`updated_at`	`string`	はい	ファイルリクエストが最後に更新された日時。

例

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

​ファイルリクエスト

ファイルリクエスト