openapi: 3.0.2 info: version: LTS 2021 title: Nuxeo Platform ACL Adapter 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: Adapter description: Adaptation Endpoints paths: /id/{docId}/@acl: get: operationId: DocumentIdACLAdapterGet parameters: - description: Id of the document in: path name: docId required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Acp' '401': description: Not Authorized to get document '404': description: Document not found summary: View the ACL of a document given its id tags: - Adapter /path/{docPath}/@acl: get: operationId: DocumentPathACLAdapterGet parameters: - description: 'Path of the document, ex: ''default-domain''' in: path name: docPath required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Acp' '401': description: Not Authorized to get document '404': description: Document not found summary: View the ACL of a document given its path tags: - Adapter /id/{docId}/@annotation: get: operationId: DocumentIdAnnotationAdapterGet parameters: - description: Id of the document in: path name: docId required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/annotationList' '401': description: Not Authorized to get document '404': description: Document not found summary: Get all annotations on a given document blob tags: - Adapter put: operationId: DocumentIdAnnotationAdapterPut parameters: - description: Id of the document in: path name: docId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/annotation' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/annotation' '401': description: Not Authorized to get document '404': description: Document not found summary: Update an annotation on a given document tags: - Adapter /id/{docId}/@annotation/{annotationId}: delete: operationId: DocumentIdAnnotationIdAdapterDelete parameters: - description: Id of the document in: path name: docId required: true schema: type: string - description: Id of the annotation in: path name: annotationId required: true schema: type: string responses: '200': description: Successful response '401': description: Not Authorized to get document '404': description: Document not found summary: Delete an annotation on a document given its id tags: - Adapter get: operationId: DocumentIdAnnotationIdAdapterGet parameters: - description: Id of the document in: path name: docId required: true schema: type: string - description: Id of the annotation in: path name: annotationId required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/annotation' '401': description: Not Authorized to get document '404': description: Document not found summary: Retrieve an annotation on a document given its id tags: - Adapter /id/{docId}/@audit: get: operationId: DocumentIdAuditAdapterGet parameters: - description: Id of the document in: path name: docId required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/LogEntries' '401': description: Not Authorized to get document '404': description: Document not found summary: View the audit trail of a document given its id tags: - Adapter /path/{docPath}/@audit: get: operationId: DocumentPathAuditAdapterGet parameters: - description: 'Path of the document, ex: ''default-domain''' in: path name: docPath required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/LogEntries' '401': description: Not Authorized to get document '404': description: Document not found summary: View the audit trail of a document given its path tags: - Adapter /id/{docId}/@blob/{fieldPath}: get: operationId: DocumentIdBlobAdapterGet parameters: - description: Id of the document in: path name: docId required: true schema: type: string - description: 'The field path you want do download (ex: file:content)' in: path name: fieldPath required: true schema: type: string responses: '200': description: Successful response '401': description: Not Authorized to get document '404': description: Document not found summary: Get the main blob of a document by its id tags: - Adapter /path/{docPath}/@blob/{fieldPath}: get: operationId: DocumentPathBlobAdapterGet parameters: - description: 'Path of the document, ex: ''default-domain''' in: path name: docPath required: true schema: type: string - description: 'The field path you want do download (ex: file:content)' in: path name: fieldPath required: true schema: type: string responses: '200': description: Successful response '401': description: Not Authorized to get document '404': description: Document not found summary: Get the main blob of a document by its path tags: - Adapter /id/{docId}/@children: get: operationId: DocumentIdChildrenAdapterGet parameters: - description: Id of the document in: path name: docId required: true schema: type: string - description: Index of the current page in: query name: currentPageIndex required: false schema: type: integer - description: Offset of the page to retrieve. If set, the 'currentPageIndex' parameter is ignored. in: query name: offset required: false schema: type: integer - description: Size of the page to retrieve. Ignored if offset set in: query name: pageSize required: false schema: type: integer - description: Maximum results to retrieve in: query name: maxResults required: false schema: type: integer - description: Property to sort by, for example 'dc:title' in: query name: sortBy required: false schema: type: string - description: Sort order, accepts 'asc' or 'desc', default is 'desc' in: query name: sortOrder required: false schema: type: string - description: Schemas to be included in response in: header name: X-NXDocumentProperties required: false schema: type: string - description: Categories to be included in context parameters map in: header name: X-NXContext-Category required: false schema: type: string - description: 'Checkin Document Version. Return the last document version. (not live document) | Values: major or minor or none' in: header name: X-Versioning-Option required: false schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/documents' '401': description: Not Authorized to get document '404': description: Document not found description: Only documents which you have permission to see will be returned summary: Get the children of a document by its id tags: - Adapter /path/{docPath}/@children: get: operationId: DocumentPathChildrenAdapterGet parameters: - description: 'Path of the document, ex: ''default-domain''' in: path name: docPath required: true schema: type: string - description: Index of the current page in: query name: currentPageIndex required: false schema: type: string - description: Offset of the page to retrieve. If set, the 'currentPageIndex' parameter is ignored. in: query name: offset required: false schema: type: integer - description: Size of the page to retrieve. Ignored if offset set in: query name: pageSize required: false schema: type: integer - description: Maximum results to retrieve in: query name: maxResults required: false schema: type: integer - description: Property to sort by, for example 'dc:title' in: query name: sortBy required: false schema: type: string - description: Sort order, accepts 'asc' or 'desc', default is 'desc' in: query name: sortOrder required: false schema: type: string - description: Schemas to be included in response in: header name: X-NXDocumentProperties required: false schema: type: string - description: Categories to be included in context parameters map in: header name: X-NXContext-Category required: false schema: type: string - description: 'Checkin Document Version. Return the last document version. (not live document) | Values: major or minor or none' in: header name: X-Versioning-Option required: false schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/documents' '401': description: Not Authorized to get document '404': description: Document not found description: Only documents which you have permission to see will be returned summary: Get the children of a document by its path tags: - Adapter /id/{docId}/@blob/{blobXpath}/@convert: get: operationId: DocumentIdBlobConvertAdapterGet parameters: - description: Id of the document in: path name: docId required: true schema: type: string - description: XPath of the blob in: path name: blobXpath required: true schema: type: string - description: The name of the converter to execute in: query name: name required: false schema: type: string - description: The requested mime type for the converted Blob, such as 'application/pdf' in: query name: type required: false schema: type: string - description: The requested extension of the converted Blob, such as 'pdf' in: query name: format required: false schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/documents' '401': description: Not Authorized to get document '404': description: Document not found description: One of the 'name', 'type' or 'format' parameters must be passed. summary: Convert the Blob at the given xpath of the document tags: - Adapter /id/{docId}/@convert: get: operationId: DocumentIdConvertAdapterGet parameters: - description: Id of the document in: path name: docId required: true schema: type: string - description: The name of the converter to execute in: query name: name required: false schema: type: string - description: The requested mime type for the converted Blob, such as 'application/pdf' in: query name: type required: false schema: type: string - description: The requested extension of the converted Blob, such as 'pdf' in: query name: format required: false schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/documents' '401': description: Not Authorized to get document '404': description: Document not found description: One of the 'name', 'type' or 'format' parameters must be passed. summary: Convert the main Blob of the document tags: - Adapter /path/{docPath}/@blob/{blobXpath}/@convert: get: operationId: DocumentPathBlobConvertAdapterGet parameters: - description: 'Path of the document, ex: ''default-domain''' in: path name: docPath required: true schema: type: string - description: XPath of the blob in: path name: blobXpath required: true schema: type: string - description: The name of the converter to execute in: query name: name required: false schema: type: string - description: The requested mime type for the converted Blob, such as 'application/pdf' in: query name: type required: false schema: type: string - description: The requested extension of the converted Blob, such as 'pdf' in: query name: format required: false schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/documents' '401': description: Not Authorized to get document '404': description: Document not found description: One of the 'name', 'type' or 'format' parameters must be passed. summary: Convert the Blob at the given xpath of the document tags: - Adapter /path/{docPath}/@convert: get: operationId: DocumentPathConvertAdapterGet parameters: - description: 'Path of the document, ex: ''default-domain''' in: path name: docPath required: true schema: type: string - description: The name of the converter to execute in: query name: name required: false schema: type: string - description: The requested mime type for the converted Blob, such as 'application/pdf' in: query name: type required: false schema: type: string - description: The requested extension of the converted Blob, such as 'pdf' in: query name: format required: false schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/documents' '401': description: Not Authorized to get document '404': description: Document not found description: One of the 'name', 'type' or 'format' parameters must be passed. summary: Convert the main Blob of the document tags: - Adapter /@emptyWithDefault: get: operationId: EmptyWithDefaultGet parameters: - description: The type of the empty document to be initialized in: query name: type required: true schema: type: string - description: The name of the empty document to be initialized in: query name: name required: false schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/document' '401': description: Not Authorized to get document '404': description: Document not found description: 'To retrieve all initialized properties, the ''properties: *'' header must be used' summary: Initialize an empty document with default properties given a document type tags: - Adapter /id/{docId}/@emptyWithDefault: get: operationId: DocumentIdEmptyWithDefaultAdapterGet parameters: - description: Id of the document in: path name: docId required: true schema: type: string - description: The type of the empty document to be initialized in: query name: type required: true schema: type: string - description: The name of the empty document to be initialized in: query name: name required: false schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/document' '401': description: Not Authorized to get document '404': description: Document not found description: 'To retrieve all initialized properties, the ''properties: *'' header must be used' summary: Initialize an empty document with default properties given a document type and a parent tags: - Adapter /path/{docPath}/@emptyWithDefault: get: operationId: DocumentPathEmptyWithDefaultAdapterGet parameters: - description: 'Path of the document, ex: ''default-domain''' in: path name: docPath required: true schema: type: string - description: The type of the empty document to be initialized in: query name: type required: true schema: type: string - description: The name of the empty document to be initialized in: query name: name required: false schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/document' '401': description: Not Authorized to get document '404': description: Document not found description: 'To retrieve all initialized properties, the ''properties: *'' header must be used' summary: Initialize an empty document with default properties given a document type and a parent tags: - Adapter /id/{docId}/@pp/{pageProviderName}: get: operationId: DocumentIdPageProviderAdapterGet parameters: - description: Id of the document in: path name: docId required: true schema: type: string - description: 'Name of the page provider, ex: ''user_domains''' in: path name: pageProviderName required: true schema: type: string - description: Index of the current page in: query name: currentPageIndex required: false schema: type: string - description: Offset of the page to retrieve. If set, the 'currentPageIndex' parameter is ignored. in: query name: offset required: false schema: type: integer - description: Size of the page to retrieve. Ignored if offset set in: query name: pageSize required: false schema: type: integer - description: Maximum results to retrieve in: query name: maxResults required: false schema: type: integer - description: Property to sort by, for example 'dc:title' in: query name: sortBy required: false schema: type: string - description: Sort order, accepts 'asc' or 'desc', default is 'desc' in: query name: sortOrder required: false schema: type: string - description: Schemas to be included in response in: header name: X-NXDocumentProperties required: false schema: type: string - description: Categories to be included in context parameters map in: header name: X-NXContext-Category required: false schema: type: string - description: 'Checkin Document Version. Return the last document version. (not live document) | Values: major or minor or none' in: header name: X-Versioning-Option required: false schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/documents' '401': description: Not Authorized to get document '404': description: Document not found description: Only documents which you have permission to see will be returned summary: Execute a page provider on document by its id tags: - Adapter /path/{docPath}/@pp/{pageProviderName}: get: operationId: DocumentPathPageProviderAdapterGet parameters: - description: 'Path of the document, ex: ''default-domain''' in: path name: docPath required: true schema: type: string - description: 'Name of the page provider, ex: ''user_domains''' in: path name: pageProviderName required: true schema: type: string - description: Index of the current page in: query name: currentPageIndex required: false schema: type: integer - description: Offset of the page to retrieve. If set, the 'currentPageIndex' parameter is ignored. in: query name: offset required: false schema: type: integer - description: Size of the page to retrieve. Ignored if offset set in: query name: pageSize required: false schema: type: integer - description: Maximum results to retrieve in: query name: maxResults required: false schema: type: integer - description: Property to sort by, for example 'dc:title' in: query name: sortBy required: false schema: type: string - description: Sort order, accepts 'asc' or 'desc', default is 'desc' in: query name: sortOrder required: false schema: type: string - description: Schemas to be included in response in: header name: X-NXDocumentProperties required: false schema: type: string - description: Categories to be included in context parameters map in: header name: X-NXContext-Category required: false schema: type: string - description: 'Checkin Document Version. Return the last document version. (not live document) | Values: major or minor or none' in: header name: X-Versioning-Option required: false schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/documents' '401': description: Not Authorized to get document '404': description: Document not found description: Only documents which you have permission to see will be returned summary: Execute a page provider on document by its path tags: - Adapter /id/{docId}/@rendition/{renditionName}: get: operationId: DocumentIdRenditionAdapterGet parameters: - description: Id of the document in: path name: docId required: true schema: type: string - description: 'Name of the rendition, ex: ''pdf''' in: path name: renditionName required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/documents' '401': description: Not Authorized to get document '404': description: Document not found summary: Returns the specified rendition on document by its id tags: - Adapter /path/{docPath}/@rendition/{renditionName}: get: operationId: DocumentPathRenditionAdapterGet parameters: - description: 'Path of the document, ex: ''default-domain''' in: path name: docPath required: true schema: type: string - description: 'Name of the rendition, ex: ''pdf''' in: path name: renditionName required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/documents' '401': description: Not Authorized to get document '404': description: Document not found summary: Returns the specified rendition on document by its path tags: - Adapter /id/{docId}/@search: get: operationId: DocumentIdSearchAdapterGet parameters: - description: Id of the document in: path name: docId required: true schema: type: string - description: NXQL query in: query name: query required: false schema: type: string - description: A full text query in: query name: fullText required: false schema: type: string - description: Field on which to order in: query name: orderBy required: false schema: type: string - description: Index of the current page in: query name: currentPageIndex required: false schema: type: integer - description: Offset of the page to retrieve. If set, the 'currentPageIndex' parameter is ignored. in: query name: offset required: false schema: type: integer - description: Size of the page to retrieve. Ignored if offset set in: query name: pageSize required: false schema: type: integer - description: Maximum results to retrieve in: query name: maxResults required: false schema: type: integer - description: Property to sort by, for example 'dc:title' in: query name: sortBy required: false schema: type: string - description: Sort order, accepts 'asc' or 'desc', default is 'desc' in: query name: sortOrder required: false schema: type: string - description: Schemas to be included in response in: header name: X-NXDocumentProperties required: false schema: type: string - description: Categories to be included in context parameters map in: header name: X-NXContext-Category required: false schema: type: string - description: 'Checkin Document Version. Return the last document version. (not live document) | Values: major or minor or none' in: header name: X-Versioning-Option required: false schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/documents' '401': description: Not Authorized to get document '404': description: Document not found description: Only documents which you have permission to see will be returned summary: Get the children of a document by its id tags: - Adapter /path/{docPath}/@search: get: operationId: DocumentPathSearchAdapterGet parameters: - description: 'Path of the document, ex: ''default-domain''' in: path name: docPath required: true schema: type: string - description: Index of the current page in: query name: currentPageIndex required: false schema: type: integer - description: Offset of the page to retrieve. If set, the 'currentPageIndex' parameter is ignored. in: query name: offset required: false schema: type: integer - description: Size of the page to retrieve. Ignored if offset set in: query name: pageSize required: false schema: type: integer - description: Maximum results to retrieve in: query name: maxResults required: false schema: type: integer - description: Property to sort by, for example 'dc:title' in: query name: sortBy required: false schema: type: string - description: Sort order, accepts 'asc' or 'desc', default is 'desc' in: query name: sortOrder required: false schema: type: string - description: NXQL query in: query name: query required: false schema: type: string - description: A full text query in: query name: fullText required: false schema: type: string - description: Field on which to order in: query name: orderBy required: false schema: type: string - description: Schemas to be included in response in: header name: X-NXDocumentProperties required: false schema: type: string - description: Categories to be included in context parameters map in: header name: X-NXContext-Category required: false schema: type: string - description: 'Checkin Document Version. Return the last document version. (not live document) | Values: major or minor or none' in: header name: X-Versioning-Option required: false schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/documents' '401': description: Not Authorized to get document '404': description: Document not found description: Only documents which you have permission to see will be returned summary: Get the children of a document by its path tags: - Adapter components: schemas: LogEntry: properties: category: type: string uniqueItems: false comment: type: string uniqueItems: false docLifeCycle: type: string uniqueItems: false docPath: type: string uniqueItems: false docType: type: string uniqueItems: false docUUID: type: string uniqueItems: false entity-type: type: string uniqueItems: false eventDate: format: date-time type: string uniqueItems: false eventId: type: string uniqueItems: false logDate: format: date-time type: string uniqueItems: false principalName: type: string uniqueItems: false repositoryId: type: string uniqueItems: false required: - category - comment - docLifeCycle - docPath - docType - docUUID - entity-type - eventDate - eventId - logDate - principalName - repositoryId uniqueItems: false Document: properties: changeToken: type: string uniqueItems: false contextParameters: type: object uniqueItems: false entity-type: type: string uniqueItems: false facets: items: type: string type: array lastModified: format: date type: string uniqueItems: false path: type: string uniqueItems: false properties: items: $ref: '#/components/schemas/Property' type: object uniqueItems: true repository: type: string uniqueItems: false state: type: string uniqueItems: false title: type: string uniqueItems: false type: type: string uniqueItems: false uid: type: string uniqueItems: false versionLabel: type: string uniqueItems: false required: - entity-type uniqueItems: false annotationList: properties: entity-type: type: string uniqueItems: false entries: items: $ref: '#/components/schemas/annotation' type: array uniqueItems: false required: - entity-type - entries uniqueItems: false documents: 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/Document' 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 Acl: properties: ace: items: $ref: '#/components/schemas/Ace' type: array uniqueItems: false name: type: string uniqueItems: false required: - ace - name uniqueItems: false Ace: properties: granted: type: boolean uniqueItems: false permission: type: string uniqueItems: false username: type: string uniqueItems: false required: - granted - permission - username uniqueItems: false LogEntries: 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/LogEntry' 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 Acp: properties: acls: items: $ref: '#/components/schemas/Acl' type: array uniqueItems: false entity-type: type: string uniqueItems: false required: - entity-type uniqueItems: false annotation: properties: security: type: string uniqueItems: false color: type: string uniqueItems: false creationDate: format: date-time type: string uniqueItems: false date: format: date-time type: string uniqueItems: false documentId: type: string uniqueItems: false entity-type: type: string uniqueItems: false flags: type: string uniqueItems: false id: type: string uniqueItems: false lastModifier: type: string uniqueItems: false name: type: string uniqueItems: false opacity: format: double type: number uniqueItems: false page: type: integer uniqueItems: false position: type: string uniqueItems: false subject: type: string uniqueItems: false xpath: type: string uniqueItems: false required: - creationDate - date - documentId - entity-type - flags - id - lastModifier - name - opacity - page - position - security - subject - xpath uniqueItems: false Property: properties: context: type: object uniqueItems: false params: type: object uniqueItems: false required: - context - params uniqueItems: false document: properties: changeToken: type: string uniqueItems: false contextParameters: type: object uniqueItems: false entity-type: type: string uniqueItems: false facets: items: type: string type: array lastModified: format: date type: string uniqueItems: false path: type: string uniqueItems: false properties: items: $ref: '#/components/schemas/Property' type: object uniqueItems: true repository: type: string uniqueItems: false state: type: string uniqueItems: false title: type: string uniqueItems: false type: type: string uniqueItems: false uid: type: string uniqueItems: false versionLabel: type: string 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/