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 Document API

Document Operations

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

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

This API exposes 16 operations across 4 paths, and defines 2 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.

16 operations 4 paths 2 schemas 4 DELETE4 GET4 POST4 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 Document 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 16

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

Document 16

Document Operations

DELETE
/id/{docId}
Deletes a document by its id
DocumentIdDelete 4 params → 200401404
GET
/id/{docId}
Find a document by its id
DocumentIdGet 4 params → 200401404
POST
/id/{docId}
Creates a document by its parent id
DocumentIdPost 1 param body → 200401404
PUT
/id/{docId}
Updates a document by its id
DocumentIdPut 4 params body → 200401404
DELETE
/repo/{repoId}/id/{docId}
Deletes a document by its id
RepoIdDocumentIdDelete 2 params → 200401404
GET
/repo/{repoId}/id/{docId}
Find a document by its id
RepoIdDocumentIdGet 5 params → 200401404
POST
/repo/{repoId}/id/{docId}
Creates a document by its parent id
RepoIdDocumentIdPost 5 params body → 200401404
PUT
/repo/{repoId}/id/{docId}
Updates a document by its id
RepoIdDocumentIdPut 5 params body → 200401404
DELETE
/path/{docPath}
Deletes a document by its path
DocumentPathDelete 1 param → 200401404
GET
/path/{docPath}
Find a document by its path
DocumentPathGet 4 params → 200401404
POST
/path/{docPath}
Creates a document by its parent path
DocumentPathPost 4 params body → 200401404
PUT
/path/{docPath}
Updates a document by its path
DocumentPathPut 4 params body → 200401404
DELETE
/repo/{repoId}/path/{docPath}
Deletes a document by its path
RepoIdDocumentPathDelete 2 params → 200401404
GET
/repo/{repoId}/path/{docPath}
Find a document by its path
RepoIdDocumentPathGet 5 params → 200401404
POST
/repo/{repoId}/path/{docPath}
Creates a document by its parent path
RepoIdDocumentPathPost 5 params body → 200401404
PUT
/repo/{repoId}/path/{docPath}
Updates a document by its path
RepoIdDocumentPathPut 5 params body → 200401404

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are document (13 properties), Property (2 properties). Each schema is shown below with its type and property counts.

Property
object
2 properties 2 required
document
object
13 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nuxeo-document-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 Empty Document API