...
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:
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. | Optional, object |
RESULTS
The result is returned from the asynchronous operation:
...