Platform Explorer / Nuxeo Platform LTS 2019 10.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. If no query or provider name is given, a query returning all the documents that the user has access to will be executed.
Operation id Repository.ResultSetQuery
AliasesResultSet.PaginatedQuery
Category Fetch
Label ResultSet Query
Requires
Since 6.0

Parameters

Name Description Type Required Default value
query The query to perform. string yes  
currentPageIndex Target listing page. integer no  
language The query language. string no NXQL, CMIS 
maxResults integer no  
namedParameters Named parameters to pass to the page provider to fill in query variables. properties no  
pageSize Entries number per page. integer no  
queryParams Ordered query parameters. stringlist no  
sortBy Sort by properties (separated by comma) stringlist no  
sortOrder Sort order, ASC or DESC stringlist no ASC, DESC 

Signature

Inputs void
Outputs recordset

Implementation Information

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" ]
  } ]
}