Generates the translated file and saves to a temporary location. Note that this method cannot be used with attachments.
The call is asynchronous and returns a file token to subsequently download, preview or save the created file.
The parameters are a JSON object included in the request body:
The scope object. Note that if you use a document set or global search scope, you will receive an "available" = false result. In fact these scopes do not support files.
|The document id. This must be a document within the scope.
Language of deliverable.
|Optional encoding of the file. If not specified or null, the system uses the original file's encoding or the last one used for the current file.
Optional, default is true. Uses source texts where translations are missing.
|Optional, default is true. In case of multilingual files (such as Excel, CSV...) the built file will contain translations in all the languages.
Optional instructions to highlight segments in the created document. Examples: Highlight erroneous segments in red color. Example:
To understand if highlighting is available for a document and which options/colors are used, please check out the hl node when you get details for the document.
NOTE: Available for Microsoft Word documents only. Always look at the hl node as we may support other formats already.
The result is returned from the asynchronous operation:
A token that lets you reference the file for these actions:
|The number of minutes until token expires.
|The file size in bytes.
|The name of the file.
JSON with the parameters to subsequently preview the created file.
The parameters are the same as those returned in property "preview" by the method resources/files/details