Platform Explorer / Nuxeo Platform 6.0

Operation Document.GetBlobsByProperty

Get Document Files

Description

Gets a list of files that are attached on the input document. The files location should be specified using the blob list property xpath. Returns a list of files.
Operation id Document.GetBlobsByProperty
AliasesBlob.GetList
Category Files
Label Get Document Files
Requires
Since

Parameters

Name Description Type Required Default value
xpath string no files:files 

Signature

Inputs document, documents
Outputs bloblist, bloblist

Implementation information

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

JSON definition

{
  "id" : "Document.GetBlobsByProperty",
  "aliases" : [ "Blob.GetList" ],
  "label" : "Get Document Files",
  "category" : "Files",
  "requires" : null,
  "description" : "Gets a list of files that are attached on the input document. The files location should be specified using the blob list property xpath. Returns a list of files.",
  "url" : "Document.GetBlobsByProperty",
  "signature" : [ "document", "bloblist", "documents", "bloblist" ],
  "params" : [ {
    "name" : "xpath",
    "description" : "",
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "files:files" ]
  } ],
  "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%"
      }
    }
  } ]
}