Platform Explorer / Nuxeo Platform LTS 2015 7.10

Operation Directory.Entries

Get directory entries

Description

Get the entries of a directory. This is returning a blob containing a serialized JSON array. The input document, if specified, is used as a context for a potential local configuration of the directory.
Operation id Directory.Entries
Category Services
Label Get directory entries
Requires
Since

Parameters

Name Description Type Required Default value
directoryName string yes  
lang string no  
translateLabels boolean no  

Signature

Inputs void, document
Outputs blob, blob

Implementation information

Implementation class org.nuxeo.ecm.automation.core.operations.services.GetDirectoryEntries
Contributing component org.nuxeo.ecm.core.automation.featuresContrib

JSON definition

{
  "id" : "Directory.Entries",
  "label" : "Get directory entries",
  "category" : "Services",
  "requires" : null,
  "description" : "Get the entries of a directory. This is returning a blob containing a serialized JSON array. The input document, if specified, is used as a context for a potential local configuration of the directory.",
  "url" : "Directory.Entries",
  "signature" : [ "void", "blob", "document", "blob" ],
  "params" : [ {
    "name" : "directoryName",
    "description" : "",
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "lang",
    "description" : "",
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "translateLabels",
    "description" : "",
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}