resources/files/new

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.

(POST) /resources/files/new

The parameters are a JSON object included in the request body:

scope	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.	Mandatory, object
did	The document id. This must be a document within the scope.	Mandatory, int
locale	Language of deliverable.	Mandatory, string
encoding	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, string?
useSourceIfNoTranslation	Optional, default is true. Uses source texts where translations are missing.	Optional, bool?
includeAllLocales	Optional, default is true. In case of multilingual files (such as Excel, CSV...) the built file will contain translations in all the languages.	Optional, bool?
highlight	Optional instructions to highlight segments in the created document. Examples: Highlight erroneous segments in red color. NOTE: Available for Microsoft Word documents only.
highlight.errors	If true then segments are highlighted if the text's status is red (in the editor).	Optional, bool?
highlight.editors	Optional integer list of last editors. You can use the following numeric values: 7 (110% pre-translation from previous version): Cyan color 6 (100% pre-translation from previous version): Green color 9 (110% memory pre-translation): Magenta 2 (100% memory pre-translation): Yellow 3 (Fuzzy pre-translation): Red 5 (Machine translation): Gray	Optional, int[]?

The result is returned from the asynchronous operation:

token	A token that lets you reference the file for these actions: Download file: /api/media/get/{token} Save file to library: resources/files/upload Preview file: resources/files/new/preview Use the "preview" property of the present result for details on whether a web preview is possible or not
tokenmins	The number of minutes until token expires.
size	The file size in bytes.
name	The name of the file.
details	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