Platform Explorer / Nuxeo Platform LTS 2015 7.10

Operation Document.AddPermission (Add Permission)

Description

Add Permission on the input document(s). Returns the document(s).
Operation id Document.AddPermission
AliasesDocument.AddACL
Category Document
Label Add Permission
Requires
Since

Parameters

Name Description Type Required Default value
permission string yes  
username string yes  
acl string no local 
begin date no  
blockInheritance boolean no  
comment string no  
end date no  
notify boolean no  

Signature

Inputs document, documents
Outputs document, documents

Implementation Information

JSON Definition

{
  "id" : "Document.AddPermission",
  "aliases" : [ "Document.AddACL" ],
  "label" : "Add Permission",
  "category" : "Document",
  "requires" : null,
  "description" : "Add Permission on the input document(s). Returns the document(s).",
  "url" : "Document.AddPermission",
  "signature" : [ "document", "document", "documents", "documents" ],
  "params" : [ {
    "name" : "permission",
    "description" : null,
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "username",
    "description" : null,
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "acl",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "local" ]
  }, {
    "name" : "begin",
    "description" : null,
    "type" : "date",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "blockInheritance",
    "description" : null,
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "comment",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "end",
    "description" : null,
    "type" : "date",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "notify",
    "description" : null,
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}