To Use this method to export segments to a TMX file (as a ZIP archive). You can export projects, jobs, resources and even multiple resources and apply a wide range of filters.
Note that the TMX is of version 1.4 file.
URL
(POST) /api/resources/segments/io/tmx
...
| Excerpt |
|---|
scope | The scope object tells the system what data to export. Examples: Export a project memory, translation memory or term base by specifying its resource ID: | Code Block |
|---|
{ "type": "DocumentSet", "dsid": 157 } |
Export a project memory by specifying its project ID: | Code Block |
|---|
{ "type": "Project", "projectid": 7726 } |
See all available scopes here.
| Mandatory object | | locales | The list of all locales that you want to export. | Code Block |
|---|
"locales": [ "de-DE", "de-AT", "fr-FR" ] |
| Mandatory, string[] | | query | An optional filter to apply to the exported data. Sample use cases are: - Exclude any translations in red status
- Export translations with certain custom fields only
- etc.
The query properties and features are described here. Example of exporting texts in neutral (0) or green (1) status thus excluding red status (2): | Code Block |
|---|
"query": {
"languages": [
{ "loc": ["en", "de", "fr"], "status": { 0, 1 } }
]
} |
IMPORTANT: The query has 2 functions: On the one hand it filters the segments and on the other hand it removes any translations that do not match the filter. In the example above, the query first identifies segments where at least one of the 3 languages is not in red status. In a second step, the system removes any languages that are in red status.
| Optional, object | | src | The source locale. It is highly recommended to set this value if you know it. Otherwise, the system chooses the first entry in locales. | Optional, string | | minimumTexts | Optional number of languages a segment must have at a minimum to be exported. By default this is 1. - 1: Includes monolingual (untranslated) segments
- 2: The segment must have at least 2 language versions
- ...
| Optional, int | | skipTargetIsSource | Optional, default is false. If true then translations are removed from the export if the text is identical to the source text.
| Optional, bool | | excludeCommentTypes | Optional. List of numeric comments categories. If set then only comments of these categories are included in the export. Categories are sequentially numbered and start at 0. | Optional, int[] | | markupRemove | Optional, default is false. If true then markup is removed from texts. See also property below. | Optional, bool | | markupReplaceChar | Optional, default is null. When you set markupRemove to true then any markup will be replaced by this character. Note: You must specify a single character such as: "markupReplaceChar": " " | Optional, char | | localesMappings | Optional dictionary to transform or modify language codes prior to saving to file. The following example, transforms fully qualified locales from the resource into simpler ones: | Code Block |
|---|
"localesMappings": {
"de-DE": "de",
"fr-FR": "fr"
} |
Locales not in the dictionary are left unchanged. If you map multiple original locales to the same output locale, the system will retain only one of the "clashing" languages.
| Optional, object |
|
...
When the operation is finished you get the reference to the file:
| Code Block |
|---|
{
"trm": {
"status": "Finished",
....
} "result": { ...disregard... },
"custom": {
"fileref": "2a27db94a02d42c68b74b9276ffd4cbc52e77705f6904233b0c33b2e5d7c4a80",
"filename": "export_en.tmx"
.zip",
"segments": 10
}
} |
Once the operation is finished, download the file with fileref and this API method:
| Code Block |
|---|
(GET) /api/media/get/{fileref} |
EXAMPLES
Export a translation memory with ID 112334 and with all default parameters:
| Code Block |
|---|
(POST) /api/resources/segments/io/tmx
BODY:
{
"scope": { "type": "DocumentSet", "dsid": 112334 },
"locales": [ "en", "fr" ]
} |