files_get {civis}

Get details about a file

Description

Get details about a file

Usage

files_get(id, link_expires_at = NULL, inline = NULL)

Arguments

id

integer required. The ID of the file.

link_expires_at

string optional. The date and time the download link will expire. Must be a time between now and 36 hours from now. Defaults to 30 minutes from now.

inline

boolean optional. If true, will return a url that can be displayed inline in HTML

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:

• id integer, The ID of this user.

• name string, This user's name.

• username string, This user's username.

• initials string, This user's initials.

• online boolean, Whether this user is online.

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:

• includeHeader boolean, A boolean value indicating whether or not the first row of the file is a header row.

• columnDelimiter string, The column delimiter for the file. One of "comma", "tab", or "pipe".

• compression string, The type of compression of the file. One of "gzip", or "none".

• tableColumns array, An array of hashes corresponding to the columns in the file. Each hash should have keys for column "name" and "sql_type"

myPermissionLevel

string, Your permission level on the object. One of "read", "write", or "manage".