Platform Explorer / Nuxeo Platform 11.3

Operation Document.PublishToSection (Publish Document's Rendition)

Description

input document's chosen rendition into the target section. If rendition is not given and default rendition option is false, it falls back on default publishing. Existing proxy is overrided if the override attribute is set. Return the created proxy.
Operation id Document.PublishToSection
AliasesDocument.PublishRendition
Category Document
Label Publish Document's Rendition
Requires
Since

Parameters

Name Description Type Required Default value
target document yes  
defaultRendition boolean no  
override boolean no true 
renditionName string no  

Signature

Inputs document, documents
Outputs document, documents

Implementation Information

JSON Definition

{
  "id" : "Document.PublishToSection",
  "aliases" : [ "Document.PublishRendition" ],
  "label" : "Publish Document's Rendition",
  "category" : "Document",
  "requires" : null,
  "description" : "input document's chosen rendition into the target section. If rendition is not given and default rendition option is false, it falls back on default publishing. Existing proxy is overrided if the override attribute is set. Return the created proxy.",
  "url" : "Document.PublishToSection",
  "signature" : [ "document", "document", "documents", "documents" ],
  "params" : [ {
    "name" : "target",
    "description" : null,
    "type" : "document",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "defaultRendition",
    "description" : null,
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "override",
    "description" : null,
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "true" ]
  }, {
    "name" : "renditionName",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}