Versions Compared

Old Version 1

changes.mady.by.user Stephan Böhmig

Saved on

compared with

New Version 2

changes.mady.by.user Stephan Böhmig

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...


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



filterIdformatId

Optional file format configuration ID.

This lets you specifically define which filter to apply to extract content.

If not set, then the system will automatically choose a matching configuration among all those configured 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:

  1. If formatId is specified: This configuration will be chosen. Otherwise:
  2. If formatProfileId is specirfied: The first matching configuration is chosen (based on file extension, name and content). Otherwise:
  3. The first matching configuration from all your configurations is chosen. See online at Settings > File formats
.


int?, Optional
formatProfileId

Optional

Pre-translation

ID of a document format profile from which to select a format configuration.

Profiles are configured online at Settings > 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. 

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
mt

Optional. Default is true if not specified.

Set to true to disable use of MT (e.g. if enabled in the word count profile).

bool?, Optional
copySourceToTarget

Optional. Default is true if not specified.

  • true: Default. Populate untranslated target texts with the original content
  • false: Leave untranslated target texts empty.


Warning

Avoid use of false with binary files such as Microsoft Word, Excel, Powerpoint, InDesign etc. The system will otherwise very likely fail to build valid translated files.


bool?, Optional




Results
saveTranslatedFilebuildTranslatedFile

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, see saveWordcountFile.

bool?, OptionalsaveWordcountFile

Optional. Default is true if not specified.

If true then the results will contain a file reference to download the word count details.

Use false if you are only interested in the translated file, see saveTranslatedFile.

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

...