File Request
A standard representation of a file request, as returned from any file request API endpoints by default.Attributes and example
Attributes and example
| Property | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The unique identifier for this file request. Read-only. |
type | enum<string> | Yes | The value will always be file_request. Available options: file_request. Read-only. |
title | string | No | The title of file request. This is shown in the Box UI to users uploading files. This defaults to title of the file request that was copied to create this file request. |
description | string | No | The optional description of this file request. This is shown in the Box UI to users uploading files. This defaults to description of the file request that was copied to create this file request. Can be null. |
status | enum<string> | No | The status of the file request. This defaults to active. When the status is set to inactive, the file request will no longer accept new submissions, and any visitor to the file request URL will receive a HTTP 404 status code. This defaults to status of file request that was copied to create this file request. Available options: active, inactive. |
is_email_required | boolean | No | Whether a file request submitter is required to provide their email address. When this setting is set to true, the Box UI will show an email field on the file request form. This defaults to setting of file request that was copied to create this file request. |
is_description_required | boolean | No | Whether a file request submitter is required to provide a description of the files they are submitting. When this setting is set to true, the Box UI will show a description field on the file request form. This defaults to setting of file request that was copied to create this file request. |
expires_at | string | No | The date after which a file request will no longer accept new submissions. After this date, the status will automatically be set to inactive. |
folder | Folder (Mini) | Yes | The folder that this file request is associated with. Files submitted through the file request form will be uploaded to this folder. |
url | string | No | The generated URL for this file request. This URL can be shared with users to let them upload files to the associated folder. Read-only. |
etag | string | No | The HTTP etag of this file. This can be used in combination with the If-Match header when updating a file request. By providing that header, a change will only be performed on the file request if the etag on the file request still matches the etag provided in the If-Match header. Can be null. |
created_by | User (Mini) | No | The user who created this file request. |
created_at | string | Yes | The date and time when the file request was created. |
updated_by | User (Mini) | No | The user who last modified this file request. |
updated_at | string | Yes | The date and time when the file request was last updated. |
Example
{
"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"
}