Platform Explorer / Nuxeo Platform 5.8

Operation Document.PageProvider (PageProvider)

Description

Perform a query or a named provider query on the repository. Result is paginated. The query result 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 Document.PageProvider
Category Fetch
Label PageProvider
Requires
Since

Parameters

Name Description Type Required Default value
currentPageIndex integer no  
documentLinkBuilder string no  
language string no NXQL 
maxResults string no  
page integer no  
pageSize integer no  
providerName string no  
query string no  
queryParams stringlist no  
sortInfo stringlist no  

Signature

Inputs void
Outputs documents

Implementation Information

JSON Definition

{
  "id" : "Document.PageProvider",
  "label" : "PageProvider",
  "category" : "Fetch",
  "requires" : "",
  "description" : "Perform a query or a named provider query on the repository. Result is paginated. The query result 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.",
  "url" : "Document.PageProvider",
  "signature" : [ "void", "documents" ],
  "params" : [ {
    "name" : "currentPageIndex",
    "description" : null,
    "type" : "integer",
    "required" : false,
    "widget" : "",
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "documentLinkBuilder",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : "",
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "language",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : "Option",
    "order" : 0,
    "values" : [ "NXQL" ]
  }, {
    "name" : "maxResults",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : "",
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "page",
    "description" : null,
    "type" : "integer",
    "required" : false,
    "widget" : "",
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "pageSize",
    "description" : null,
    "type" : "integer",
    "required" : false,
    "widget" : "",
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "providerName",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : "",
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "query",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : "",
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "queryParams",
    "description" : null,
    "type" : "stringlist",
    "required" : false,
    "widget" : "",
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "sortInfo",
    "description" : null,
    "type" : "stringlist",
    "required" : false,
    "widget" : "",
    "order" : 0,
    "values" : [ ]
  } ]
}