Platform Explorer / Nuxeo Platform LTS 2019 10.10

Operation Document.RemoveFacet (Remove Facet)

Description

Removes the facet from the document.

WARNING: The save parameter is true by default, which means the document is saved in the database after removing the facet. It must be set to false when the operation is used in the context of an event that will fail if the document is saved (empty document created, about to create, before modification, ...).

Operation id Document.RemoveFacet
AliasesDocument.RemoveFacet
Category Document
Label Remove Facet
Requires
Since

Parameters

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

Signature

Inputs document, documents
Outputs document, documents

Implementation Information

JSON Definition

{
  "id" : "Document.RemoveFacet",
  "aliases" : [ "Document.RemoveFacet" ],
  "label" : "Remove Facet",
  "category" : "Document",
  "requires" : null,
  "description" : "Removes the facet from the document. <p>WARNING: The save parameter is true by default, which means the document is saved in the database after removing the facet. It must be set to false when the operation is used in the context of an event that will fail if the document is saved (empty document created, about to create, before modification, ...).</p>",
  "url" : "Document.RemoveFacet",
  "signature" : [ "document", "document", "documents", "documents" ],
  "params" : [ {
    "name" : "facet",
    "description" : null,
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "save",
    "description" : null,
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "true" ]
  } ]
}