Nuxeo Server

Special HTTP Headers

In order to have more control over REST API Calls, you can use the following special Nuxeo HTTP headers.

HTTP Header Default Value Description Example
X-NXVoidOperation false Force server to return no content (like a void operation). X-NXVoidOperation: true
Can be useful when dealing with blobs to avoid having the blob output sent back to the client.
Nuxeo-Transaction-Timeout 30 Specify the duration of the transaction timeout (seconds) Nuxeo-Transaction-Timeout: 300
(Sets timeout for 5 minutes for longer transactions)
properties * Filter properties so the returned document contains only data from the specified schemas properties: dublincore, file
(* Returns data from all schemas)
Repository default Specify the repository name if it has been changed or if you have multiple repositories Repository: myCustomRepositoryName
enrichers.document Request further information in the response. See (Content Enrichers) for more details. enrichers.document: "thumbnail"
(Returns related thumbnail of the document)
X-Versioning-Option NONE Increment minor or major version and returns versioned document X-Versioning-Option: MAJOR
source Set this property in document context data to be used for automatic source-based versioning. See source-based versioning for more details. source: REST
fetch.document Load additional parts of an object with entity-type document fetch.document: value1, value2,...
See Document JSON and Extended Fields for more details on accepted values.
depth children Control aggregation depth depth: children
Accepted values: root, children, max.
See Aggregating Marshallers and Avoiding Infinite Loops for more details.
nx_es_sync false Force ElasticSearch synchronous indexing during a REST call nx_es_sync: true

Learn More


Related Documentation
2 months ago Loubna Benzaama Fix Showcase Content add-on doc
3 years ago Thierry Martins 15
3 years ago Solen Guitter 14 | Improve anchor links
3 years ago Solen Guitter 13 | Remove deprecated headers
3 years ago Nicolas Chapurlat 12
3 years ago Nicolas Chapurlat 11
3 years ago Nicolas Chapurlat 10
3 years ago Nicolas Chapurlat 9
4 years ago Solen Guitter 8 | Add details on depth and X-NXfetch.document
4 years ago Solen Guitter 7
4 years ago Solen Guitter 6 | Add X-NXfetch.document and depth
4 years ago Solen Guitter 5 | Add X-NXproperties and X-NXenrichers.document, replacing deprecated X-NXDocumentProperties and X-NXContext-Category
4 years ago Manon Lumeau 4
4 years ago Vladimir Pasquier 3
4 years ago Solen Guitter 2
4 years ago Vladimir Pasquier 1
History: Created by Vladimir Pasquier

We'd love to hear your thoughts!

All fields required