Documentation Powered by ReDoc

DocumentConverter HTTP API (7.10)

Download OpenAPI specification:Download

OX Software GmbH: info@open-xchange.com URL: https://www.gnu.org/licenses/gpl-2.0.htmlhttps://www.gnu.org/licenses/gpl-2.0.html

Documentation of the OX Software GmbH DocumentConverter HTTP API.

DocumentConverter

The DocumentConverter service module.

beginconvert

post /beginconvert
http://example.com:8008/documentconverterws/beginconvert
https://example.com:8011/documentconverterws/beginconvert

Starting the stateful retrieval of single pages from a source document.

query Parameters
url
string

TODO (KA)

targetformat
string
Default: "jpeg"
Enum: "jpeg" "png"

TODO (KA)

nocache
string
Default: false
Enum: false true

TODO (KA)

cacheonly
string
Default: false
Enum: false true

TODO (KA)

async
string
Default: false
Enum: false true

TODO (KA)

priority
string
Default: "background"
Enum: "background" "low" "medium" "high" "inastant"

TODO (KA)

autoscale
string
Default: false
Enum: false true

TODO (KA)

hidechanges
string
Default: false
Enum: false true

TODO (KA)

hidecomments
string
Default: false
Enum: false true

TODO (KA)

userrequest
string
Default: false
Enum: false true

TODO (KA)

Request Body schema: multipart/form-data
file
string <binary>

Responses

200

The jobId of the current stateful job, to be used in subsequent calls.

500

DocumentConverter server response in case of an error.

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "async": true,
  • "errorcode": 0,
  • "cachehash": "string",
  • "inputfilehash": "string",
  • "locale": "string",
  • "jobid": "string",
  • "pagecount": 0,
  • "originalPageCount": 0,
  • "pagenumber": 0,
  • "mimetype": "string",
  • "extension": "string",
  • "passwordprotected": true,
  • "maxsourcesize": true,
  • "unsupported": true,
  • "result": "string"
}

convert

post /convert
http://example.com:8008/documentconverterws/convert
https://example.com:8011/documentconverterws/convert

Stateless conversion of a source document to a target format. The conversion result data is given back as an archive in the file case as well as in the JSON case.

query Parameters
async
string
Default: false
Enum: false true

TODO (KA)

autoscale
string
Default: false
Enum: false true

TODO (KA)

cacheonly
string
Default: false
Enum: false true

TODO (KA)

firstpageonly
string
Default: false
Enum: false true

TODO (KA)

hidechanges
string
Default: false
Enum: false true

TODO (KA)

hidecomments
string
Default: false
Enum: false true

TODO (KA)

nocache
string
Default: false
Enum: false true

TODO (KA)

priority
string
Default: "background"
Enum: "background" "low" "medium" "high" "inastant"

TODO (KA)

returntype
string
Default: "json"
Enum: "json" "file"

TODO (KA)

targetformat
string
Default: "jpeg"
Enum: "jpeg" "png"

TODO (KA)

url
string

TODO (KA)

userrequest
string
Default: false
Enum: false true

TODO (KA)

Request Body schema: multipart/form-data
file
string <binary>

Responses

200

DocumentConverter server status 'ok', returning the result document, that is directly written into the output stream or given as base64 encoded data URL within the JSON response, if indicated by the request.

500

DocumentConverter server response in case of an error.

Response samples

Content type
application/octet-stream
No sample

endconvert

post /endconvert
http://example.com:8008/documentconverterws/endconvert
https://example.com:8011/documentconverterws/endconvert

Finishing of a stateful document conversion, which needs to be made after the last 'getpage' call. The jobId returned from the initial 'beginconvert' call is to be used for this final call.

query Parameters
jobid
string

TODO (KA)

nocache
string
Default: false
Enum: false true

TODO (KA)

cacheonly
string
Default: false
Enum: false true

TODO (KA)

async
string
Default: false
Enum: false true

TODO (KA)

Responses

200

DocumentConverter server status 'ok' in case of no error.

500

DocumentConverter server response in case of an error.

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "async": true,
  • "errorcode": 0,
  • "cachehash": "string",
  • "inputfilehash": "string",
  • "locale": "string",
  • "jobid": "string",
  • "pagecount": 0,
  • "originalPageCount": 0,
  • "pagenumber": 0,
  • "mimetype": "string",
  • "extension": "string",
  • "passwordprotected": true,
  • "maxsourcesize": true,
  • "unsupported": true,
  • "result": "string"
}

getpage

post /getpage
http://example.com:8008/documentconverterws/getpage
https://example.com:8011/documentconverterws/getpage

Retrieving a single page after an initial stateful 'beginconvert' call. The jobId returned from the initial 'beginconvert' call is to be used for each one of these calls.

query Parameters
jobid
string

TODO (KA)

pangenumber
integer <int16>

TODO (KA)

returntype
string
Default: "json"
Enum: "json" "file"

TODO (KA)

nocache
string
Default: false
Enum: false true

TODO (KA)

cacheonly
string
Default: false
Enum: false true

TODO (KA)

async
string
Default: false
Enum: false true

TODO (KA)

Responses

200

DocumentConverter server status 'ok', returning the resulting page of the document, that is directly written into the output stream or given as base64 encoded data URL within the JSON response, if indicated by the request.

500

DocumentConverter server response in case of an error.

Response samples

Content type
application/octet-stream
No sample

getpreview

post /getpreview
http://example.com:8008/documentconverterws/getpreview
https://example.com:8011/documentconverterws/getpreview

Stateless retrieval of a preview from a file as an image.

query Parameters
url
string

TODO (KA)

targetformat
string
Default: "jpeg"
Enum: "jpeg" "png"

TODO (KA)

returntype
string
Default: "json"
Enum: "json" "file"

TODO (KA)

nocache
string
Default: false
Enum: false true

TODO (KA)

cacheonly
string
Default: false
Enum: false true

TODO (KA)

async
string
Default: false
Enum: false true

TODO (KA)

priority
string
Default: "background"
Enum: "background" "low" "medium" "high" "inastant"

TODO (KA)

hidechanges
string
Default: false
Enum: false true

TODO (KA)

hidecomments
string
Default: false
Enum: false true

TODO (KA)

userrequest
string
Default: false
Enum: false true

TODO (KA)

Request Body schema: multipart/form-data
file
string <binary>

Responses

200

DocumentConverter server status 'ok', returning the result preview image, that is directly written into the output stream or given as base64 encoded data URL within the JSON response, if indicated by the request.

500

DocumentConverter server response in case of an error.

Response samples

Content type
application/octet-stream
No sample

getthumbnail

post /getthumbnail
http://example.com:8008/documentconverterws/getthumbnail
https://example.com:8011/documentconverterws/getthumbnail

Stateless retrieval of a thumbnail preview from a file as an image.

query Parameters
url
string

TODO (KA)

targetformat
string
Default: "jpeg"
Enum: "jpeg" "png"

TODO (KA)

returntype
string
Default: "json"
Enum: "json" "file"

TODO (KA)

nocache
string
Default: false
Enum: false true

TODO (KA)

cacheonly
string
Default: false
Enum: false true

TODO (KA)

async
string
Default: false
Enum: false true

TODO (KA)

priority
string
Default: "background"
Enum: "background" "low" "medium" "high" "inastant"

TODO (KA)

hidechanges
string
Default: false
Enum: false true

TODO (KA)

hidecomments
string
Default: false
Enum: false true

TODO (KA)

userrequest
string
Default: false
Enum: false true

TODO (KA)

Request Body schema: multipart/form-data
file
string <binary>

Responses

200

DocumentConverter server status 'ok', returning the result thumbnail image, that is directly written into the output stream or given as base64 encoded data URL within the JSON response, if indicated by the request.

500

DocumentConverter server response in case of an error.

Response samples

Content type
application/octet-stream
No sample

rconvert

post /rconvert
http://example.com:8008/documentconverterws/rconvert
https://example.com:8011/documentconverterws/rconvert

Specific flavour of a source document conversion to a specified target format, offering additional functionality.

query Parameters
method
string
Default: "convert"
Enum: "convert" "queryavailability" "beginpageconversion" "getconversionpage" "endpageconversion"

TODO (KA)

jobtype
string
Default: "pdf"
Enum: "graphic" "html" "image" "imagetransformation" "odf" "ooxml" "pdf" "pdf2grf" "pdf2html" "pdf2svg" "pdfenctest"

TODO (KA)

jobid
string

TODO (KA)

priority
string
Default: "background"
Enum: "background" "low" "medium" "high" "inastant"

TODO (KA)

locale
string

TODO (KA)

cachehash
string

TODO (KA)

remotecachehash
string

TODO (KA)

filtershortname
string

TODO (KA)

inputtype
string

TODO (KA)

pixelwidth
integer <int32>

TODO (KA)

pixelheight
integer <int32>

TODO (KA)

mimetype
string

TODO (KA)

pangerange
string

TODO (KA)

pangenumber
integer <int16>

TODO (KA)

ziparchive
string
Default: false
Enum: false true

TODO (KA)

infofilename
string

TODO (KA)

nocache
string
Default: false
Enum: false true

TODO (KA)

cacheonly
string
Default: false
Enum: false true

TODO (KA)

async
string
Default: false
Enum: false true

TODO (KA)

imageresolution
integer <int16>

TODO (KA)

imagescaletype
string
Default: "contain"
Enum: "contain" "cover"
remoteurl
string

TODO (KA)

url
string

TODO (KA)

returntype
string
Default: "json"
Enum: "json" "file"

TODO (KA)

autoscale
string
Default: false
Enum: false true

TODO (KA)

hidechanges
string
Default: false
Enum: false true

TODO (KA)

hidecomments
string
Default: false
Enum: false true

TODO (KA)

userrequest
string
Default: false
Enum: false true

TODO (KA)

Request Body schema: multipart/form-data
file
string <binary>

Responses

200

DocumentConverter server status 'ok', returning the result document, that is directly written into the output stream or given as base64 encoded data URL within the JSON response, if indicated by the request.

500

DocumentConverter server response in case of an error.

Response samples

Content type
application/octet-stream
No sample

root Request

post /
http://example.com:8008/documentconverterws/
https://example.com:8011/documentconverterws/

Getting the current status of the DocumentConverter server as text/html response.

query Parameters
metrics
string
Default: "false"

Set to "yes", if a metrics summary should be returned.

Responses

200

DocumentConverter status message when successfull.

status Request

post /status
http://example.com:8008/documentconverterws/status
https://example.com:8011/documentconverterws/status

Getting the current status of the DocumentConverter server as application/json response.

query Parameters
metrics
string
Default: "false"

Set to "yes", if a metrics summary should be returned.

Responses

200

Getting the current DocumentConverter status.

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "server":
    {
    }
}