Platform Explorer / Nuxeo Platform LTS 2015 7.10

Operation Repository.ResultSetQuery

ResultSet Query

Description

Perform a query on the repository. The result set returned will become the input for the next operation.
Operation id Repository.ResultSetQuery
AliasesResultSet.PaginatedQuery
Category Fetch
Label ResultSet Query
Requires
Since 6.0

Parameters

Name Description Type Required Default value
query string yes  
currentPageIndex integer no  
language string no NXQL, CMIS 
namedParameters properties no  
pageSize integer no  
queryParams stringlist no  
sortBy string no  
sortOrder string no ASC, DESC 

Signature

Inputs void
Outputs recordset

Implementation information

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

JSON definition

{
  "id" : "Repository.ResultSetQuery",
  "aliases" : [ "ResultSet.PaginatedQuery" ],
  "label" : "ResultSet Query",
  "category" : "Fetch",
  "requires" : null,
  "description" : "Perform a query on the repository. The result set returned will become the input for the next operation. If no query or provider name is given, a query returning all the documents that the user has access to will be executed.",
  "since" : "6.0",
  "url" : "Repository.ResultSetQuery",
  "signature" : [ "void", "recordset" ],
  "params" : [ {
    "name" : "query",
    "description" : "The query to perform.",
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "currentPageIndex",
    "description" : "Target listing page.",
    "type" : "integer",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "language",
    "description" : "The query language.",
    "type" : "string",
    "required" : false,
    "widget" : "Option",
    "order" : 0,
    "values" : [ "NXQL", "CMIS" ]
  }, {
    "name" : "maxResults",
    "description" : "",
    "type" : "integer",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "namedParameters",
    "description" : "Named parameters to pass to the page provider to fill in query variables.",
    "type" : "properties",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "pageSize",
    "description" : "Entries number per page.",
    "type" : "integer",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "queryParams",
    "description" : "Ordered query parameters.",
    "type" : "stringlist",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "sortBy",
    "description" : "Sort by properties (separated by comma)",
    "type" : "stringlist",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "sortOrder",
    "description" : "Sort order, ASC or DESC",
    "type" : "stringlist",
    "required" : false,
    "widget" : "Option",
    "order" : 0,
    "values" : [ "ASC", "DESC" ]
  } ],
  "widgets" : [ {
    "name" : "query",
    "type" : "codearea",
    "labels" : {
      "any" : "ResultSet Query"
    },
    "translated" : true,
    "handlingLabels" : false,
    "fields" : [ {
      "fieldName" : "query",
      "propertyName" : "query"
    } ],
    "properties" : {
      "any" : {
        "height" : "100%",
        "language" : "nxql",
        "width" : "100%"
      }
    }
  } ]
}