Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nuxeo Search API

Search Operations

Nuxeo Search API is one of 22 APIs that Nuxeo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Search. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 18 operations across 15 paths, and defines 5 schemas. It is described by OpenAPI 3.0.2, at version LTS 2021.

Requests are made against 2 base URLs: https://{host}:{port}/nuxeo/api/v1, https://nightly.nuxeo.com/nuxeo/api/v1.

18 operations 15 paths 5 schemas 1 DELETE12 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
LTS 2021
Base URL
https://{nuxeo-server}/nuxeo/api/v1
Authentication
HTTP Basic, API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Nuxeo Search API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basic_auth). An API key is passed in the header as X-Authentication-Token (token).

Paths & Operations 18

Across 15 paths, the API surfaces 18 operations — 1 DELETE, 12 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Search 18

Search Operations

GET
/id/{docId}/@pp/{pageProviderName}
Execute a page provider on document by its id
DocumentIdPageProviderAdapterGet 11 params → 200401404
GET
/path/{docPath}/@pp/{pageProviderName}
Execute a page provider on document by its path
DocumentPathPageProviderAdapterGet 11 params → 200401404
GET
/query
Perform Named Page Provider on the repository
QueryGet 7 params → 200401404
GET
/query/{providerName}
Perform Named Page Provider on the repository
QueryProviderGet 7 params → 200401404
POST
/search/lang/{queryLanguage}/bulk/{actionId}
Performs a bulk action on the query result.
SearchLangBulkActionPost 4 params body → 200401404
GET
/search/lang/{queryLanguage}/execute
Performs a search query.
SearchLangExecuteGet 9 params → 200401404
GET
/search/pp/{providerName}
Gets the definition of a page provider.
SearchPageProviderGet 1 param → 200401404
POST
/search/pp/{providerName}/bulk/{actionId}
Performs a bulk action on the query result.
SearchPageProviderBulkPost 3 params body → 200401404
GET
/search/pp/{providerName}/execute
Perform Named Page Provider on the repository
SearchPageProviderExecuteGet 8 params → 200401404
GET
/search/saved
Returns the list of saved searches.
SearchSavedGet 1 param → 200401404
POST
/search/saved
Saves a search.
SearchSavedPost body → 200401404
DELETE
/search/saved/{searchId}
Deletes the saved search with the supplied id.
SearchSavedIdDelete 1 param → 200401404
GET
/search/saved/{searchId}
Return the saved search with the supplied id.
SearchSavedIdGet 1 param → 200401404
PUT
/search/saved/{searchId}
Updates the saved search with the supplied id.
SearchSavedIdPut 1 param body → 200401404
POST
/search/saved/{searchId}/bulk/{actionId}
Performs a bulk action on the saved search result.
SearchSavedIdBulkActionPost 2 params body → 200401404
GET
/search/saved/{searchId}/execute
Executes saved searches, returning its results.
SearchSavedIdExecuteGet 7 params → 200401404
GET
/id/{docId}/@search
Get the children of a document by its id
DocumentIdSearchAdapterGet 13 params → 200401404
GET
/path/{docPath}/@search
Get the children of a document by its path
DocumentPathSearchAdapterGet 13 params → 200401404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are savedsearches (19 properties), documents (19 properties), savedsearch (13 properties), Document (13 properties). Each schema is shown below with its type and property counts.

Document
object
13 properties 1 required
documents
object
19 properties 2 required
savedsearch
object
13 properties 2 required
Property
object
2 properties 2 required
savedsearches
object
19 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nuxeo-search-api-openapi.yml Raw ↑

Other APIs Nuxeo publishes across the network.

Nuxeo ACL API
Nuxeo Adapter API
Nuxeo Annotation API
Nuxeo Audit API
Nuxeo Automation API
Nuxeo Blob API
Nuxeo Business Object API
Nuxeo Children API
Nuxeo Configuration API
Nuxeo Conversion API
Nuxeo Directory API
Nuxeo Document API