Platform Explorer / Nuxeo Platform LTS 2015 7.10

Operation Document.Export

Document Export

Description

Export the given document.
Operation id Document.Export
Category Services
Label Document Export
Requires
Since

Parameters

Name Description Type Required Default value
exportAsTree boolean no  
exportAsZip boolean no  

Signature

Inputs document
Outputs blob

Implementation information

Implementation class org.nuxeo.ecm.platform.io.operation.ExportDocument
Contributing component org.nuxeo.ecm.platform.io.operations

JSON definition

{
  "id" : "Document.Export",
  "label" : "Document Export",
  "category" : "Services",
  "requires" : null,
  "description" : "Export the given document.",
  "url" : "Document.Export",
  "signature" : [ "document", "blob" ],
  "params" : [ {
    "name" : "exportAsTree",
    "description" : "Export the document and all its children",
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "exportAsZip",
    "description" : "Create a ZIP of the export. If 'exportAsTree' is true, exportAsZip is force to true",
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}