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

Body

fileIdintegerformat: int32

syncboolean

startConvertboolean

versionintegerformat: int32

passwordstring

createNewIfExistboolean

Examples

PUT /api/2.0/files/file/5184/checkconversion HTTP/1.1
Accept: application/json
Content-Length: 135
Content-Type: application/json
Host: example.com

{
  "fileId": 3206,
  "sync": true,
  "startConvert": true,
  "version": 1234,
  "password": "Dv5eAyghkd",
  "createNewIfExist": true
}

curl --request PUT \
  --url https://example.com/api/2.0/files/file/5184/checkconversion \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "fileId": 3206,
  "sync": true,
  "startConvert": true,
  "version": 1234,
  "password": "Dv5eAyghkd",
  "createNewIfExist": true
}'

Responses

200

Conversion result

idstring

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

sourcestring

resultunknown

errorstring

processedstring

401

Unauthorized

403

Forbidden