Export TMX File

End Point: [TMEngine URL]/create

Default: http://localhost:8000/TMServer/export

Send a 'POST' request to the method end point with these parameters in a JSON body:

Field	Required	Content
`id`	Yes	ID of the memory to populate with TMX data
`file`	Yes	Path to the TMX file being created
`langs`	No	JSON array contaning the list of languages to export
`srcLang`	No	Language to set as source langage. The wildcard '`all`' is used by default
`properties`	No	JSON object with string properties to set in the exported file

Note

when exporting a TMX file on a remote server, make sure the TMEngine server has access to the specified location.

Example:

{
  "id": "1568163112478",
  "file": "/Volumes/Data/segments.tmx",
  "langs": [
      "en-US",
       "ja",
       "fr-FR",
       "it"
  ],
  "srcLang": "en-US",
  "properties": {
    "project": "Milky Way",
    "subject": "Astronomy Device"
  }
}

The server responds with a JSON object containing two fields.

On success, field 'status' is set to 'OK' and field 'process' contains the ID of the background export process that was initiated.

{
  "process": "1568222345643",
  "status": "OK"
}

On error, field 'status' is set to 'failed' and field 'reason' contains the error cause.

{
  "status": "failed",            
  "reason": "Unknown memory type"        
}

After starting the export process, monitor its status using the Get Process Status method.