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 Business Object API

Business Object Operations

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

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

This API exposes 8 operations across 6 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.

8 operations 6 paths 2 schemas 4 GET2 POST2 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 Business Object 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 8

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

Business Object 8

Business Object Operations

GET
/id/{docId}/@bo/{adapterName}deprecated
Get the business object adapter on a document given its id
DocumentIdBusinessObjectAdapterGet 2 params → 200401404
PUT
/id/{docId}/@bo/{adapterName}deprecated
Updates the business object adapter on a document given its id
DocumentIdBusinessObjectAdapterPut 2 params body → 200401404
POST
/id/{docId}/@bo/{adapterName}/{docName}deprecated
Creates a document based on its business object
DocumentIdBusinessObjectAdapterPost 3 params → 200401404
GET
/id/{docId}/@children/@bo/{adapterName}deprecated
Get the list of business object of the children of a document by its id
DocumentIdChildrenBusinessObjectAdapterGet 2 params → 200401404
GET
/path/{docPath}/@bo/{adapterName}deprecated
Get the business object adapter on a document given its path
DocumentPathBusinessObjectAdapterGet 2 params → 200401404
PUT
/path/{docPath}/@bo/{adapterName}deprecated
Updates the business object adapter on a document given its path
DocumentPathBusinessObjectAdapterPut 2 params body → 200401404
POST
/path/{docPath}/@bo/{adapterName}/{docName}deprecated
Creates a document based on its business object
DocumentPathBusinessObjectAdapterPost 3 params → 200401404
GET
/path/{docPath}/@children/@bo/{adapterName}deprecated
Get the list of business object of the children of a document by its path
DocumentPathChildrenBusinessObjectAdapterGet 2 params → 200401404

Schemas 2

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

BusinessObjectList
object
19 properties 2 required
BusinessObject
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nuxeo-business-object-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 Children API
Nuxeo Configuration API
Nuxeo Conversion API
Nuxeo Directory API
Nuxeo Document API
Nuxeo Empty Document API