Platform Explorer / Nuxeo Platform 5.6

Operation Document.Lock

Lock

Description

Lock the input document for the current user. Returns back the locked document.
  • 5.6
  • 5.7.1

The parameter owner should be left empty as it is not used. The owner will be the current user.

Operation id Document.Lock
Category Document
Label Lock
Requires
Since

Parameters

Name Description Type Required Default value
owner string no  

Signature

Inputs document, documents
Outputs document, documents

Implementation information

Implementation class org.nuxeo.ecm.automation.core.operations.document.LockDocument
Contributing component BuiltIn

JSON definition

{
  "id" : "Document.Lock",
  "label" : "Lock",
  "category" : "Document",
  "requires" : null,
  "description" : "Lock the input document for the current user. Returns back the locked document.",
  "url" : "Document.Lock",
  "signature" : [ "document", "document", "documents", "documents" ],
  "params" : [ ]
}