Content Comparison

Downloading Tasks

• The GET /task API call will allow you to view the list of tasks assigned to you in the TMS
• Use Get /task/{id}/content to download the XLIFF for a given task

Uploading A Completed Task

• Uploading completed XLIFF files to the TMS has the same effect as if you had worked within Lingotek's Workbench to perform the translations/edits. 
  • We only re-import the translations and not any metadata from the XLIFF that may have been added to the file. 
  • Authorship is attributed to the user re-importing the tasks through the API. 

  • Existing translations in the phase are overwritten by the ones in the XLIFF file.

    Tip
    A revision history for each segment is available on our Workbench.

    
    

  • If there is no translation in the imported XLIFF the import process will skip over that segment. Leave it untranslated.
  • If there isn't text for a XLIFF file, then translations are not overwritten. 
• On export, we add a lgtk:phaseUUID attribute in the header of the XLIFF. This is what we match on when you re-import the XLIFF. If this attribute is missing, we are not able to successfully re-import the XLIFF file.
  •  When you re-import a zip folder of XLIFF files, we ignore the folder structure entirely. We simply use the  lgtk:phaseUUID attribute in each of the XLIFF files to programmatically match each XLIFF file with the applicable tasks in our Task List.
• Via the UI, a user is not able to download or re-import XLIFF for a task that isn't in their Task List (i.e. the task has to be assigned to you). Therefore, the API calls will likewise need to authenticate using the credentials of the user to whom the task is assigned in Lingotek.
• You can only download / re-import XLIFF for 'Active' tasks (i.e. tasks that have not been 'marked complete' within Lingotek).
• We're assuming that you won't be merging or splitting segments within your tool. If on re-import we detect that one or more segments were merged or split, the re-import will fail.
• We accept both zip folders containing XLIFF files or single XLIFF files.
• To send the XLIFF back use PATCH /task/{id}/content. Be sure that the structure of the XLIFF has not changed. 
• If the document is completely correct and does not need any changes, you should still upload it back to the TMS and the system will note that the document was completed and did not need any edits. 

File Structure

• We follow XLIFF 1.2 spec. If the format is kept the same and the lgtk:phaseUUID is kept in the header, thereshouldn't be any compatability issues.
• Be sure to not modify the number of trans-units, their order or identifiers. 
• The XLIFF files will only ever correspond to one target language

FAQ

If no changes have been made to the document, should we upload an unchanged document? 

• If the document is completely correct and does not need any changes, you should still upload it back to the TMS and the system will note that the document was completed and did not need any edits. 

Which time zones we should use when update the modify date? It seemed that Lingotek will update the modify time after uploading.

• Lingotek doesn't import any meta from the uploaded XLIFF. All we do is extract the translations form the trans-units. We ignore everything else. Modified dates for each segment translation will be set in our system based on the upload time.