Read File Info
Retrieve information about a file to use in other cards. Note that this only works when the file was uploaded with a file extention. Information cannot be returned for files without extensions.
Input
Field | Definition | Type | Required |
---|---|---|---|
File | |||
File ID | unique identifier of the file | String | FALSE |
Output
Field | Definition | Type | Required |
---|---|---|---|
File | |||
File Name | name of the file | String | FALSE |
File Extension | type of file, without . (for example, png or jpg) |
String | FALSE |
File Description | description of the file | String | FALSE |
Version ID | version ID of the file (tracked for Box users with premium accounts only) | String | FALSE |
Version Tag | version tag of the file (tracked for Box users with premium accounts only) | String | FALSE |
Sequence ID | unique identifier for use with events endpoint | String | FALSE |
Size | size of the file in bytes (use caution when parsing this integer to prevent EE notation: IEEE754 format) | String | FALSE |
Path | path that designates the key, in the format of a JSON-Pointer (see Note) | String | FALSE |
Time Created | timestamp when the file was created | String | FALSE |
Time Modified | timestamp when the file was modified | String | FALSE |
Time Trashed | timestamp when the file was trashed | String | FALSE |
Time Purged | timestamp when the file was purged | String | FALSE |
Time Created | timestamp when the file was created in Box | String | FALSE |
Time Content Created | timestamp when the file content was created | String | FALSE |
Parent Folder Name | name of the file's parent folder | String | FALSE |
Parent Folder ID | unique identifier of the file's parent folder | String | FALSE |
Item Status | status of the item (active , trashed , or deleted ) |
String | FALSE |
Tags | list of the tags on this folder | list of text | FALSE |
Share Link | |||
Share URL | URL to view the file | String | FALSE |
Download URL | URL to download the file | String | FALSE |
Vanity URL | customizable URL (for example, "go.site.com/winterpromo") | String | FALSE |
Password Enabled | indicator of password | String | FALSE |
Time Unshared | timestamp when the link was unshared | String | FALSE |
Download Count | number of times the link was downloaded | String | FALSE |
Access Level | accessibility of the share link (for example, Edit or View ) |
String | FALSE |
Can Download | indicator of downloadable content | String | FALSE |
Can Preview | indicator of viewable content | String | FALSE |
Allowed Link Access Level | amount of access available for the link | String | FALSE |
Created By | |||
Name | name of the user who created the file | String | FALSE |
User ID | unique identifier of the user | String | FALSE |
email address of the user | String | FALSE | |
Modified by | |||
Name | name of the user who modified the file | String | FALSE |
User ID | unique identifier of the user | String | FALSE |
email address of the user | String | FALSE | |
Owned By | |||
Name | name of the user who owns the file | String | FALSE |
User ID | unique identifier of the owner | String | FALSE |
email address of the owner | String | FALSE |
Note: Because all keys are located at the root of the metadata instance, the key must be prefixed with a /
. Special characters ~
and /
in the key must be escaped according to the JSON-Pointer specification. The value at the path must exist for the operation to be successful.