...
| Original file | ||||
| fileToken | The token that references the original file to process. Use media/upload to upload your file and to obtain a token. | string, Mandatory | ||
| src | Source locale. This is the locale of the original file. | string, Mandatory | ||
| trg | Target locale. This is the locale into which to translate. | string, Mandatory | ||
| formatId | Optional ID of a specific document format configuration to use. The configuration defines how to extract text from the original file. The system selects a configuration as follows:
To enumerate all configurations, see: Document formats | int?, Optional | ||
| formatProfileId | Optional ID of a document format profile from which to select a format configuration. Profiles are configured online at Settings > Document format profiles. To enumerate all profiles, see: Document format profiles | |||
| Translation and word count | ||||
| wordcountProfileId | Optional word count profile to use. The profile defines how to leverage memories, how to pre-translate from memories, whether to use MT and more. If not set, then the system selects the alphabetically first word count profile configured online at Settings > Word count profiles. To enumerate word count profiles, see | int?, Optional | ||
| resourceIds | Optional list of translation/project memories or term bases to use for leveraging (as well as pre-translation). If not set, then the system will only pre-translate with MT (if a system is enabled in the word count profile) | int[]?, Optional | ||
| mtdisableMT | Optional. Default is true if not specified.Set to true to disable use of MT (e.g. if enabled in the word count profile).is false.
| bool?, Optional | ||
| copySourceToTarget | Optional. Default is true if not specified.
| bool?, Optional | ||
Preset properties from project | ||||
| projectPreset | This can be used to preset properties from a project's configuration. Optional. | object?, Optional | ||
| projectPreset.pid | Mandatory. A project ID. | int, Mandatory | ||
| projectPreset.setFormatProfile | Optional bool. If true then the formatProfileId is set to the project format profile (if any was assigned to the project) | bool?, Optional | ||
| projectPreset.setWordcountProfile | Optional bool. If true then the wordcountProfileId is set to the project's wordcount profile (if any was assigned to the project) | bool?, Optional | ||
| projectPreset.setResourcesAttached | Optional bool. If true then all memories/termbases attached to the project are used for word counting and pretranslation. If resourceIds was set, then the project resources are appended. | bool?, Optional | ||
| projectPreset.setResourcesProjectMemory | Optional bool. If true, then the project memory is used for word counting and pretranslation. If resourceIds was set, then the project resources are appended. | bool?, Optional | ||
| Results | ||||
| buildTranslatedFile | Optional. Default is true if not specified. If true then the results will contain a file reference to download the translated file. Use false if you are only interested in the word count information. | bool?, Optional | ||
| callbackurl | Optional URL which will be called upon success or failure of operation. This makes polling for results (see below) unnecessary. URL is called as POST request with operation result included in the body, see "RESULTS" chapter below for the JSON format. Suggestion: Include your own references in the URL, example: http://callmeback.mycompany.com?operationid=22222&mydata=abcde | string?, Optional |
...