Concepts

Concepts used in Box BDK Book.

Box folder reference

Represents a folder, often used in lists or as a parent reference (Folder--Mini like).

ALSO : box item base

Field Name	Description	Type
id	The unique identifier for this folder.	text
type	The type of this resource, typically "folder". (Set by this class)	text
name	The name of this folder.	optional[text]
etag	The HTTP ETag of this folder.	optional[text]
sequence_id	A numeric identifier of the most recent event applied to this folder.	optional[text]

Box file reference

Reference to a file, containing key identifying information from list views (File--Mini like).

ALSO : box item base

Field Name	Description	Type
id	The unique identifier for this file.	text
type	The type, typically "file". (Set by this class)	text
name	The name of this file.	optional[text]
etag	The ETag of this file.	optional[text]
sequence_id	The sequence ID of this file.	optional[text]
sha1	The SHA1 hash of the file.	optional[text]
file_version	Mini representation of the file version.	optional[box file version mini]
parent	The parent folder of this file.	box item base] or optional[box folder reference

Box file version mini

Minimal representation of a file version.

Field Name	Description	Type
id	The unique identifier for this file version.	text
type	The type of this resource, typically "file_version".	text
sha1	The SHA1 hash of this version of the file.	optional[text]

Box item base

Mini representation of a web link.

ALSO : box web link mini

Field Name	Description	Type
id	The unique identifier for this web link.	text
type	The type of this resource, typically "web_link". (Set by this class)	text
name	The name of this web link.	optional[text]
etag	The HTTP ETag of this web link.	optional[text]
sequence_id	A numeric identifier of the most recent event applied to this web link.	optional[text]
url	The URL this web link points to.	optional[text]