Platform Explorer / Nuxeo Platform 9.1

Operation Document.GetBlob

Get Document File

Description

Gets a file attached to the input document. The file location is specified using an xpath to the blob property of the document. Returns the file.
Operation id Document.GetBlob
AliasesBlob.Get
Category Files
Label Get Document File
Requires
Since

Parameters

Name Description Type Required Default value
xpath string no file:content 

Signature

Inputs document, documents
Outputs blob, bloblist

Implementation information

Implementation class org.nuxeo.ecm.automation.core.operations.blob.GetDocumentBlob
Contributing component org.nuxeo.ecm.core.automation.coreContrib

JSON definition

{
  "id" : "Document.GetBlob",
  "aliases" : [ "Blob.Get" ],
  "label" : "Get Document File",
  "category" : "Files",
  "requires" : null,
  "description" : "Gets a file attached to the input document. The file location is specified using an xpath to the blob property of the document. Returns the file.",
  "url" : "Document.GetBlob",
  "signature" : [ "document", "blob", "documents", "bloblist" ],
  "params" : [ {
    "name" : "xpath",
    "description" : "",
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "file:content" ]
  } ],
  "widgets" : [ {
    "name" : "xpath",
    "type" : "codearea",
    "labels" : {
      "any" : "XPath"
    },
    "translated" : true,
    "handlingLabels" : false,
    "fields" : [ {
      "fieldName" : "xpath",
      "propertyName" : "xpath"
    } ],
    "properties" : {
      "any" : {
        "height" : "100%",
        "language" : "xpath",
        "width" : "100%"
      }
    }
  } ]
}