Versions Compared

Key

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

...

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}

Text level properties in "tuv" node:

  • x-wb-status
  • x-wb-bookmark
  • x-wb-locked
  • x-wb-validation
  • x-wb-editor
  • 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:

Code Block
{
	"trm": { "status": "Finished", .... }
	"result": { ...disregard... },
	"custom": {
		"fileref": "2a27db94a02d42c68b74b9276ffd4cbc",
		"filename": "export_en.tmx"
	}
}


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

Code Block
(GET) /api/media/get/{fileref}