Built-in Rest plugins
| Name | Endpoint | Description |
|---|---|---|
|
TestRestPlugin |
/rest/plugins (GET or POST) |
Reference implementation returning a plain-text echo of the call: the plugin's own canonical class name followed by every received parameter as key=value pairs. |
|
TestGetDocumentRestPlugin |
/rest/plugins/file (GET) |
Reference implementation streaming back a document's binary content, given a docId parameter. Sets the response's MIME type and file name from the document's own properties; add an inline parameter (any value) to get a Content-Disposition: inline response instead of the default attachment. |
|
ConvertPDFToPDFARestPlugin |
/rest/plugins/file (POST) |
Converts an uploaded PDF file to PDF/A and streams the converted file back as the response, using the same converter helper as the built-in PdfToPdfAConversion document converter. |
None of these plugins is invoked directly by path - the generic REST endpoints above take a className parameter with the plugin's canonical class name (e.g. com.openkm.plugin.rest.TestRestPlugin) and dispatch to it. Use /rest/plugins (or its /file variant) for a plugin that returns text/JSON, or the /file variant for one that returns binary content. See Creating your own Rest Plugin (extending the REST API) for the interface and full examples, including how complex return objects are marshalled.
