Page Comparison

...

scope	The scope object. Note that if you use a document set or global search scope, you will receive an "available" = false result. In fact these scopes do not support files.
did	The document id. This must be a document within the scope.
locales	Null or optional list of locales you want to get information for. If null then you get info for all the authorized locales in scope.
populateDepth	Null or optional depth of file structure to load . If not specified, the default 100 is used. It is recommended to leave this parameter unless you do not want to get sub folders in which case you would set to 0. : Not specified (recommended): Depth is 100. 0: Do not actually load any sub folders and thus includes just the basic information on the deliverable and the attachment root folder.

The message body contains a JSON object:

...

The file/folder nodes form a tree structure. A folder node may have file node and folder node children.

Each item in locales has these properties:

canDocSet

locale	The locale.
isSource	True: This is the source language.
	Source file or deliverable related properties
isdir	True: This is a folder node False: This is a file node
name	Name of file or folder
folder	Internal identifier of the parent node. Folder IDs are required when manipulating files.
exists	Boolean. Tells if the file or folder actually exists. If this node is a deliverable, it will be prepopulated with all information (such as the expected name of deliverable) but the deliverable may not yet exist on the server.
readonly	Boolean. Tells if the deliverable can be set, renamed or deleted.
canDocDownload	Boolean. Right to download the file.
canDocPreview	Boolean: Right to web preview the file.
document	A file node describing the document.
	Attachments
canAttSet	Boolean. User can set, rename, delete, manipulate attachments.
attachments	A folder node that contains the attachments file is readonly or not. The original file will be readonly. Currently, the API does not allow to set this flag, so basically it is of not much use today.
date	File/folder date. Null if not exists.
size	File/folder date. 0 if file/folder not exists.
scanned	Tells if the sub folders have been loaded. Ths is related to the populateDepth parameter.
files	Only exists if isdir is true. Array of file nodes contained in the present folder node.
folders	Only exists if isdir is true. Array of folder nodes contained in the present folder node.

See this example:

...

Versions Compared