Nuxeo Server

REST API

Updated: September 22, 2017 Page Information Edit on GitHub

Nuxeo REST API is available on Nuxeo Platform server. All endpoints follow the URL:

http://NUXEO_SERVER/nuxeo/api/v1/*

This page explains the organization and scope of the existing endpoints and other additional mechanisms which extend the behavior of the API.

Scope and Concepts

Nuxeo provides a complete API accessible via HTTP/HTTPS. This API is the best way to remotely integrate portals, workflow engines, ESBs and custom applications written in JavaScript, Ruby, etc, with the Nuxeo Platform repository. See REST API Endpoints for more detailed information on the endpoints provided by Nuxeo REST API and how to contribute your own.

Additional Features

The Nuxeo REST API offers several additional features compared to a standard REST API:

  • the ability to pipe command calls on a resource
  • the use of Content enrichers in request headers which allow you to request more information with the returned resources (for example, receiving all of a document's children in addition to the document itself)
  • the use of Web Adapters which transform the resources returned (for example, getting all the tasks of a document, or its related documents)

Learn more

Available Client SDKs

We provide several client SDKs to make it even easier to use the API integrated with the Nuxeo Platform.

3 days ago manonlumeau NXDOC-1323: Update BDE doc
a year ago Solen Guitter 101
a year ago Gabriel Barata 100
a year ago Bertrand Chauvin 99
2 years ago Solen Guitter 98 | REST contributors are called Content enrichers
2 years ago Solen Guitter 97
2 years ago Alain Escaffre 96
2 years ago Bertrand Chauvin 95
2 years ago Bertrand Chauvin 94
2 years ago Bertrand Chauvin 93 | video link
2 years ago Bertrand Chauvin 92 | localhost -> servername
2 years ago Bertrand Chauvin 91
2 years ago Antoine Taillefer 90
2 years ago Solen Guitter 89
2 years ago Solen Guitter 88
2 years ago Solen Guitter 87 | format
2 years ago Solen Guitter 86
2 years ago Guillaume Renard 85
3 years ago Joshua Fletcher 84
3 years ago Solen Guitter 82 | Fix link to blog post
3 years ago Solen Guitter 83
3 years ago Solen Guitter 80
3 years ago Solen Guitter 81
3 years ago Alain Escaffre 79
3 years ago Alain Escaffre 78
3 years ago Alain Escaffre 77
3 years ago Alain Escaffre 76
3 years ago Alain Escaffre 75
3 years ago Alain Escaffre 74
3 years ago Alain Escaffre 73
3 years ago Alain Escaffre 72
3 years ago Alain Escaffre 71
3 years ago Alain Escaffre 70
3 years ago Alain Escaffre 69
3 years ago Alain Escaffre 68
3 years ago Solen Guitter 67
3 years ago Alain Escaffre 66
3 years ago Alain Escaffre 65
3 years ago Alain Escaffre 64
3 years ago Alain Escaffre 63
3 years ago Alain Escaffre 62
3 years ago Thibaud Arguillere 61
3 years ago Solen Guitter 60
3 years ago Manon Lumeau 59
3 years ago Alain Escaffre 57
3 years ago Alain Escaffre 58
3 years ago Thibaud Arguillere 56
3 years ago Solen Guitter 55
4 years ago Solen Guitter 54
4 years ago Laurent Doguin 53
4 years ago Solen Guitter 52 | Formatted steps
4 years ago Damien Metzler 51
4 years ago Solen Guitter 50
4 years ago Solen Guitter 49
4 years ago Solen Guitter 48
4 years ago Solen Guitter 47
4 years ago Alain Escaffre 46
4 years ago Alain Escaffre 45
4 years ago Alain Escaffre 44
4 years ago Solen Guitter 43 | Formatting
4 years ago Alain Escaffre 42
4 years ago Alain Escaffre 41
4 years ago Alain Escaffre 40
4 years ago Solen Guitter 39
4 years ago Solen Guitter 38 | Added children pages
4 years ago Solen Guitter 37
4 years ago Solen Guitter 36
4 years ago Alain Escaffre 35
4 years ago Solen Guitter 34
4 years ago Solen Guitter 33
4 years ago Alain Escaffre 32
4 years ago Alain Escaffre 31
4 years ago Alain Escaffre 30
4 years ago Alain Escaffre 29
4 years ago Alain Escaffre 28
4 years ago Alain Escaffre 27
4 years ago Alain Escaffre 26
4 years ago Thomas Roger 25
4 years ago Solen Guitter 24
4 years ago Alain Escaffre 23
4 years ago Alain Escaffre 22
4 years ago Alain Escaffre 21
4 years ago Alain Escaffre 20
4 years ago Alain Escaffre 19
4 years ago Alain Escaffre 18
4 years ago Alain Escaffre 17
4 years ago Alain Escaffre 16
4 years ago Alain Escaffre 15
4 years ago Alain Escaffre 14
4 years ago Alain Escaffre 13
4 years ago Alain Escaffre 12
4 years ago Alain Escaffre 11
4 years ago Alain Escaffre 10
4 years ago Alain Escaffre 9
4 years ago Alain Escaffre 8
4 years ago Alain Escaffre 7
4 years ago Solen Guitter 6 | Formatting
4 years ago Thierry Delprat 5
4 years ago Solen Guitter 4
4 years ago Thibaud Arguillere 3
4 years ago Thierry Delprat 2
4 years ago Thierry Delprat 1
History: Created by Thierry Delprat