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

Adaptation Endpoints

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

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

This API exposes 25 operations across 23 paths, and defines 11 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.

25 operations 23 paths 11 schemas 1 DELETE23 GET1 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 Adapter 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 25

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

Adapter 25

Adaptation Endpoints

GET
/id/{docId}/@acl
View the ACL of a document given its id
DocumentIdACLAdapterGet 1 param → 200401404
GET
/path/{docPath}/@acl
View the ACL of a document given its path
DocumentPathACLAdapterGet 1 param → 200401404
GET
/id/{docId}/@annotation
Get all annotations on a given document blob
DocumentIdAnnotationAdapterGet 1 param → 200401404
PUT
/id/{docId}/@annotation
Update an annotation on a given document
DocumentIdAnnotationAdapterPut 1 param body → 200401404
DELETE
/id/{docId}/@annotation/{annotationId}
Delete an annotation on a document given its id
DocumentIdAnnotationIdAdapterDelete 2 params → 200401404
GET
/id/{docId}/@annotation/{annotationId}
Retrieve an annotation on a document given its id
DocumentIdAnnotationIdAdapterGet 2 params → 200401404
GET
/id/{docId}/@audit
View the audit trail of a document given its id
DocumentIdAuditAdapterGet 1 param → 200401404
GET
/path/{docPath}/@audit
View the audit trail of a document given its path
DocumentPathAuditAdapterGet 1 param → 200401404
GET
/id/{docId}/@blob/{fieldPath}
Get the main blob of a document by its id
DocumentIdBlobAdapterGet 2 params → 200401404
GET
/path/{docPath}/@blob/{fieldPath}
Get the main blob of a document by its path
DocumentPathBlobAdapterGet 2 params → 200401404
GET
/id/{docId}/@children
Get the children of a document by its id
DocumentIdChildrenAdapterGet 10 params → 200401404
GET
/path/{docPath}/@children
Get the children of a document by its path
DocumentPathChildrenAdapterGet 10 params → 200401404
GET
/id/{docId}/@blob/{blobXpath}/@convert
Convert the Blob at the given xpath of the document
DocumentIdBlobConvertAdapterGet 5 params → 200401404
GET
/id/{docId}/@convert
Convert the main Blob of the document
DocumentIdConvertAdapterGet 4 params → 200401404
GET
/path/{docPath}/@blob/{blobXpath}/@convert
Convert the Blob at the given xpath of the document
DocumentPathBlobConvertAdapterGet 5 params → 200401404
GET
/path/{docPath}/@convert
Convert the main Blob of the document
DocumentPathConvertAdapterGet 4 params → 200401404
GET
/@emptyWithDefault
Initialize an empty document with default properties given a document type
EmptyWithDefaultGet 2 params → 200401404
GET
/id/{docId}/@emptyWithDefault
Initialize an empty document with default properties given a document type and a parent
DocumentIdEmptyWithDefaultAdapterGet 3 params → 200401404
GET
/path/{docPath}/@emptyWithDefault
Initialize an empty document with default properties given a document type and a parent
DocumentPathEmptyWithDefaultAdapterGet 3 params → 200401404
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
/id/{docId}/@rendition/{renditionName}
Returns the specified rendition on document by its id
DocumentIdRenditionAdapterGet 2 params → 200401404
GET
/path/{docPath}/@rendition/{renditionName}
Returns the specified rendition on document by its path
DocumentPathRenditionAdapterGet 2 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 11

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

LogEntry
object
12 properties 12 required
Document
object
13 properties 1 required
annotationList
object
2 properties 2 required
documents
object
19 properties 2 required
Acl
object
2 properties 2 required
Ace
object
3 properties 3 required
LogEntries
object
19 properties 2 required
Acp
object
2 properties 1 required
annotation
object
15 properties 14 required
Property
object
2 properties 2 required
document
object
13 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nuxeo-adapter-api-openapi.yml Raw ↑

Other APIs Nuxeo publishes across the network.

Nuxeo ACL 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
Nuxeo Empty Document API