跳到主要内容

CheckConversionRequestDto

The parameters of one file conversion.

NameTypeDescriptionNotes
fileIdInteger (int32)The file to convert. It is taken from the route of the operation, so a value sent in the body is overwritten.[optional] [example: 1]
syncBooleanHow to wait for the result: true converts inside the request and answers with the finished result, which is only sensible for small documents, while false queues the conversion and answers with an entry to poll.[optional] [example: false]
startConvertBooleanWhether the conversion is to be started. It is set by the operation itself, so a value sent in the body is overwritten.[optional] [example: true]
versionInteger (int32)The version to convert; 0 or less means the current version.[optional] [example: 1]
passwordStringThe password that opens the source document, for a file that is protected by one; anything else may be left out.[optional] [example: password123] [nullable]
outputTypeStringThe extension of the format to convert into, without the dot, and one the portal can produce from that source format; left out, the default of the portal for that kind of document is used.[optional] [example: pdf] [nullable]
createNewIfExistBooleanWhere the result goes when the file has been converted before: true creates another file beside the source, false replaces the converted file that already exists.[optional] [example: false]