Platform Explorer / server 10.10

Operation Repository.Query

Query

Description

Perform a query on the repository. The document list returned will become the input for the next operation.If no provider name is given, a query returning all the documents that the user has access to will be executed.
Operation id Repository.Query
AliasesDocument.Query
Category Fetch
Label Query
Requires
Since 6.0

Parameters

Name Description Type Required Default value
currentPageIndex Target listing page. integer no  
language The query language. string no NXQL 
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  
query The query to perform. string 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 documents

Implementation information

Implementation class org.nuxeo.ecm.automation.core.operations.services.query.DocumentPaginatedQuery
Contributing component org.nuxeo.ecm.core.automation.features.operations

JSON definition

{
  "id" : "Repository.Query",
  "aliases" : [ "Document.Query" ],
  "label" : "Query",
  "category" : "Fetch",
  "requires" : null,
  "description" : "Perform a query on the repository. The document list returned will become the input for the next operation.If no provider name is given, a query returning all the documents that the user has access to will be executed.",
  "since" : "6.0",
  "url" : "Repository.Query",
  "signature" : [ "void", "documents" ],
  "params" : [ {
    "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" ]
  }, {
    "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" : "query",
    "description" : "The query to perform.",
    "type" : "string",
    "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" : "Query"
    },
    "translated" : true,
    "handlingLabels" : false,
    "fields" : [ {
      "fieldName" : "query",
      "propertyName" : "query"
    } ],
    "properties" : {
      "any" : {
        "height" : "100%",
        "language" : "nxql",
        "width" : "100%"
      }
    }
  } ]
}