Nuxeo

Nuxeo Business Object API

Business Object Operations

GitHub OpenAPI

Operations 8

GET /id/{docId}/@bo/{adapterName} Get the business object adapter on a document given its id #
PUT /id/{docId}/@bo/{adapterName} Updates the business object adapter on a document given its id #
POST /id/{docId}/@bo/{adapterName}/{docName} Creates a document based on its business object #
GET /id/{docId}/@children/@bo/{adapterName} Get the list of business object of the children of a document by its id #
GET /path/{docPath}/@bo/{adapterName} Get the business object adapter on a document given its path #
PUT /path/{docPath}/@bo/{adapterName} Updates the business object adapter on a document given its path #
POST /path/{docPath}/@bo/{adapterName}/{docName} Creates a document based on its business object #
GET /path/{docPath}/@children/@bo/{adapterName} Get the list of business object of the children of a document by its path #

Documentation

📖
Documentation
https://doc.nuxeo.com/nxdoc/rest-api/
📖
Authentication
https://doc.nuxeo.com/rest-api/1/authentication/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/nuxeo/refs/heads/main/openapi/nuxeo-business-object-api-openapi.yml

Other Resources

🔗
OpenAPISource
https://github.com/nuxeo-sandbox/nuxeo-openapi
🔗
Swagger
https://github.com/nuxeo/nuxeo-rest-api-swagger-doc
🔗
Endpoints
https://doc.nuxeo.com/nxdoc/rest-api-endpoints/
🔗
HowTos
https://doc.nuxeo.com/nxdoc/rest-api-howtos/
🔗
Automation
https://doc.nuxeo.com/nxdoc/content-automation-concepts/

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/nuxeo-business-object-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

nuxeo-business-object-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: LTS 2021
  title: Nuxeo Platform ACL Business Object API
  termsOfService: https://www.nuxeo.com/about/why-nuxeo/
  contact:
    email: support@nuxeo.com
    url: https://www.nuxeo.com/contact/
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  x-logo:
    url: https://d1q6f0aelx0por.cloudfront.net/product-logos/library-nuxeo-logo.png
  description: '# Nuxeo Platform https://www.nuxeo.com/

    OpenAPI 3.0 Specification for the Nuxeo Platform.'
servers:
- url: https://{host}:{port}/nuxeo/api/v1
  variables:
    host:
      default: demo.nuxeo.com
      description: Nuxeo Platform Host
    port:
      default: '443'
      description: Nuxeo Platform Port
- url: https://nightly.nuxeo.com/nuxeo/api/v1
  description: Nuxeo Platform Nightly Test Server
tags:
- name: Business Object
  description: Business Object Operations
paths:
  /id/{docId}/@bo/{adapterName}:
    get:
      deprecated: true
      operationId: DocumentIdBusinessObjectAdapterGet
      parameters:
      - description: Id of the document
        in: path
        name: docId
        required: true
        schema:
          type: string
      - description: Name of the adapter
        in: path
        name: adapterName
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessObject'
        '401':
          description: Not Authorized to get document
        '404':
          description: Document not found
      summary: Get the business object adapter on a document given its id
      tags:
      - Business Object
    put:
      deprecated: true
      operationId: DocumentIdBusinessObjectAdapterPut
      parameters:
      - description: Id of the document
        in: path
        name: docId
        required: true
        schema:
          type: string
      - description: Name of the adapter
        in: path
        name: adapterName
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessObject'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessObject'
        '401':
          description: Not Authorized to get document
        '404':
          description: Document not found
      summary: Updates the business object adapter on a document given its id
      tags:
      - Business Object
  /id/{docId}/@bo/{adapterName}/{docName}:
    post:
      deprecated: true
      operationId: DocumentIdBusinessObjectAdapterPost
      parameters:
      - description: Id of the document
        in: path
        name: docId
        required: true
        schema:
          type: string
      - description: Name of the adapter
        in: path
        name: adapterName
        required: true
        schema:
          type: string
      - description: Name of the document
        in: path
        name: docName
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessObject'
        '401':
          description: Not Authorized to get document
        '404':
          description: Document not found
      summary: Creates a document based on its business object
      tags:
      - Business Object
  /id/{docId}/@children/@bo/{adapterName}:
    get:
      deprecated: true
      operationId: DocumentIdChildrenBusinessObjectAdapterGet
      parameters:
      - description: Id of the document
        in: path
        name: docId
        required: true
        schema:
          type: string
      - description: Name of the adapter
        in: path
        name: adapterName
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessObjectList'
        '401':
          description: Not Authorized to get document
        '404':
          description: Document not found
      description: <ul><li>If a document can't be adapted, the resulting item will be null</li><li> This type of call works for every API endpoint that responds DocumentList (@search, @pp ...)</li></ul>
      summary: Get the list of business object of the children of a document by its id
      tags:
      - Business Object
  /path/{docPath}/@bo/{adapterName}:
    get:
      deprecated: true
      operationId: DocumentPathBusinessObjectAdapterGet
      parameters:
      - description: 'Path of the document, ex: ''default-domain'''
        in: path
        name: docPath
        required: true
        schema:
          type: string
      - description: Name of the adapter
        in: path
        name: adapterName
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessObject'
        '401':
          description: Not Authorized to get document
        '404':
          description: Document not found
      summary: Get the business object adapter on a document given its path
      tags:
      - Business Object
    put:
      deprecated: true
      operationId: DocumentPathBusinessObjectAdapterPut
      parameters:
      - description: 'Path of the document, ex: ''default-domain'''
        in: path
        name: docPath
        required: true
        schema:
          type: string
      - description: Name of the adapter
        in: path
        name: adapterName
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessObject'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessObject'
        '401':
          description: Not Authorized to get document
        '404':
          description: Document not found
      summary: Updates the business object adapter on a document given its path
      tags:
      - Business Object
  /path/{docPath}/@bo/{adapterName}/{docName}:
    post:
      deprecated: true
      operationId: DocumentPathBusinessObjectAdapterPost
      parameters:
      - description: 'Path of the document, ex: ''default-domain'''
        in: path
        name: docPath
        required: true
        schema:
          type: string
      - description: Name of the adapter
        in: path
        name: adapterName
        required: true
        schema:
          type: string
      - description: Name of the document
        in: path
        name: docName
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessObject'
        '401':
          description: Not Authorized to get document
        '404':
          description: Document not found
      summary: Creates a document based on its business object
      tags:
      - Business Object
  /path/{docPath}/@children/@bo/{adapterName}:
    get:
      deprecated: true
      operationId: DocumentPathChildrenBusinessObjectAdapterGet
      parameters:
      - description: 'Path of the document, ex: ''default-domain'''
        in: path
        name: docPath
        required: true
        schema:
          type: string
      - description: Name of the adapter
        in: path
        name: adapterName
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessObjectList'
        '401':
          description: Not Authorized to get document
        '404':
          description: Document not found
      description: <ul><li>If a document can't be adapted, the resulting item will be null</li><li> This type of call works for every API endpoint that responds DocumentList (@search, @pp ...)</li></ul>
      summary: Get the list of business object of the children of a document by its path
      tags:
      - Business Object
components:
  schemas:
    BusinessObjectList:
      properties:
        currentPageIndex:
          type: integer
          uniqueItems: false
        currentPageOffset:
          type: integer
          uniqueItems: false
        currentPageSize:
          type: integer
          uniqueItems: false
        entity-type:
          type: string
          uniqueItems: false
        entries:
          items:
            $ref: '#/components/schemas/BusinessObject'
          type: array
          uniqueItems: false
        erroMessage:
          type: string
          uniqueItems: false
        hasError:
          type: boolean
          uniqueItems: false
        isLastPageAvailable:
          type: boolean
          uniqueItems: false
        isNext:
          type: boolean
          uniqueItems: false
        isPaginable:
          type: boolean
          uniqueItems: false
        isPreviousPageAvailable:
          type: boolean
          uniqueItems: false
        isSortable:
          type: boolean
          uniqueItems: false
        maxPageSize:
          type: integer
          uniqueItems: false
        numberOfPages:
          type: integer
          uniqueItems: false
        pageCount:
          type: integer
          uniqueItems: false
        pageIndex:
          type: integer
          uniqueItems: false
        pageSize:
          type: integer
          uniqueItems: false
        resultCount:
          type: integer
          uniqueItems: false
        totalSize:
          type: integer
          uniqueItems: false
      required:
      - entity-type
      - entries
      uniqueItems: false
    BusinessObject:
      properties:
        entity-type:
          type: string
          uniqueItems: false
        value:
          type: object
          uniqueItems: false
      required:
      - entity-type
      uniqueItems: false
  securitySchemes:
    basic_auth:
      type: http
      scheme: basic
    token:
      type: apiKey
      in: header
      name: X-Authentication-Token
externalDocs:
  description: Nuxeo Documentation
  url: https://doc.nuxeo.com/