{
  "opencollection": "1.0.0",
  "info": {
    "name": "Nuxeo Platform ACL Adapter API",
    "version": "LTS 2021"
  },
  "items": [
    {
      "info": {
        "name": "Adapter",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "View the ACL of a document given its id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/nuxeo/api/v1/id/:docId/@acl",
            "params": [
              {
                "name": "docId",
                "value": "",
                "type": "path",
                "description": "Id of the document"
              }
            ]
          },
          "docs": "View the ACL of a document given its id"
        },
        {
          "info": {
            "name": "View the ACL of a document given its path",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/nuxeo/api/v1/path/:docPath/@acl",
            "params": [
              {
                "name": "docPath",
                "value": "",
                "type": "path",
                "description": "Path of the document, ex: 'default-domain'"
              }
            ]
          },
          "docs": "View the ACL of a document given its path"
        },
        {
          "info": {
            "name": "Get all annotations on a given document blob",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/nuxeo/api/v1/id/:docId/@annotation",
            "params": [
              {
                "name": "docId",
                "value": "",
                "type": "path",
                "description": "Id of the document"
              }
            ]
          },
          "docs": "Get all annotations on a given document blob"
        },
        {
          "info": {
            "name": "Update an annotation on a given document",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{host}:{port}/nuxeo/api/v1/id/:docId/@annotation",
            "params": [
              {
                "name": "docId",
                "value": "",
                "type": "path",
                "description": "Id of the document"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an annotation on a given document"
        },
        {
          "info": {
            "name": "Retrieve an annotation on a document given its id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/nuxeo/api/v1/id/:docId/@annotation/:annotationId",
            "params": [
              {
                "name": "docId",
                "value": "",
                "type": "path",
                "description": "Id of the document"
              },
              {
                "name": "annotationId",
                "value": "",
                "type": "path",
                "description": "Id of the annotation"
              }
            ]
          },
          "docs": "Retrieve an annotation on a document given its id"
        },
        {
          "info": {
            "name": "Delete an annotation on a document given its id",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{host}:{port}/nuxeo/api/v1/id/:docId/@annotation/:annotationId",
            "params": [
              {
                "name": "docId",
                "value": "",
                "type": "path",
                "description": "Id of the document"
              },
              {
                "name": "annotationId",
                "value": "",
                "type": "path",
                "description": "Id of the annotation"
              }
            ]
          },
          "docs": "Delete an annotation on a document given its id"
        },
        {
          "info": {
            "name": "View the audit trail of a document given its id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/nuxeo/api/v1/id/:docId/@audit",
            "params": [
              {
                "name": "docId",
                "value": "",
                "type": "path",
                "description": "Id of the document"
              }
            ]
          },
          "docs": "View the audit trail of a document given its id"
        },
        {
          "info": {
            "name": "View the audit trail of a document given its path",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/nuxeo/api/v1/path/:docPath/@audit",
            "params": [
              {
                "name": "docPath",
                "value": "",
                "type": "path",
                "description": "Path of the document, ex: 'default-domain'"
              }
            ]
          },
          "docs": "View the audit trail of a document given its path"
        },
        {
          "info": {
            "name": "Get the main blob of a document by its id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/nuxeo/api/v1/id/:docId/@blob/:fieldPath",
            "params": [
              {
                "name": "docId",
                "value": "",
                "type": "path",
                "description": "Id of the document"
              },
              {
                "name": "fieldPath",
                "value": "",
                "type": "path",
                "description": "The field path you want do download (ex: file:content)"
              }
            ]
          },
          "docs": "Get the main blob of a document by its id"
        },
        {
          "info": {
            "name": "Get the main blob of a document by its path",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/nuxeo/api/v1/path/:docPath/@blob/:fieldPath",
            "params": [
              {
                "name": "docPath",
                "value": "",
                "type": "path",
                "description": "Path of the document, ex: 'default-domain'"
              },
              {
                "name": "fieldPath",
                "value": "",
                "type": "path",
                "description": "The field path you want do download (ex: file:content)"
              }
            ]
          },
          "docs": "Get the main blob of a document by its path"
        },
        {
          "info": {
            "name": "Get the children of a document by its id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/nuxeo/api/v1/id/:docId/@children",
            "headers": [
              {
                "name": "X-NXDocumentProperties",
                "value": ""
              },
              {
                "name": "X-NXContext-Category",
                "value": ""
              },
              {
                "name": "X-Versioning-Option",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "docId",
                "value": "",
                "type": "path",
                "description": "Id of the document"
              },
              {
                "name": "currentPageIndex",
                "value": "",
                "type": "query",
                "description": "Index of the current page"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Offset of the page to retrieve. If set, the 'currentPageIndex' parameter is ignored."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Size of the page to retrieve. Ignored if offset set"
              },
              {
                "name": "maxResults",
                "value": "",
                "type": "query",
                "description": "Maximum results to retrieve"
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "Property to sort by, for example 'dc:title'"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "Sort order, accepts 'asc' or 'desc', default is 'desc'"
              }
            ]
          },
          "docs": "Only documents which you have permission to see will be returned"
        },
        {
          "info": {
            "name": "Get the children of a document by its path",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/nuxeo/api/v1/path/:docPath/@children",
            "headers": [
              {
                "name": "X-NXDocumentProperties",
                "value": ""
              },
              {
                "name": "X-NXContext-Category",
                "value": ""
              },
              {
                "name": "X-Versioning-Option",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "docPath",
                "value": "",
                "type": "path",
                "description": "Path of the document, ex: 'default-domain'"
              },
              {
                "name": "currentPageIndex",
                "value": "",
                "type": "query",
                "description": "Index of the current page"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Offset of the page to retrieve. If set, the 'currentPageIndex' parameter is ignored."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Size of the page to retrieve. Ignored if offset set"
              },
              {
                "name": "maxResults",
                "value": "",
                "type": "query",
                "description": "Maximum results to retrieve"
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "Property to sort by, for example 'dc:title'"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "Sort order, accepts 'asc' or 'desc', default is 'desc'"
              }
            ]
          },
          "docs": "Only documents which you have permission to see will be returned"
        },
        {
          "info": {
            "name": "Convert the Blob at the given xpath of the document",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/nuxeo/api/v1/id/:docId/@blob/:blobXpath/@convert",
            "params": [
              {
                "name": "docId",
                "value": "",
                "type": "path",
                "description": "Id of the document"
              },
              {
                "name": "blobXpath",
                "value": "",
                "type": "path",
                "description": "XPath of the blob"
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "The name of the converter to execute"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "The requested mime type for the converted Blob, such as 'application/pdf'"
              },
              {
                "name": "format",
                "value": "",
                "type": "query",
                "description": "The requested extension of the converted Blob, such as 'pdf'"
              }
            ]
          },
          "docs": "One of the 'name', 'type' or 'format' parameters must be passed."
        },
        {
          "info": {
            "name": "Convert the main Blob of the document",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/nuxeo/api/v1/id/:docId/@convert",
            "params": [
              {
                "name": "docId",
                "value": "",
                "type": "path",
                "description": "Id of the document"
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "The name of the converter to execute"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "The requested mime type for the converted Blob, such as 'application/pdf'"
              },
              {
                "name": "format",
                "value": "",
                "type": "query",
                "description": "The requested extension of the converted Blob, such as 'pdf'"
              }
            ]
          },
          "docs": "One of the 'name', 'type' or 'format' parameters must be passed."
        },
        {
          "info": {
            "name": "Convert the Blob at the given xpath of the document",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/nuxeo/api/v1/path/:docPath/@blob/:blobXpath/@convert",
            "params": [
              {
                "name": "docPath",
                "value": "",
                "type": "path",
                "description": "Path of the document, ex: 'default-domain'"
              },
              {
                "name": "blobXpath",
                "value": "",
                "type": "path",
                "description": "XPath of the blob"
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "The name of the converter to execute"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "The requested mime type for the converted Blob, such as 'application/pdf'"
              },
              {
                "name": "format",
                "value": "",
                "type": "query",
                "description": "The requested extension of the converted Blob, such as 'pdf'"
              }
            ]
          },
          "docs": "One of the 'name', 'type' or 'format' parameters must be passed."
        },
        {
          "info": {
            "name": "Convert the main Blob of the document",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/nuxeo/api/v1/path/:docPath/@convert",
            "params": [
              {
                "name": "docPath",
                "value": "",
                "type": "path",
                "description": "Path of the document, ex: 'default-domain'"
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "The name of the converter to execute"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "The requested mime type for the converted Blob, such as 'application/pdf'"
              },
              {
                "name": "format",
                "value": "",
                "type": "query",
                "description": "The requested extension of the converted Blob, such as 'pdf'"
              }
            ]
          },
          "docs": "One of the 'name', 'type' or 'format' parameters must be passed."
        },
        {
          "info": {
            "name": "Initialize an empty document with default properties given a document type",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/nuxeo/api/v1/@emptyWithDefault",
            "params": [
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "The type of the empty document to be initialized"
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "The name of the empty document to be initialized"
              }
            ]
          },
          "docs": "To retrieve all initialized properties, the 'properties: *' header must be used"
        },
        {
          "info": {
            "name": "Initialize an empty document with default properties given a document type and a parent",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/nuxeo/api/v1/id/:docId/@emptyWithDefault",
            "params": [
              {
                "name": "docId",
                "value": "",
                "type": "path",
                "description": "Id of the document"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "The type of the empty document to be initialized"
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "The name of the empty document to be initialized"
              }
            ]
          },
          "docs": "To retrieve all initialized properties, the 'properties: *' header must be used"
        },
        {
          "info": {
            "name": "Initialize an empty document with default properties given a document type and a parent",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/nuxeo/api/v1/path/:docPath/@emptyWithDefault",
            "params": [
              {
                "name": "docPath",
                "value": "",
                "type": "path",
                "description": "Path of the document, ex: 'default-domain'"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "The type of the empty document to be initialized"
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "The name of the empty document to be initialized"
              }
            ]
          },
          "docs": "To retrieve all initialized properties, the 'properties: *' header must be used"
        },
        {
          "info": {
            "name": "Execute a page provider on document by its id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/nuxeo/api/v1/id/:docId/@pp/:pageProviderName",
            "headers": [
              {
                "name": "X-NXDocumentProperties",
                "value": ""
              },
              {
                "name": "X-NXContext-Category",
                "value": ""
              },
              {
                "name": "X-Versioning-Option",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "docId",
                "value": "",
                "type": "path",
                "description": "Id of the document"
              },
              {
                "name": "pageProviderName",
                "value": "",
                "type": "path",
                "description": "Name of the page provider, ex: 'user_domains'"
              },
              {
                "name": "currentPageIndex",
                "value": "",
                "type": "query",
                "description": "Index of the current page"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Offset of the page to retrieve. If set, the 'currentPageIndex' parameter is ignored."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Size of the page to retrieve. Ignored if offset set"
              },
              {
                "name": "maxResults",
                "value": "",
                "type": "query",
                "description": "Maximum results to retrieve"
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "Property to sort by, for example 'dc:title'"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "Sort order, accepts 'asc' or 'desc', default is 'desc'"
              }
            ]
          },
          "docs": "Only documents which you have permission to see will be returned"
        },
        {
          "info": {
            "name": "Execute a page provider on document by its path",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/nuxeo/api/v1/path/:docPath/@pp/:pageProviderName",
            "headers": [
              {
                "name": "X-NXDocumentProperties",
                "value": ""
              },
              {
                "name": "X-NXContext-Category",
                "value": ""
              },
              {
                "name": "X-Versioning-Option",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "docPath",
                "value": "",
                "type": "path",
                "description": "Path of the document, ex: 'default-domain'"
              },
              {
                "name": "pageProviderName",
                "value": "",
                "type": "path",
                "description": "Name of the page provider, ex: 'user_domains'"
              },
              {
                "name": "currentPageIndex",
                "value": "",
                "type": "query",
                "description": "Index of the current page"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Offset of the page to retrieve. If set, the 'currentPageIndex' parameter is ignored."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Size of the page to retrieve. Ignored if offset set"
              },
              {
                "name": "maxResults",
                "value": "",
                "type": "query",
                "description": "Maximum results to retrieve"
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "Property to sort by, for example 'dc:title'"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "Sort order, accepts 'asc' or 'desc', default is 'desc'"
              }
            ]
          },
          "docs": "Only documents which you have permission to see will be returned"
        },
        {
          "info": {
            "name": "Returns the specified rendition on document by its id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/nuxeo/api/v1/id/:docId/@rendition/:renditionName",
            "params": [
              {
                "name": "docId",
                "value": "",
                "type": "path",
                "description": "Id of the document"
              },
              {
                "name": "renditionName",
                "value": "",
                "type": "path",
                "description": "Name of the rendition, ex: 'pdf'"
              }
            ]
          },
          "docs": "Returns the specified rendition on document by its id"
        },
        {
          "info": {
            "name": "Returns the specified rendition on document by its path",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/nuxeo/api/v1/path/:docPath/@rendition/:renditionName",
            "params": [
              {
                "name": "docPath",
                "value": "",
                "type": "path",
                "description": "Path of the document, ex: 'default-domain'"
              },
              {
                "name": "renditionName",
                "value": "",
                "type": "path",
                "description": "Name of the rendition, ex: 'pdf'"
              }
            ]
          },
          "docs": "Returns the specified rendition on document by its path"
        },
        {
          "info": {
            "name": "Get the children of a document by its id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/nuxeo/api/v1/id/:docId/@search",
            "headers": [
              {
                "name": "X-NXDocumentProperties",
                "value": ""
              },
              {
                "name": "X-NXContext-Category",
                "value": ""
              },
              {
                "name": "X-Versioning-Option",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "docId",
                "value": "",
                "type": "path",
                "description": "Id of the document"
              },
              {
                "name": "query",
                "value": "",
                "type": "query",
                "description": "NXQL query"
              },
              {
                "name": "fullText",
                "value": "",
                "type": "query",
                "description": "A full text query"
              },
              {
                "name": "orderBy",
                "value": "",
                "type": "query",
                "description": "Field on which to order"
              },
              {
                "name": "currentPageIndex",
                "value": "",
                "type": "query",
                "description": "Index of the current page"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Offset of the page to retrieve. If set, the 'currentPageIndex' parameter is ignored."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Size of the page to retrieve. Ignored if offset set"
              },
              {
                "name": "maxResults",
                "value": "",
                "type": "query",
                "description": "Maximum results to retrieve"
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "Property to sort by, for example 'dc:title'"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "Sort order, accepts 'asc' or 'desc', default is 'desc'"
              }
            ]
          },
          "docs": "Only documents which you have permission to see will be returned"
        },
        {
          "info": {
            "name": "Get the children of a document by its path",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}/nuxeo/api/v1/path/:docPath/@search",
            "headers": [
              {
                "name": "X-NXDocumentProperties",
                "value": ""
              },
              {
                "name": "X-NXContext-Category",
                "value": ""
              },
              {
                "name": "X-Versioning-Option",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "docPath",
                "value": "",
                "type": "path",
                "description": "Path of the document, ex: 'default-domain'"
              },
              {
                "name": "currentPageIndex",
                "value": "",
                "type": "query",
                "description": "Index of the current page"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Offset of the page to retrieve. If set, the 'currentPageIndex' parameter is ignored."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Size of the page to retrieve. Ignored if offset set"
              },
              {
                "name": "maxResults",
                "value": "",
                "type": "query",
                "description": "Maximum results to retrieve"
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "Property to sort by, for example 'dc:title'"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "Sort order, accepts 'asc' or 'desc', default is 'desc'"
              },
              {
                "name": "query",
                "value": "",
                "type": "query",
                "description": "NXQL query"
              },
              {
                "name": "fullText",
                "value": "",
                "type": "query",
                "description": "A full text query"
              },
              {
                "name": "orderBy",
                "value": "",
                "type": "query",
                "description": "Field on which to order"
              }
            ]
          },
          "docs": "Only documents which you have permission to see will be returned"
        }
      ]
    }
  ],
  "bundled": true
}