Nuxeo 5

Nuxeo 5 Component
org.nuxeo.ecm.platform.ui.web.restAPI.contrib

Individual Documentation Coverage

done proportion
33.33 %


Author: missing

Version: missing

Location: nuxeo-jsf/nuxeo-platform-ui-web/src/main/resources/OSGI-INF/restAPI-contrib.xml

Require

No requirements

Required by

Not required

Implementation

No implementation


Is a contribution to:


Create a File document via upload
POST /nuxeo/restAPI/{repoId}/{docId}/{filename}/upload


Restlet for uploading a file via the Plugin (linked to FileManager)
(ie create a document from a file)
POST /nuxeo/restAPI/{repoId}/{docId}/pluginUpload/{path}
POST /nuxeo/restAPI/{repoId}/{docId}/createFromFile/{path}


Simple restlet to browse content
GET /nuxeo/restAPI/browse
GET /nuxeo/restAPI/{repoId}/browse
GET /nuxeo/restAPI/{repoId}/{docId}/browse


GET /nuxeo/restAPI/{repoId}/{docId}/export
=> export a document and possibly associated tree

GET /nuxeo/restAPI/{repoId}/{docId}/exportSingle
=> export a single document

GET /nuxeo/restAPI/{repoId}/{docId}/exportTree
=> export a document tree

Associated GET parameters are :
- format : xml/zip


Allows lock manipulation via Restlet API:
GET /nuxeo/restAPI/{repoId}/{docId}/Locking/lock
GET /nuxeo/restAPI/{repoId}/{docId}/Locking/unlock
GET /nuxeo/restAPI/{repoId}/{docId}/Locking/status
LOCK /nuxeo/restAPI/{repoId}/{docId}/Locking
UNLOCK /nuxeo/restAPI/{repoId}/{docId}/Locking


GET /nuxeo/restAPI/{repoId}/{docId}/downloadFile
or equivalently with optional query parameters:
GET /nuxeo/restAPI/{repoId}/{docId}/downloadFile?schema=file&blobField=content&filenameField=filename


Upload a file in an existing document
POST /nuxeo/restAPI/{repo}/{docid}/{filename}/uploadFile


GET /nuxeo/restAPI/{repo}/{parentdocid}/createDocument
or equivalently with optional query paramaters:
GET /nuxeo/restAPI/{repo}/{parentdocid}/createDocument?docType=File
or
POST /nuxeo/restAPI/{repo}/{parentdocid}/createDocument
with arguments with initial values of the documents fields as string valued properties


Allows deleting documents via Restlet API:
GET /nuxeo/restAPI/{repoId}/{docId}/deleteDocumentRestlet
GET /nuxeo/restAPI/{repoId}/{docId}/delete


Allows to update document properties via Restlet API:
GET /nuxeo/restAPI/{repoId}/{docId}/updateDocumentRestlet?prop1=value1
GET /nuxeo/restAPI/{repoId}/{docId}/update?prop1=value1
example : http://127.0.0.1:8080/nuxeo/restAPI/default/1fee4b3e-8b8e-494e-b0a5-eef5113fb5a7/updateDocumentRestlet?dublincore:description=No%20comment


GET /nuxeo/restAPI/creationContainerList
or equivalently with optional query paramaters (where docType is the
type of the document to create):
GET /nuxeo/restAPI/creationContainerList?docType=File


GET /nuxeo/restAPI/opensearch?q=keywords

Perform a document search on the ecm:fulltext index and return the
results as a RSS 2.0 file with opensearch.org metadata


GET /nuxeo/restAPI/directoryCacheInvalidate
GET /nuxeo/restAPI/directoryCacheInvalidate?directory=userDirectory&directory=groupDirectory

Invalidate the cache of the requested directories or of all directories if not directory name is given as parameter.

  • target org.nuxeo.ecm.platform.ui.web.restAPI.service.PluggableRestletService
  • point restlets
  • restletPlugin
    • useSeam true
    • enabled true
    • class org.nuxeo.ecm.platform.ui.web.restAPI.UploadRestlet
    • name upload
  • restletPlugin
    • useSeam true
    • useConversation true
    • enabled true
    • class org.nuxeo.ecm.platform.ui.web.restAPI.PluginUploadRestlet
    • name pluginUpload
  • restletPlugin
    • useSeam false
    • enabled true
    • class org.nuxeo.ecm.platform.ui.web.restAPI.BrowseRestlet
    • name browse
  • restletPlugin
    • useSeam false
    • enabled true
    • class org.nuxeo.ecm.platform.ui.web.restAPI.ExportRestlet
    • name export
  • restletPlugin
    • useSeam false
    • useConversation false
    • enabled true
    • class org.nuxeo.ecm.platform.ui.web.restAPI.LockingRestlet
    • name locking
  • restletPlugin
    • useSeam true
    • enabled true
    • class org.nuxeo.ecm.platform.ui.web.restAPI.DownloadFileRestlet
    • name downloadFileRestlet
  • restletPlugin
    • useSeam true
    • enabled true
    • class org.nuxeo.ecm.platform.ui.web.restAPI.UploadFileRestlet
    • name uploadFileRestlet
  • restletPlugin
    • useSeam true
    • enabled true
    • class org.nuxeo.ecm.platform.ui.web.restAPI.CreateDocumentRestlet
    • name createDocumentRestlet
  • restletPlugin
    • useSeam false
    • enabled true
    • class org.nuxeo.ecm.platform.ui.web.restAPI.DeleteDocumentRestlet
    • name deleteDocumentRestlet
  • restletPlugin
    • useSeam false
    • enabled true
    • class org.nuxeo.ecm.platform.ui.web.restAPI.UpdateDocumentRestlet
    • name updateDocumentRestlet
  • restletPlugin
    • useSeam true
    • enabled true
    • class org.nuxeo.ecm.platform.ui.web.restAPI.CreationContainerListRestlet
    • name creationFolderListRestlet
  • restletPlugin
    • useSeam false
    • enabled true
    • class org.nuxeo.ecm.platform.ui.web.restAPI.OpenSearchRestlet
    • name openSearchRestlet
  • restletPlugin
    • useSeam false
    • enabled true
    • class org.nuxeo.ecm.platform.ui.web.restAPI.DirectoryCacheRestlet
    • name directoryCache

Last generation: 18:21:25 CEST 11/07/2009