Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

Mandatory
   
 Document or attachment to preview 
didThe document id. This must be a document within the scope.Mandatory
sdidThe sub document id. If you can supply it do so. A Beebox LivePreview requires this parameter.Optional
locale

Language of the file.

Mandatory
folderFolder ID of the file. If not specified the call refers to source/target document. Must be used to reference attachments.Optional
name

Name the file. If not specified the call refers to source/target document. Must be used to reference attachments.

Optional
   
 Preview options 
domainThe parser domain. If not specified, the domain is estimated. You should provide this parameter if you got this value from resources/files/detailsOptional
baseurlOptional base URL if the previewed file is a web page (used to offset relative image paths, css etc.)Optional
encoding

Optional encoding of file to preview. Use if you want to explicitly override the encoding currently saved with the file.

Optional

 

RESULTS

A TRM formatted JSON.

...