Difference between revisions of "Upload via REST API"
From Transkribus Wiki
Philip Kahle (Talk | contribs) (Created page with "= Upload of Documents = The path <code>/rest/uploads</code> includes endpoints that allow to import a document into Transkribus. ==<code>https://transkribus.eu/TrpServerTest...") |
Philip Kahle (Talk | contribs) |
||
| Line 1: | Line 1: | ||
| − | |||
| − | |||
The path <code>/rest/uploads</code> includes endpoints that allow to import a document into Transkribus. | The path <code>/rest/uploads</code> includes endpoints that allow to import a document into Transkribus. | ||
==<code>https://transkribus.eu/TrpServerTesting/rest/uploads</code>== | ==<code>https://transkribus.eu/TrpServerTesting/rest/uploads</code>== | ||
| + | |||
| + | A POST request to this endpoint creates a new upload process on the server. It is mandatory to set the query parameter <code>collId</code> which must include the ID of a collection where the user has write access.<br/> | ||
| + | If the Content-Type header is set to <code>application/xml</code>, the request body must include a valid Transkribus METS XML.<br/> | ||
| + | If the header specifies <code>application/json</code> then a JSON object of the following form is expected: | ||
Revision as of 15:42, 23 August 2017
The path /rest/uploads includes endpoints that allow to import a document into Transkribus.
https://transkribus.eu/TrpServerTesting/rest/uploads
A POST request to this endpoint creates a new upload process on the server. It is mandatory to set the query parameter collId which must include the ID of a collection where the user has write access.
If the Content-Type header is set to application/xml, the request body must include a valid Transkribus METS XML.
If the header specifies application/json then a JSON object of the following form is expected:
