Platform Explorer / Nuxeo Platform 11.3

Operation Document.CopySchema (Copy Schema)

Description

Copy all the properties from the schema of the source into the input document. Either sourceId or sourcePath parameter should be filled. When both are filled, sourceId will be used. If saveDocument is true, the document is saved. If save is true, the session is saved (setting save to true and saveDocument to false has no effect, the session will not be saved)
Operation id Document.CopySchema
Category Document
Label Copy Schema
Requires
Since

Parameters

Name Description Type Required Default value
schema string yes  
save boolean no true 
saveDocument boolean no true 
sourceId string no  
sourcePath string no  

Signature

Inputs document, documents
Outputs document, documents

Implementation Information

JSON Definition

{
  "id" : "Document.CopySchema",
  "label" : "Copy Schema",
  "category" : "Document",
  "requires" : null,
  "description" : "Copy all the properties from the schema of the source into the input document. Either sourceId or sourcePath parameter should be filled. When both are filled, sourceId will be used. If saveDocument is true, the document is saved. If save is true, the session is saved (setting save to true and saveDocument to false has no effect, the session will not be saved)",
  "url" : "Document.CopySchema",
  "signature" : [ "document", "document", "documents", "documents" ],
  "params" : [ {
    "name" : "schema",
    "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" ]
  }, {
    "name" : "saveDocument",
    "description" : null,
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "true" ]
  }, {
    "name" : "sourceId",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "sourcePath",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}