Skip to main content

SOAP API

TM Management

Methods available in the XTM Cloud Project Manager web service:

  1. importTMURL()

    Use this method to import TMX or XLIFF files for a customer and language combination. You can also specify the TM tags that should be attached to the TM and set the status of the imported segments (SegmentStatusEnum). This method returns the file descriptors that should be used in the method described in point 3.

  2. importTMMTOM()

    Use this method to import TMX or XLIFF files for a customer and language combination using either MTOM or BASE64, depending on the chosen web service. You can also specify TM tags that should be attached to the TM and set the status of the imported segments (SegmentStatusEnum). This method returns the file descriptors that should be used in the method described in point 3.

  3. checkTMCompletion()

    Use this method to check if the importing or exporting process has finished. This method requires a list of file descriptors and returns the status of each file (XTM_TM_COMPLETION_STATUS).

  4. exportTM()

    Use this method to export TMX files for specified customers. You can also specify the project, source language, target language, and TM status. This method returns the file descriptors that should be used in the method described in point 3. There are additional options to include Reverse Memory and to choose the exported file type (XTM_TM_FILETYPE).

  5. downloadTMURL()

    Downloads the exported TMX file. This method requires a file descriptor and returns the URL to the TMX zip file.

  6. downloadTMMTOM()

    Downloads the exported TMX file. This method requires a file descriptor and returns the files in MTOM or BASE64 format, depending on the chosen web service. Files are packed as a zip file.

  7. findConcordance()

    Use this method to search concordance. It requires search parameters that can be defined in the XTMConcordanceFilterAPI object and returns a list of segments that match the search criteria, each represented by the XTMTmSegmentAPI object. The required parameters in the XTMConcordanceFilterAPI are:

    • languageCombination or baseProjectDescriptor:

      • languageCombination – source and target language.

      • baseProjectDescriptor – this contains the “uuid” field, which is assigned to the TIPP package and is used to find the base project. The base project will be used to get information about the customer, source and target language.

    • phrase – the phrase to search.

    • searchType – this defines whether the search will take place in the source or target segment (XTMConcordanceSearchTypeEnum).

    The optional parameters in the XTMConcordanceFilterAPI are:

    • checkLanguageVariants – set to define language variants for the search

    • customers – set to define a list of customers

    • customerSearchType – set to define whether the search will take place for all customers (XTMConcordanceSearcheCustomerTypeEnum)

    • exactMatch – set only to find exact match

    • reverseMemory – set to use reverse memory

    XTMConcordanceSearcheCustomerTypeEnum – type of customers to search in:

    Table 54. : XTMConcordanceSearcheCustomerTypeEnum – type of customers to search in

    Option

    Description

    ALL_CUSTOMERS

    Search in all customers


  8. findMatches()

    Use this method to search matches in the TM. It requires search parameters that can be defined in the XTMFindMatchesFilterAPI object and returns a list of matches found by using the given criteria, each represented by the XTMMatchAPI object. In the filter criteria, you can specify customer, language combination, context information, source sentence, and segment ID.

  9. deleteTM()

    Use this method to delete TM. It requires search parameters, which can be defined in the XTMDeleteTMFilterAPI object, and returns the process result. In the filter criteria, you can specify customer, project name, source and target language, status, tags, and XLIFF:doc statuses.

XTM_TM_COMPLETION_STATUS – possible TM completion statuses:

Table 55. : XTM_TM_COMPLETION_STATUS – possible TM completion statuses

Option

Description

IN_PROGRESS

Import/Export is still processing.

FINISHED

Import/Export is completed successfully.

ERROR

Import/Export could not be completed.

NOT_EXIST

The given TM file does not exist.


XTMConcordanceSearchTypeEnum – a list of possible types for phrase search:

Table 56. : XTMConcordanceSearchTypeEnum – a list of possible types for phrase search

Option

Description

SOURCE

The phrase will be searched in the segment source.

TARGET

The phrase will be searched in the segment target.


XTM_TM_FILETYPE – list of possible TM file types:

Table 57. : XTM_TM_FILETYPE – list of possible TM file types

Option

Description

TMX

TMX file (default).

XLS

Excel file.


SegmentStatusEnum – a list of possible ways of setting the segment status during a TM import:

Table 58. : SegmentStatusEnum – a list of possible ways of setting the segment status during a TM import

Option

Description

APPROVED

The TM segment status will automatically be set to approved.

NOT_APPROVED

The TM segment status will automatically be set to not approved.

FROM_FILE_OR_APPROVE

The TM segment status will be set according to their status in the TM import file and to approved where the status is not defined.

FROM_FILE_OR_NOT_APPROVE

The TM segment status will be set according to their status in the TM import file and to not approved where the status is not defined.