Platform Explorer / Nuxeo Platform LTS 2015 7.10

Operation Blob.RemoveFromDocument

Remove File

Description

Remove the file attached to the input document as specified by the 'xpath' parameter. If the 'xpath' point to a blob list then the list will be cleared. If the file to remove is part of a list it will be removed from the list otherwise the 'xpath' should point to a blob property that will be removed. If the save parameter is set the document modification will be automatically saved. Return the document.
Operation id Blob.RemoveFromDocument
AliasesBlob.Remove
Category Files
Label Remove File
Requires
Since

Parameters

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

Signature

Inputs document, documents
Outputs document, documents

Implementation information

Implementation class org.nuxeo.ecm.automation.core.operations.document.RemoveDocumentBlob
Contributing component org.nuxeo.ecm.core.automation.coreContrib

JSON definition

{
  "id" : "Blob.RemoveFromDocument",
  "aliases" : [ "Blob.Remove" ],
  "label" : "Remove File",
  "category" : "Files",
  "requires" : null,
  "description" : "Remove the file attached to the input document as specified by the 'xpath' parameter. If the 'xpath' point to a blob list then the list will be cleared. If the file to remove is part of a list it will be removed from the list otherwise the 'xpath' should point to a blob property that will be removed. If the save parameter is set the document modification will be automatically saved. Return the document.",
  "url" : "Blob.RemoveFromDocument",
  "signature" : [ "document", "document", "documents", "documents" ],
  "params" : [ {
    "name" : "save",
    "description" : "",
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "true" ]
  }, {
    "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%"
      }
    }
  } ]
}