Platform Explorer / Nuxeo Platform LTS 2015 7.10

Operation UserGroup.Suggestion

Get user/group suggestion

Description

Get the user/group list of the running instance. This is returning a blob containing a serialized JSON array..
Operation id UserGroup.Suggestion
Category Services
Label Get user/group suggestion
Requires
Since

Parameters

Name Description Type Required Default value
displayEmailInSuggestion boolean no  
firstLabelField string no  
groupRestriction string no  
hideAdminGroups boolean no  
hideFirstLabel boolean no  
hideIcon boolean no  
hideSecondLabel boolean no  
hideThirdLabel boolean no  
lang string no  
searchTerm string no  
searchType string no  
secondLabelField string no  
thirdLabelField string no  
userSuggestionMaxSearchResults integer no  

Signature

Inputs void
Outputs blob

Implementation information

Implementation class org.nuxeo.ecm.platform.ui.select2.automation.SuggestUserEntries
Contributing component org.nuxeo.ecm.platform.ui.select2.opertion.contrib

JSON definition

{
  "id" : "UserGroup.Suggestion",
  "label" : "Get user/group suggestion",
  "category" : "Services",
  "requires" : null,
  "description" : "Get the user/group list of the running instance. This is returning a blob containing a serialized JSON array..",
  "url" : "UserGroup.Suggestion",
  "signature" : [ "void", "blob" ],
  "params" : [ {
    "name" : "displayEmailInSuggestion",
    "description" : "",
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "firstLabelField",
    "description" : "",
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "groupRestriction",
    "description" : "Enter the id of a group to suggest only user from this group.",
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "hideAdminGroups",
    "description" : "If set, remove all administrator groups from the suggestions",
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "hideFirstLabel",
    "description" : "",
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "hideIcon",
    "description" : "",
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "hidePowerUsersGroup",
    "description" : "If set, remove power users group from the suggestions",
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "hideSecondLabel",
    "description" : "",
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "hideThirdLabel",
    "description" : "",
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "lang",
    "description" : "",
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "searchTerm",
    "description" : "",
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "searchType",
    "description" : "",
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "secondLabelField",
    "description" : "",
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "thirdLabelField",
    "description" : "",
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "userSuggestionMaxSearchResults",
    "description" : "",
    "type" : "integer",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}