Platform Explorer / Nuxeo Platform LTS 2015 7.10

Operation User.GetCollections

Get collections

Description

Get the list of all the collections visible by the currentUser. This is returning a list of collections.
Operation id User.GetCollections
AliasesCollection.GetCollections
Category Document
Label Get collections
Requires
Since

Parameters

Name Description Type Required Default value
searchTerm string yes  

Signature

Inputs void
Outputs documents

Implementation information

Implementation class org.nuxeo.ecm.collections.core.automation.GetCollectionsOperation
Contributing component org.nuxeo.collections.operations

JSON definition

{
  "id" : "User.GetCollections",
  "aliases" : [ "Collection.GetCollections" ],
  "label" : "Get collections",
  "category" : "Document",
  "requires" : null,
  "description" : "Get the list of all the collections visible by the currentUser. This is returning a list of collections.",
  "url" : "User.GetCollections",
  "signature" : [ "void", "documents" ],
  "params" : [ {
    "name" : "searchTerm",
    "description" : "",
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}