Skip to content

Discovery REST API documentation

mkalam-alami edited this page Dec 19, 2011 · 2 revisions

Discovery REST API documentation

For the full documentation, browse to your Nuxeo setup at http://localhost:8080/nuxeo/site/easysoa

This REST API allows to upload any service registry-related information to the Nuxeo repository. Each call allows to register data related to either: an application, a service API, or a service. A Java client is available here.

Document hierarchy reminder: Services are always contained in Service APIs. Service APIs are either contained in Applications or other APIs.

  • PROTOCOL : POST (notification) or GET (view documentation)
  • URL : .../nuxeo/site/easysoa/notification/(appliimpl or api or service)
  • PARAMETERS :

The request body must contain the parameters in the application/x-www-form-urlencoded format (which is similar to the GET requests parameters). For a list of all available parameters for each document type, view each service's documentation by making a GET request to it.

Example request body:

     url=http://www.myapp.com/api&parentUrl=http://www.myapp.com/&title=MyApi
  • RESULT : {"result": ["ok"]} (if no error was found)

  • COMMENTS

    • JSONP Support: add a "callback" query parameter to make the request return a JSONP call instead of a JSON object.
Clone this wiki locally