Export to TMX

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.

URL

(POST) /api/resources/segments/io/tmx

PARAMETERS

The message body contains a JSON object.


Generic export properties:


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:

Export a project memory by specifying its project ID:

See all available scopes here.


Mandatory

object

locales

The list of all locales that you want to export.

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):

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[]

markupRemoveOptional, 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:


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

TMX specific options


extractWordbeeProperties

Optional, default is false.

If true then the system includes Wordbee specific properties in the TMX file. These properties are saved as standard prop nodes.

  • <prop type="x-wb-context">the value</prop>

Segment level properties in "tu" node:

  • x-wb-context
  • x-wb-type
  • x-wb-visibility
  • x-wb-delimiter
  • x-wb-{custom field id} : For example "x-wb-customstr10"

Text level properties in "tuv" node:

  • x-wb-status
  • x-wb-bookmark
  • x-wb-locked
  • x-wb-validation
  • x-wb-editor
  • x-wb-prefix
  • x-wb-suffix
  • x-wb-ctx


Optional, bool
extractTUProperties

Optional, default is false.

If true then any TMX attributes saved with the segment are extracted. These either were previously imported from a TMX or manually added in the translatio editor.

Optional, bool
extractTUVProperties

Optional, default is false.

If true then any TMX attributes saved with a segment's text are extracted. These either were previously imported from a TMX or manually added in the translatio editor.

Optional, bool
extractPersonInitials

Optional, default is true.

If true then the last editing user's initials are extracted to TMX:

  • "tuv" node, attribute "changeid"


Optional, bool
enforceWordbeeCompatibility

Optional, default is false.

If true then further meta data attributes "x-wb..." are added to the export. When later reimporting this TMX, the system is able to restore all properties.

  • x-wb-tag


Optional, bool

RESULTS

This API method is an "asynchronous" operation. It either immediately returns the result or instead an operation ID which you need to periodically poll until the operation has finished.

Upon the first call you typically get an "operationid". Use this to further poll the operation status. See full explanation here: Asynchronous operation

When the operation is finished you get the reference to the file:


Once the operation is finished, download the file with fileref and this API method:


EXAMPLES

Export a translation memory with ID 112334 and with all default parameters: