Platform Explorer / Nuxeo Platform 5.6

Operation Document.CheckIn

Check In

Description

Checks in the input document. Returns back the document.
Operation id Document.CheckIn
Category Document
Label Check In
Requires
Since

Parameters

Name Description Type Required Default value
version string yes minor, major 
comment string no  
versionVarName string no  

Signature

Inputs document, documents
Outputs document, documents

Implementation information

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

JSON definition

{
  "id" : "Document.CheckIn",
  "label" : "Check In",
  "category" : "Document",
  "requires" : null,
  "description" : "Checks in the input document. Returns back the document.",
  "url" : "Document.CheckIn",
  "signature" : [ "document", "document", "documents", "documents" ],
  "params" : [ {
    "name" : "version",
    "description" : "",
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ "minor", "major" ]
  }, {
    "name" : "comment",
    "description" : "",
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 1,
    "values" : [ ]
  }, {
    "name" : "versionVarName",
    "description" : "",
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 2,
    "values" : [ ]
  } ]
}