files_patch {civis} | R Documentation |
Update details about a file
Description
Update details about a file
Usage
files_patch(id, name = NULL, expires_at = NULL)
Arguments
id |
integer required. The ID of the file. |
name |
string optional. The file name. The extension must match the previous extension. |
expires_at |
string optional. The date and time the file will expire. |
Value
A list containing the following elements:
id |
integer, The ID of the file. |
name |
string, The file name. |
createdAt |
string, The date and time the file was created. |
fileSize |
integer, The file size. |
expiresAt |
string, The date and time the file will expire. If not specified, the file will expire in 30 days. To keep a file indefinitely, specify null. |
author |
list, A list containing the following elements:
|
downloadUrl |
string, A JSON string containing information about the URL of the file. |
fileUrl |
string, The URL that may be used to download the file. |
detectedInfo |
list, A list containing the following elements:
|
myPermissionLevel |
string, Your permission level on the object. One of "read", "write", or "manage". |