Permalink
Fetching contributors…
Cannot retrieve contributors at this time
589 lines (570 sloc) 15.3 KB
title review labels toc notes confluence tree_item_index history
REST API
comment date status
2017-12-15
ok
lts2016-ok
url
rest-api
bchauvin
university
excerpt
multi-excerpt
lts2017-ok
true
Documentation page used by the Marketing team. Check with Marketing before deleting or moving.
ajs-parent-page-id ajs-parent-page-title ajs-space-key ajs-space-name canonical canonical_source page_id shortlink shortlink_source source_link
31033314
Nuxeo Server
NXDOC
Nuxeo Platform Developer Documentation
REST+API
13664833
QYLQ
/display/NXDOC/REST+API
300
author date message version
Solen Guitter
2016-08-29 13:40
101
author date message version
Gabriel Barata
2016-08-26 15:20
100
author date message version
Bertrand Chauvin
2016-04-20 14:51
99
author date message version
Solen Guitter
2016-02-15 17:37
REST contributors are called Content enrichers
98
author date message version
Solen Guitter
2016-02-15 13:48
97
author date message version
Alain Escaffre
2015-12-13 20:26
96
author date message version
Bertrand Chauvin
2015-10-19 16:09
95
author date message version
Bertrand Chauvin
2015-10-19 16:01
94
author date message version
Bertrand Chauvin
2015-10-19 15:54
video link
93
author date message version
Bertrand Chauvin
2015-10-19 15:45
localhost -> servername
92
author date message version
Bertrand Chauvin
2015-10-07 16:35
91
author date message version
Antoine Taillefer
2015-10-06 12:29
90
author date message version
Solen Guitter
2015-09-07 09:40
89
author date message version
Solen Guitter
2015-04-22 13:08
88
author date message version
Solen Guitter
2015-04-22 12:47
format
87
author date message version
Solen Guitter
2015-04-22 10:06
86
author date message version
Guillaume Renard
2015-04-14 08:51
85
author date message version
Joshua Fletcher
2015-03-10 18:12
84
author date message version
Solen Guitter
2014-10-20 16:58
83
author date message version
Solen Guitter
2014-10-20 16:58
Fix link to blog post
82
author date message version
Solen Guitter
2014-09-23 11:23
81
author date message version
Solen Guitter
2014-09-23 11:23
80
author date message version
Alain Escaffre
2014-09-23 00:15
79
author date message version
Alain Escaffre
2014-07-03 03:00
78
author date message version
Alain Escaffre
2014-07-03 02:59
77
author date message version
Alain Escaffre
2014-07-03 02:54
76
author date message version
Alain Escaffre
2014-07-03 02:41
75
author date message version
Alain Escaffre
2014-07-03 02:31
74
author date message version
Alain Escaffre
2014-07-03 01:27
73
author date message version
Alain Escaffre
2014-07-03 01:19
72
author date message version
Alain Escaffre
2014-07-03 01:11
71
author date message version
Alain Escaffre
2014-07-03 01:00
70
author date message version
Alain Escaffre
2014-07-03 00:50
69
author date message version
Alain Escaffre
2014-07-03 00:44
68
author date message version
Solen Guitter
2014-07-01 14:32
67
author date message version
Alain Escaffre
2014-07-01 00:38
66
author date message version
Alain Escaffre
2014-07-01 00:25
65
author date message version
Alain Escaffre
2014-07-01 00:24
64
author date message version
Alain Escaffre
2014-07-01 00:22
63
author date message version
Alain Escaffre
2014-07-01 00:18
62
author date message version
Thibaud Arguillere
2014-06-09 23:53
61
author date message version
Solen Guitter
2014-06-06 12:01
60
author date message version
Manon Lumeau
2014-06-05 11:09
59
author date message version
Alain Escaffre
2014-06-03 23:17
58
author date message version
Alain Escaffre
2014-06-03 23:17
57
author date message version
Thibaud Arguillere
2014-05-11 22:42
56
author date message version
Solen Guitter
2014-04-10 17:56
55
author date message version
Solen Guitter
2014-02-25 18:04
54
author date message version
Laurent Doguin
2014-01-31 11:57
53
author date message version
Solen Guitter
2013-12-16 10:24
Formatted steps
52
author date message version
Damien Metzler
2013-12-13 21:17
51
author date message version
Solen Guitter
2013-11-14 15:05
50
author date message version
Solen Guitter
2013-10-30 13:30
49
author date message version
Solen Guitter
2013-10-30 13:24
48
author date message version
Solen Guitter
2013-10-30 13:23
47
author date message version
Alain Escaffre
2013-10-30 01:21
46
author date message version
Alain Escaffre
2013-10-30 01:15
45
author date message version
Alain Escaffre
2013-10-29 00:11
44
author date message version
Solen Guitter
2013-10-28 09:30
Formatting
43
author date message version
Alain Escaffre
2013-10-27 21:05
42
author date message version
Alain Escaffre
2013-10-27 20:37
41
author date message version
Alain Escaffre
2013-10-27 20:36
40
author date message version
Solen Guitter
2013-10-22 16:59
39
author date message version
Solen Guitter
2013-10-21 10:40
Added children pages
38
author date message version
Solen Guitter
2013-10-21 10:35
37
author date message version
Solen Guitter
2013-10-21 10:33
36
author date message version
Alain Escaffre
2013-10-18 01:07
35
author date message version
Solen Guitter
2013-10-17 11:26
34
author date message version
Solen Guitter
2013-10-17 11:25
33
author date message version
Alain Escaffre
2013-10-16 19:26
32
author date message version
Alain Escaffre
2013-10-16 16:58
31
author date message version
Alain Escaffre
2013-10-16 16:51
30
author date message version
Alain Escaffre
2013-10-16 16:39
29
author date message version
Alain Escaffre
2013-10-16 15:58
28
author date message version
Alain Escaffre
2013-10-16 15:57
27
author date message version
Alain Escaffre
2013-10-16 12:54
26
author date message version
Thomas Roger
2013-10-01 12:01
25
author date message version
Solen Guitter
2013-09-20 18:20
24
author date message version
Alain Escaffre
2013-09-17 18:08
23
author date message version
Alain Escaffre
2013-09-17 03:32
22
author date message version
Alain Escaffre
2013-09-17 03:31
21
author date message version
Alain Escaffre
2013-09-17 03:28
20
author date message version
Alain Escaffre
2013-09-17 03:26
19
author date message version
Alain Escaffre
2013-09-17 03:24
18
author date message version
Alain Escaffre
2013-09-17 03:22
17
author date message version
Alain Escaffre
2013-09-17 03:21
16
author date message version
Alain Escaffre
2013-09-17 03:07
15
author date message version
Alain Escaffre
2013-09-17 02:59
14
author date message version
Alain Escaffre
2013-09-17 02:58
13
author date message version
Alain Escaffre
2013-09-17 02:50
12
author date message version
Alain Escaffre
2013-09-17 02:47
11
author date message version
Alain Escaffre
2013-09-17 02:34
10
author date message version
Alain Escaffre
2013-09-17 02:29
9
author date message version
Alain Escaffre
2013-09-17 02:23
8
author date message version
Alain Escaffre
2013-09-17 01:43
7
author date message version
Solen Guitter
2013-07-31 17:14
Formatting
6
author date message version
Thierry Delprat
2013-07-30 01:47
5
author date message version
Solen Guitter
2013-05-17 11:09
4
author date message version
Thibaud Arguillere
2013-05-16 21:36
3
author date message version
Thierry Delprat
2013-05-16 17:21
2
author date message version
Thierry Delprat
2013-05-16 17:18
1

{{! excerpt}}

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.

{{! /excerpt}}{{! multiexcerpt name='RestAPIIntroduction'}}

{{#> callout type='info' heading='Nuxeo University'}} Watch the related courses on Nuxeo University

  • Course on the REST API. ![]({{file name='university-restapi.png' page='nxdoc/university'}} ?w=450,border=true) {{/callout}}

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]({{page page='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]({{page page='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]({{page page='rest-api-web-adapters'}}) which transform the resources returned (for example, getting all the tasks of a document, or its related documents)

Learn more

  • Visit the Nuxeo API playground to experiment with different endpoints on your Nuxeo instance. You can read the [Nuxeo Platform API Playground documentation page]({{page page='nuxeo-api-playground'}}) for more information on how to use it.
  • Follow our Working with the REST API course at Nuxeo University.
  • Follow a cURL tutorial on how to [create a document in the repository and bind a binary to it]({{page page='howto-upload-file-nuxeo-using-rest-api'}})
  • Check out some [consecutive cURL calls to get familiar with the resources/command variations of the API]({{page page='using-curl'}})
  • Read a blog post that discusses advanced concepts of Nuxeo REST API with a few examples.
  • A client sample nuxeo-travel-expenses (available on GitHub) based on web components and polymer framework demonstrating how to use the workflow REST API.

Available Client SDKs

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

  • [Java client]({{page page='java-automation-client'}})
  • [JavaScript client]({{page page='javascript-client'}})
  • [iOS client]({{page page='ios-client'}})
  • [Android client]({{page page='android-client'}})
  • [PHP client]({{page page='php-automation-client'}}) (partial implementation)
  • DART client
  • [.NET Client]({{page page='net-client'}})

{{! /multiexcerpt}}