Start file conversion

PUT /api/2.0/files/file/{fileid}/checkconversion

Request

Starts a conversion operation of a file with the ID specified in the request.

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Content-Typeenum of string

Can be one of: application/json, application/*+json, text/json.

Path

fileIdintegerformat: int32required

File ID

Body

Request parameters for starting file conversion

fileIdintegerformat: int32

File ID

syncboolean

Specifies if the conversion process is synchronous or not

startConvertboolean

Specifies whether to start a conversion process or not

versionintegerformat: int32

File version

passwordstring

Password

outputTypestring

Output type

createNewIfExistboolean

Create new if exists

Examples

PUT /api/2.0/files/file/%7Bfileid%7D/checkconversion HTTP/1.1
Accept: application/json
Content-Length: 164
Content-Type: application/json
Host: example.com

{
  "fileId": 1126,
  "sync": true,
  "startConvert": true,
  "version": 1234,
  "password": "6lQFgSiwte",
  "outputType": "some text",
  "createNewIfExist": true
}

curl --request PUT \
  --url https://example.com/api/2.0/files/file/%7Bfileid%7D/checkconversion \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "fileId": 1126,
  "sync": true,
  "startConvert": true,
  "version": 1234,
  "password": "6lQFgSiwte",
  "outputType": "some text",
  "createNewIfExist": true
}'

Responses

200

Conversion result

Result of file conversation operation.

idstring

Operation ID

Operationone of

.enum of string

[Move - Move, Copy - Copy, Delete - Delete, Download - Download, MarkAsRead - MarkAsRead, Import - Import, Convert - Convert, Duplicate - Duplicate]

Can be one of: Move, Copy, Delete, Download, MarkAsRead, Import, Convert, Duplicate.

.enum of integer

[0 - Move, 1 - Copy, 2 - Delete, 3 - Download, 4 - MarkAsRead, 5 - Import, 6 - Convert, 7 - Duplicate]

Can be one of: 0, 1, 2, 3, 4, 5, 6, 7.

progressintegerformat: int32

Operation progress

sourcestring

Source file

resultunknown

Resulting file

errorstring

Error

processedstring

Specifies if the operation is processed or not

401

Unauthorized