Skip to main content

SOAP API

Terminology Management

In the SOAP API, you can use these terminology-related methods:

  1. importTermURL()

    Use this method to import XLS, XLSX, TBX, and MTF files for a specific customer. There is an additional option to add terms to ones that already exist. Additional options:

    • addToExistingTerms – adds new terms to terms that already exist

    • purgeTerms – deletes old terms and imports new terms for a specific customer

  2. importTermMTOM

    Use this method to import XLS, XLSX, TBX, and MTF files for a specific customer using either MTOM or BASE64, depending on the chosen web service. Additional options are the same as in importTermURL().

  3. exportTerm()

    Use this method to export terminology for a specified customer. You can also specify the main language, list of translation languages, term status, domain, and file type (XTMTermFileTypeEnum). If you export an XLS or XLSX file, you can choose which columns to export.

  4. checkTermCompletion()

    Checks if import or export is completed. This method requires a list of file descriptors and returns the status for each file (XTMTermCompletionStatusEnum).

  5. downloadTermURL()

    Downloads the file with exported terminology. This method requires a list of file descriptors and returns the URLs to the exported files.

  6. downloadTermMTOM()

    Downloads the file with exported terminology. This method requires a list of file descriptors and returns the files in MTOM or BASE64, depending on the chosen web service. Files are packed as a ZIP file.

XTMTermFileTypeEnum – list of possible terminology file types:

Table 59. : XTMTermFileTypeEnum – list of possible Terminology file types

Option

Description

TBX

TBX.

MTF

MTF.

XLS

XLS.

XLSX

XLSX.


XTMTermCompletionStatusEnum – list of possible statuses for import/export process:

Table 60. : XTMTermCompletionStatusEnum – list of possible statuses for import/export process

Option

Description

IN_PROGRESS

File is still being imported/exported.

FINISHED

Import/Export process has been finished.

ERROR

Import/Export process has been finished with an error.

NOT_EXIST

A file with the specified ID does not exist.