Metadata
In the SOAP API, you can use these metadata-related methods:
Use these methods to obtain additional information about jobs, projects, XTM Cloud system information, and supported files:
obtainJobExtraInfo()
Obtains additional identifiers for the given list of jobs. This method requires a list of job descriptors and returns the list of
XTMJobExtraInfoResponseAPIobjects.obtainProjectExtraInfo()
Obtains additional identifiers for all jobs in the given project. This method requires a project descriptor and returns the list of
XTMJobExtraInfoResponseAPIobjects.getXTMInfo()
Obtains the base information about XTM Cloud. Returns the
XTMInfoResponseAPIobject.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:
DOCandDOCXcan be used instead ofDOCM.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
XTMCustomFieldsFilterAPIobject.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 additionalfetchLanguageDefinitionsoption.
XTMJobExtraInfoResponseAPI – additional identifiers:
Option | Description |
|---|---|
| Job descriptor. |
| ID of the XLIFF file. |
| Project descriptor. |
| ID of the target language. |
| Target language code. |
| Name of the XLIFF file. |
| ID of the source file. |
| Name of the original file. |
XTMInfoResponseAPI – base information about XTM Cloud:
Option | Description |
|---|---|
| Company name. |
| URL to the website. |
| Path to logo image. |
| XTM Cloud Version. |
XTMLanguageCombinationType – a list of language combination types:
Option | Description |
|---|---|
| All language combinations; the list of language pairs will not be provided. |
| Language combinations defined by the XTM Cloud user. |