In this document the translate5 TM service REST interface is described.
The translate5 TM service is build by using the OpenTM2 Translation Memory Engine.
It provides the following functionality:
This can be achieved by the following specification of a RESTful HTTP Serive, the specification is given in the following form:
The transferred data in the requests is JSON, and is directly done in the request body.
In this document the OpenTM2 is always assumed under http://opentm2/.
To rely on full networking features (proxying etc.) the URL is configurable in Translate5, so that the OpenTM2 instance can also reside under: http://xyz/foo/bar/.
For each request the possible errors are listed below for each resource. In case of an error the body should contain at least the following JSON, if it is senseful the attributes of the original representation can be added.
{
errors: [{errorMsg: 'Given tmxData is no TMX.'}]
}
The Parameter „name“ contains the TM Name as a string. The string has a maxlength of 256 chars. It can contain any characters except the characters backslash (\), slash(/), colon (:), question mark (?), asterisk (*), vertical line (|), less than sign (<), and greater than sign (>).
Uploading a file is optional, omitting a file means creating a empty TM only.
If an empty TM is created, the POST request contains only the JSON structure with the TM Name.
If an existing binary OpenTM2 file should be additionally imported to the new TM, the POST must be encoded as multipart/form-data.
The JSON structure with the meta data will then be in the first chunk of the multiparted request, the chunk must be named “meta”.
The second chunk contains the plain binary file content and must be named “data”. This binary data contains the TM content
The resulting body contains the name of the TM, as given in the POST request.
To OpenTM2 – without data / creating an empty TM:
{
sourceLang: “en”, // the source language is required for a new TM
name: „TM Name“
}Raw POST to OpenTM2 – with provided import file:
POST http://opentm2/translationmemory HTTP/1.1 Content-Type: multipart/form-data; boundary="autogenerated" -- autogenerated Content-Type: application/json; charset=utf-8 Content-Disposition: form-data; name=meta {"name":"TM Name", sourceLang:"en"} --autogenerated Content-Type: image/jpeg Content-Disposition: form-data; name=data; filename=Original Filename.jpg ...TM content ... --autogenerated--
In both cases from OpenTM2 - HTTP 200 OK:
{
name: „TM Name“
}
To OpenTM2:
multipart/form-data like on POST above, expect that no separate JSON section is needed here.
Call answers directly after the upload is done, but before the import starts with HTTP 201 – this means: Import is created and will be started now.
From OpenTM2 - HTTP 201 OK:
{ // empty JSON object, since no data expected as result here!
}
To OpenTM2:
multipart/form-data like on POST above, expect that no separate JSON section is needed here.
From OpenTM2 - HTTP 200 OK:
{
‘status’:’import’ //allowed status values: import, available, error
}
To OpenTM2: -
From OpenTM2 - HTTP 200 OK:
[{
name: 'my nice TM'
}]
To OpenTM2: -
From OpenTM2 - HTTP 200 OK:
Same as POST from OpenTM2 result.
Adressed by the given URL, no body needed.
Currently not needed, would be only to change the TM name
Currently not needed.
In first concept it was planned to implement routines to open and close a TM. While concepting we found some problemes with this approach:
This leads to the following conclusion in implementation of opening and closing of TMs:
OpenTM2 has to automatically load the requested TMs if requested. Also OpenTM2 has to close the TMs after a TM was not used for some time. That means that OpenTM2 has to track the timestamps when a TM was last requested.
Note: This method is not required as memories are automatically opened when they are accessed for the first time.
Note: This method is not required as memories are automatically opened when they are accessed for the first time.
This method updates an existing proposal when a proposal with the same key information (source text, language, segment number, and document name) exists.
Parameters sourceLang and targetLang are containing the languages as RFC5646.
Parameters source and target are containing the entry contents to be stored. Format? plain string?
Attribute Parameters:
To OpenTM2:
{
sourceLang: 'de',
targetLang: 'en',
source: „Das ist das Haus des Nikolaus“,
target: „This is the house of St. Nicholas“,
documentName: 'my file.sdlxliff',
segmentNumber: 123,
markupTable: 'translate5',
author: „Thomas Lauria“,
type: '',
timeStamp: '',
context: '',
addInfo: ''
}
The result from the server contains the same data as posted to the server. No additonal ID is added, since the entries are identified by the whole source string instead by an ID, only the timestamp is added.
From OpenTM2 – HTTP 200 OK:
{
sourceLang: 'de',
targetLang: 'en',
source: „Das ist das Haus des Nikolaus“,
target: „This is the house of St. Nicholas“,
documentName: 'my file.sdlxliff',
segmentNumber: 123,
markupTable: 'translate5',
timestamp: '2015-05-12 13:46:12',
author: „Thomas Lauria“
}
To OpenTM2:
{
sourceLang: 'de',
targetLang: 'en-US',
source: „Das ist das Haus des Nikolaus“,
documentName: 'my file.sdlxliff', // can be empty
segmentNumber: 123, // can be empty
markupTable: 'translate5', // can be empty
context: „xyz“ // can be empty
}
From OpenTM2 HTTP 200 OK:
{
'NumOfFoundProposals': 2,
'results':
[{
source: „Das ist das Haus des Nikolaus“,
target: „This is the house of St. Nicholas“,
sourceLang: 'de', ← rfc5646
targetLang: 'en', ← rfc5646
matchRate: '100',
documentName: 'my file.sdlxliff',
DocumentShortName: 'shortnam.txt',
id: 'identifier',
type: 'Manual',
matchType: 'Exact',
segmentNumber: 123,
markupTable: 'XYZ',
timestamp: '2015-05-12 13:46:12',
author: „Thomas Lauria“.
context: '',
addInfo: ''
},{
source: „Das ist das Haus des Nikolaus“,
target: „This is the house of St. Nicholas“,
sourceLang: 'de', ← rfc5646
targetLang: 'en', ← rfc5646
matchRate: '100',
documentName: 'my file.sdlxliff',
DocumentShortName: 'shortnam.txt',
id: 'identifier',
type: 'Manual',
matchType: 'Exact',
segmentNumber: 123,
markupTable: 'XYZ',
timestamp: '2015-05-12 13:46:12',
author: „Thomas Lauria“.
context: '',
addInfo: ''
}]}
To OpenTM2:
{
searchString: 'Haus des Nikolaus',
searchType: 'source', // values can be source or target
searchPosition: 123// can be empty; Position where a search should start in the memory,
numResults: 1,
msSearchAfterNumResults: 100 //number of milliseconds the search will continue, after the first result is found. All additional results that are found in this additional time will also be returned until numResults is reached. If numResults is reached before msSearchAfterNumResults is reached, the search will abort. If msSearchAfterNumResults is reached before numResults is reached, search is also aborted. All found results are delivered in both cases.
}
From OpenTM2 HTTP 200 OK:
{
NewSearchPosition: '123:54', /returns NULL, if end of TM is reached
results:[{
source: „Das ist das Haus des Nikolaus“,
target: „This is the house of St. Nicholas“,
sourceLang: 'de', ← rfc5646
targetLang: 'en', ← rfc5646
matchRate: '100',
documentName: 'my file.sdlxliff',
DocumentShortName: 'shortnam.txt',
id: 'identifier',
type: 'Manual',
matchType: 'Exact',
segmentNumber: 123,
markupTable: 'XYZ',
timestamp: '2015-05-12 13:46:12',
author: „Thomas Lauria“.
context: '',
addInfo: ''
},{
source: „Das ist das Haus des Nikolaus“,
target: „This is the house of St. Nicholas“,
sourceLang: 'de', ← rfc5646
targetLang: 'en', ← rfc5646
matchRate: '100',
documentName: 'my file.sdlxliff',
DocumentShortName: 'shortnam.txt',
id: 'identifier',
type: 'Manual',
matchType: 'Exact',
segmentNumber: 123,
markupTable: 'XYZ',
timestamp: '2015-05-12 13:46:12',
author: „Thomas Lauria“.
context: '',
addInfo: ''
}]}