Skip to main content

SOAP API

Metadata

Use these methods to obtain additional information about jobs, projects, XTM Cloud system information, and supported files:

  1. obtainJobExtraInfo()

    Obtains additional identifiers for the given list of jobs. This method requires a list of job descriptors and returns the list of XTMJobExtraInfoResponseAPI objects.

  2. obtainProjectExtraInfo()

    Obtains additional identifiers for all jobs in the given project. This method requires a project descriptor and returns the list of XTMJobExtraInfoResponseAPI objects.

  3. getXTMInfo()

    Obtains the base information about XTM Cloud. Returns the XTMInfoResponseAPI object.

  4. getSupportedFilesInfo()

    Obtains the list of supported and not supported file extensions. For some not supported files, there is a list of alternative extensions which can be used instead of the given file, for example: DOC and DOCX can be used instead of DOCM.

  5. obtainCustomFields()

    This method can be used to search for custom fields. It returns all custom fields matching the given criteria and includes the details of the custom fields. Search parameters can be specified in the XTMCustomFieldsFilterAPI object.

  6. obtainLanguageCombinations()

    This method can be used to obtain language combinations for a customer. It returns the language combination type (XTMLanguageCombinationType). When the customer uses customized language combinations, the method returns the list of the defined language pairs as well. Language definitions, including language codes and localized language names, can be obtained using an additional fetchLanguageDefinitions option.

XTMJobExtraInfoResponseAPI – additional identifiers:

Table 42. : XTMJobExtraInfoResponseAPI – additional identifiers

Option

Description

jobDescriptor

Job descriptor.

xliffFileId

ID of the XLIFF file.

projectDescriptor

Project descriptor.

targetLanguageId

ID of the target language.

targetLanguageCode

Target language code.

xliffFileName

Name of the XLIFF file.

originalFileId

ID of the source file.

originalFileName

Name of the original file.


XTMInfoResponseAPI – base information about XTM Cloud:

Table 43. : XTMInfoResponseAPI – base information about XTM Cloud

Option

Description

companyName

Company name.

website

URL to the website.

logo

Path to logo image.

version

XTM Cloud Version.


XTMLanguageCombinationType – a list of language combination types:

Table 44. : XTMLanguageCombinationType – a list of language combination types

Option

Description

DEFAULT

All language combinations; the list of language pairs will not be provided.

CUSTOMISED

Language combinations defined by the XTM Cloud user.