Platform Explorer / Nuxeo Platform 6.0

Operation Document.RemoveProperty

Remove Property

Description

Remove the given property of the input document(s) as specified by the 'xpath' parameter. If the property points to a list then clear the list. Removing a property means setting it to null. Return the document(s).
Operation id Document.RemoveProperty
Category Document
Label Remove Property
Requires
Since

Parameters

Name Description Type Required Default value
xpath string yes  
save boolean no true 

Signature

Inputs document, documents
Outputs document, documents

Implementation information

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

JSON definition

{
  "id" : "Document.RemoveProperty",
  "label" : "Remove Property",
  "category" : "Document",
  "requires" : null,
  "description" : "Remove the given property of the input document(s) as specified by the 'xpath' parameter. If the property points to a list then clear the list. Removing a property means setting it to null. Return the document(s).",
  "url" : "Document.RemoveProperty",
  "signature" : [ "document", "document", "documents", "documents" ],
  "params" : [ {
    "name" : "xpath",
    "description" : "",
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "save",
    "description" : "",
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "true" ]
  } ],
  "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%"
      }
    }
  } ]
}