{
  "opencollection": "1.0.0",
  "info": {
    "name": "Nuxeo Platform ACL Search API",
    "version": "LTS 2021"
  },
  "items": [
    {
      "info": {
        "name": "Search",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Execute a page provider on document by its id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/nuxeo/api/v1/id/:docId/@pp/:pageProviderName",
            "headers": [
              {
                "name": "X-NXDocumentProperties",
                "value": ""
              },
              {
                "name": "X-NXContext-Category",
                "value": ""
              },
              {
                "name": "X-Versioning-Option",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "docId",
                "value": "",
                "type": "path",
                "description": "Id of the document"
              },
              {
                "name": "pageProviderName",
                "value": "",
                "type": "path",
                "description": "Name of the page provider, ex: 'user_domains'"
              },
              {
                "name": "currentPageIndex",
                "value": "",
                "type": "query",
                "description": "Index of the current page"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Offset of the page to retrieve. If set, the 'currentPageIndex' parameter is ignored."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Size of the page to retrieve. Ignored if offset set"
              },
              {
                "name": "maxResults",
                "value": "",
                "type": "query",
                "description": "Maximum results to retrieve"
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "Property to sort by, for example 'dc:title'"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "Sort order, accepts 'asc' or 'desc', default is 'desc'"
              }
            ]
          },
          "docs": "Only documents which you have permission to see will be returned"
        },
        {
          "info": {
            "name": "Execute a page provider on document by its path",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/nuxeo/api/v1/path/:docPath/@pp/:pageProviderName",
            "headers": [
              {
                "name": "X-NXDocumentProperties",
                "value": ""
              },
              {
                "name": "X-NXContext-Category",
                "value": ""
              },
              {
                "name": "X-Versioning-Option",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "docPath",
                "value": "",
                "type": "path",
                "description": "Path of the document, ex: 'default-domain'"
              },
              {
                "name": "pageProviderName",
                "value": "",
                "type": "path",
                "description": "Name of the page provider, ex: 'user_domains'"
              },
              {
                "name": "currentPageIndex",
                "value": "",
                "type": "query",
                "description": "Index of the current page"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Offset of the page to retrieve. If set, the 'currentPageIndex' parameter is ignored."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Size of the page to retrieve. Ignored if offset set"
              },
              {
                "name": "maxResults",
                "value": "",
                "type": "query",
                "description": "Maximum results to retrieve"
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "Property to sort by, for example 'dc:title'"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "Sort order, accepts 'asc' or 'desc', default is 'desc'"
              }
            ]
          },
          "docs": "Only documents which you have permission to see will be returned"
        },
        {
          "info": {
            "name": "Perform Named Page Provider on the repository",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/nuxeo/api/v1/query",
            "params": [
              {
                "name": "query",
                "value": "",
                "type": "query",
                "description": "The query to perform. (By default: SELECT * FROM Document)"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "The number of entries per page. (By default: 0)"
              },
              {
                "name": "currentPageIndex",
                "value": "",
                "type": "query",
                "description": "The selected page index. (By default: 0)"
              },
              {
                "name": "maxResults",
                "value": "",
                "type": "query",
                "description": "The maximum entries. (By default: 200)"
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "Property(ies) sorting. (Example: sortBy='dc:title,dc:description')"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "Sort order. (Example: sortOrder='DESC,ASC')"
              },
              {
                "name": "queryParams",
                "value": "",
                "type": "query",
                "description": "Ordered parameters. (Example: for 'Select * From Document where dc:title = ?' -> queryParams='titleA')"
              }
            ]
          },
          "docs": "You can have also named parameters in the query. See http://doc.nuxeo.com/x/qAc5AQ"
        },
        {
          "info": {
            "name": "Perform Named Page Provider on the repository",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/nuxeo/api/v1/query/:providerName",
            "params": [
              {
                "name": "providerName",
                "value": "",
                "type": "path",
                "description": "The page provider name."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "The number of entries per page. (By default: 0)"
              },
              {
                "name": "currentPageIndex",
                "value": "",
                "type": "query",
                "description": "The selected page index. (By default: 0)"
              },
              {
                "name": "maxResults",
                "value": "",
                "type": "query",
                "description": "The maximum entries. (By default: 200)"
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "Property(ies) sorting. (Example: sortBy='dc:title,dc:description')"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "Sort order. (Example: sortOrder='DESC,ASC')"
              },
              {
                "name": "queryParams",
                "value": "",
                "type": "query",
                "description": "Ordered parameters. (Example: for 'Select * From Document where dc:title = ?' -> queryParams='titleA')"
              }
            ]
          },
          "docs": "You can have also named parameters in the query. See http://doc.nuxeo.com/x/qAc5AQ"
        },
        {
          "info": {
            "name": "Performs a bulk action on the query result.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{host}:{port}/nuxeo/api/v1/search/lang/:queryLanguage/bulk/:actionId",
            "params": [
              {
                "name": "queryLanguage",
                "value": "",
                "type": "path",
                "description": "The query language."
              },
              {
                "name": "query",
                "value": "",
                "type": "query",
                "description": "The query to perform. (By default: SELECT * FROM Document)"
              },
              {
                "name": "queryParams",
                "value": "",
                "type": "query",
                "description": "Ordered parameters. (Example: for 'Select * From Document where dc:title = ?' -> queryParams='titleA')"
              },
              {
                "name": "actionId",
                "value": "",
                "type": "path",
                "description": "Id of the bulk action"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "You can have also named parameters in the query. See http://doc.nuxeo.com/x/qAc5AQ"
        },
        {
          "info": {
            "name": "Performs a search query.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/nuxeo/api/v1/search/lang/:queryLanguage/execute",
            "params": [
              {
                "name": "queryLanguage",
                "value": "",
                "type": "path",
                "description": "The query language."
              },
              {
                "name": "query",
                "value": "",
                "type": "query",
                "description": "The query to perform. (By default: SELECT * FROM Document)"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "The number of entries per page. (By default: 0)"
              },
              {
                "name": "currentPageIndex",
                "value": "",
                "type": "query",
                "description": "The selected page index. (By default: 0)"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The offset of the returned result set. If set, the 'currentPageIndex' parameter is ignored."
              },
              {
                "name": "maxResults",
                "value": "",
                "type": "query",
                "description": "The maximum entries. (By default: 200)"
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "Property(ies) sorting. (Example: sortBy='dc:title,dc:description')"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "Sort order. (Example: sortOrder='DESC,ASC')"
              },
              {
                "name": "queryParams",
                "value": "",
                "type": "query",
                "description": "Ordered parameters. (Example: for 'Select * From Document where dc:title = ?' -> queryParams='titleA')"
              }
            ]
          },
          "docs": "You can have also named parameters in the query. See http://doc.nuxeo.com/x/qAc5AQ"
        },
        {
          "info": {
            "name": "Gets the definition of a page provider.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/nuxeo/api/v1/search/pp/:providerName",
            "params": [
              {
                "name": "providerName",
                "value": "",
                "type": "path",
                "description": "The page provider name."
              }
            ]
          },
          "docs": "Gets the definition of a page provider."
        },
        {
          "info": {
            "name": "Performs a bulk action on the query result.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{host}:{port}/nuxeo/api/v1/search/pp/:providerName/bulk/:actionId",
            "params": [
              {
                "name": "providerName",
                "value": "",
                "type": "path",
                "description": "The page provider name."
              },
              {
                "name": "queryParams",
                "value": "",
                "type": "query",
                "description": "Ordered parameters. (Example: for 'Select * From Document where dc:title = ?' -> queryParams='titleA')"
              },
              {
                "name": "actionId",
                "value": "",
                "type": "path",
                "description": "Id of the bulk action"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "You can have also named parameters in the query. See http://doc.nuxeo.com/x/qAc5AQ"
        },
        {
          "info": {
            "name": "Perform Named Page Provider on the repository",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/nuxeo/api/v1/search/pp/:providerName/execute",
            "params": [
              {
                "name": "providerName",
                "value": "",
                "type": "path",
                "description": "The page provider name."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "The number of entries per page. (By default: 0)"
              },
              {
                "name": "currentPageIndex",
                "value": "",
                "type": "query",
                "description": "The selected page index. (By default: 0)"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The offset of the returned result set. If set, the 'currentPageIndex' parameter is ignored."
              },
              {
                "name": "maxResults",
                "value": "",
                "type": "query",
                "description": "The maximum entries. (By default: 200)"
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "Property(ies) sorting. (Example: sortBy='dc:title,dc:description')"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "Sort order. (Example: sortOrder='DESC,ASC')"
              },
              {
                "name": "queryParams",
                "value": "",
                "type": "query",
                "description": "Ordered parameters. (Example: for 'Select * From Document where dc:title = ?' -> queryParams='titleA')"
              }
            ]
          },
          "docs": "You can have also named parameters in the query. See http://doc.nuxeo.com/x/qAc5AQ"
        },
        {
          "info": {
            "name": "Returns the list of saved searches.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/nuxeo/api/v1/search/saved",
            "params": [
              {
                "name": "pageProvider",
                "value": "",
                "type": "query",
                "description": "Name of the page provider."
              }
            ]
          },
          "docs": "Returns the list of saved searches."
        },
        {
          "info": {
            "name": "Saves a search.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{host}:{port}/nuxeo/api/v1/search/saved",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Saves a search."
        },
        {
          "info": {
            "name": "Return the saved search with the supplied id.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/nuxeo/api/v1/search/saved/:searchId",
            "params": [
              {
                "name": "searchId",
                "value": "",
                "type": "path",
                "description": "The search id."
              }
            ]
          },
          "docs": "Return the saved search with the supplied id."
        },
        {
          "info": {
            "name": "Updates the saved search with the supplied id.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{host}:{port}/nuxeo/api/v1/search/saved/:searchId",
            "params": [
              {
                "name": "searchId",
                "value": "",
                "type": "path",
                "description": "The search id."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the saved search with the supplied id."
        },
        {
          "info": {
            "name": "Deletes the saved search with the supplied id.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{host}:{port}/nuxeo/api/v1/search/saved/:searchId",
            "params": [
              {
                "name": "searchId",
                "value": "",
                "type": "path",
                "description": "The search id."
              }
            ]
          },
          "docs": "Deletes the saved search with the supplied id."
        },
        {
          "info": {
            "name": "Performs a bulk action on the saved search result.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{host}:{port}/nuxeo/api/v1/search/saved/:searchId/bulk/:actionId",
            "params": [
              {
                "name": "searchId",
                "value": "",
                "type": "path",
                "description": "The search id."
              },
              {
                "name": "actionId",
                "value": "",
                "type": "path",
                "description": "Id of the bulk action"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Performs a bulk action on the saved search result."
        },
        {
          "info": {
            "name": "Executes saved searches, returning its results.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/nuxeo/api/v1/search/saved/:searchId/execute",
            "params": [
              {
                "name": "searchId",
                "value": "",
                "type": "path",
                "description": "The search id."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "The number of entries per page. (By default: 0)"
              },
              {
                "name": "currentPageIndex",
                "value": "",
                "type": "query",
                "description": "The selected page index. (By default: 0)"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The offset of the returned result set. If set, the 'currentPageIndex' parameter is ignored."
              },
              {
                "name": "maxResults",
                "value": "",
                "type": "query",
                "description": "The maximum entries. (By default: 200)"
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "Property(ies) sorting. (Example: sortBy='dc:title,dc:description')"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "Sort order. (Example: sortOrder='DESC,ASC')"
              }
            ]
          },
          "docs": "Executes saved searches, returning its results."
        },
        {
          "info": {
            "name": "Get the children of a document by its id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/nuxeo/api/v1/id/:docId/@search",
            "headers": [
              {
                "name": "X-NXDocumentProperties",
                "value": ""
              },
              {
                "name": "X-NXContext-Category",
                "value": ""
              },
              {
                "name": "X-Versioning-Option",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "docId",
                "value": "",
                "type": "path",
                "description": "Id of the document"
              },
              {
                "name": "query",
                "value": "",
                "type": "query",
                "description": "NXQL query"
              },
              {
                "name": "fullText",
                "value": "",
                "type": "query",
                "description": "A full text query"
              },
              {
                "name": "orderBy",
                "value": "",
                "type": "query",
                "description": "Field on which to order"
              },
              {
                "name": "currentPageIndex",
                "value": "",
                "type": "query",
                "description": "Index of the current page"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Offset of the page to retrieve. If set, the 'currentPageIndex' parameter is ignored."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Size of the page to retrieve. Ignored if offset set"
              },
              {
                "name": "maxResults",
                "value": "",
                "type": "query",
                "description": "Maximum results to retrieve"
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "Property to sort by, for example 'dc:title'"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "Sort order, accepts 'asc' or 'desc', default is 'desc'"
              }
            ]
          },
          "docs": "Only documents which you have permission to see will be returned"
        },
        {
          "info": {
            "name": "Get the children of a document by its path",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/nuxeo/api/v1/path/:docPath/@search",
            "headers": [
              {
                "name": "X-NXDocumentProperties",
                "value": ""
              },
              {
                "name": "X-NXContext-Category",
                "value": ""
              },
              {
                "name": "X-Versioning-Option",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "docPath",
                "value": "",
                "type": "path",
                "description": "Path of the document, ex: 'default-domain'"
              },
              {
                "name": "currentPageIndex",
                "value": "",
                "type": "query",
                "description": "Index of the current page"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Offset of the page to retrieve. If set, the 'currentPageIndex' parameter is ignored."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Size of the page to retrieve. Ignored if offset set"
              },
              {
                "name": "maxResults",
                "value": "",
                "type": "query",
                "description": "Maximum results to retrieve"
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "Property to sort by, for example 'dc:title'"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "Sort order, accepts 'asc' or 'desc', default is 'desc'"
              },
              {
                "name": "query",
                "value": "",
                "type": "query",
                "description": "NXQL query"
              },
              {
                "name": "fullText",
                "value": "",
                "type": "query",
                "description": "A full text query"
              },
              {
                "name": "orderBy",
                "value": "",
                "type": "query",
                "description": "Field on which to order"
              }
            ]
          },
          "docs": "Only documents which you have permission to see will be returned"
        }
      ]
    }
  ],
  "bundled": true
}