PUT api/2.0/files/file/{fileId}/checkconversion This function requires authentication

Description

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

Parameters
Name Description Type Example
fileId
sent in url
File ID number 1234
FileId
sent in body
File ID System.Int32
Sync
sent in body
Specifies if the conversion process is synchronous or not System.Boolean
StartConvert
sent in body
Specifies whether to start a conversion process or not System.Boolean
Version
sent in body
File version System.Int32
Password
sent in body
Password System.String
Example
PUT api/2.0/files/file/1234/checkconversion
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "FileId": 1234,
  "Sync": true,
  "StartConvert": true,
  "Version": 1234,
  "Password": "some text"
}
Returns

Conversion result

Example Response
{
  "status": 0,
  "response": [
    {
      "Id": "some text",
      "Progress": 1234,
      "Source": "some text",
      "Error": "some text",
      "Processed": "some text"
    }
  ]
}