Skip to main content

SOAP API

Files

You can generate, check the status, download, and upload files:

  1. generateJobFile()

    Creates files for the specified jobs. The type of file can be specified by GENERATED_FILE_TYPE. This method requires a list of job descriptors and returns file descriptors which should be used in the methods described in points 2, 3, and 4. In the case of generating XLIFF files, there is a possibility to enable or disable populating the target with the source (flag in additional XLIFF options).

    This method also enables the generation of a TIPP file from the requested list of jobs. In this case, all jobs should belong to the same target language, in the same project; otherwise, a validation error will be returned. The method returns only one file descriptor, which should be used in the methods described in points 6, 7, and 8.

  2. checkJobFileCompletion()

    Checks if the given files have been generated. This method requires a list of file descriptors and returns the status for each file. (XTM_JOB_FILE_COMPLETION_STATUS). If an error occurs, an additional message will be returned.

  3. downloadJobFileURL()

    Downloads all files that have been generated. This method requires a list of file descriptors and returns URLs to files.

  4. downloadJobFileMTOM()

    Downloads all files that have been generated. This method requires a list of file descriptors and returns the files as MTOM or BASE64, depending on the chosen web service. Files are packed as a zip file.

  5. generateProjectFile()

    Creates a file of a given type (GENERATED_PROJECT_FILE_TYPE) for the specified project. This method requires the project descriptor and returns the file descriptor, which should be used in the methods described in points 6, 7, and 8.

  6. checkProjectFileCompletion()

    Checks if the given project files have been generated. This method requires a list of file descriptors and returns the status for each file (XTM_PROJECT_FILE_COMPLETION_STATUS). If an error occurs, an additional message will be returned.

  7. downloadProjectFileURL()

    Downloads all files that have been generated. This method requires a list of file descriptors and returns URLs to the files.

  8. downloadProjectFileMTOM()

    Downloads all files that have been generated. This method requires a list of file descriptors and returns the files as MTOM or BASE64, depending on the chosen web service. Files are packed either as a zip or a TIPP file.

  9. uploadProjectFileURL()

    Uploads a file of a given type (XTM_UPLOAD_PROJECT_FILE_TYPE) for the specified project and step descriptor. This method returns the file descriptor that should be used in the method described in point 6. For a TIPP file, the target language will be read from the manifest.

  10. uploadProjectFileMTOM()

    Uploads a file of a given type (XTM_UPLOAD_PROJECT_FILE_TYPE) for the specified project and step descriptor using MTOM or BASE64, depending on the chosen web service. This method returns the file descriptor that should be used in the method described in point 6. For a TIPP file, the target language will be read from the manifest.

  11. updateReferenceFilesURL()

    Uploads new reference materials to the project or customer. This method requires the XTMUpdateReferenceFilesURLAPI object, which contains a list of files to upload and either the project descriptor or the customer descriptor. If the project descriptor is set, then the files will be uploaded to the specified project. Otherwise, if the customer descriptor is set, then they will be uploaded to the specified customer.

  12. updateReferenceFilesMTOM()

    Uploads new reference materials to the project or customer using MTOM or BASE64, depending on the chosen webservice. This method requires the XTMUpdateReferenceFilesMTOMAPI object, which contains a list of files to upload and either the project descriptor or the customer descriptor. If the project descriptor is set, then the files will be uploaded to the specified project. Otherwise, if the customer descriptor is set, then they will be uploaded to the specified customer.

    GENERATED_FILE_TYPE – possible file types that can be generated.

  13. downloadProjectMTOM()

    Downloads all available target files from a project. This method requires the project descriptor and returns the files as MTOM or BASE64, depending on the chosen web service. Files are packed as a zip file. There is an additional option to download only the latest version of any uploaded target files (XTMDownloadJobTypeEnum).

  14. downloadProjectURL()

    Downloads all available target files from a project. This method requires the project descriptor and returns the URLs to the files. There is an additional option to download only the latest version of any uploaded target files (XTMDownloadJobTypeEnum).

  15. downloadJobMTOM()

    Downloads all available target files for specified jobs. This method requires a list of job descriptors and returns the files as MTOM or BASE64, depending on the chosen web service. Files are packed as a zip file. There is an additional option to download only the latest version of any uploaded target file (XTMDownloadJobTypeEnum).

  16. downloadJobURL()

    Downloads all available target files for specified jobs. This method requires a list of job descriptors and returns the URLs to the files. There is an additional option to download only the latest version of any uploaded target file (XTMDownloadJobTypeEnum).

  17. downloadReferenceMaterialsMTOM()

    Downloads reference materials for projects or customers. This method requires a project descriptor or a customer descriptor, which can be specified in the XTMDownloadReferenceMaterialsAPI object. If a project descriptor is specified, then the method will return all reference materials assigned to the project and the reference materials for the customer assigned to this project. In the case of specifying a customer descriptor, the method will only return reference materials for the customer. The files are returned as MTOM or BASE64, depending on the chosen web service. Files are packed as a zip file.

  18. downloadReferenceMaterialsURL()

    Downloads reference materials for projects or customers. This method requires a project descriptor or a customer descriptor, which can be specified in the XTMDownloadReferenceMaterialsAPI object. If a project descriptor is specified, then the method will return all reference materials assigned to the project and the reference materials for the customer assigned to this project. In the case of specifying a customer descriptor, the method will only return reference materials for the customer. This method returns the URLs to the files.

  19. uploadXliffURL()

    Uploads a list of XLIFF files for the given job and step descriptors. Auto-populate in additional options will set default values. This method returns the file descriptors that should be used in the method described in point 3.

  20. uploadXliffMTOM()

    Uploads a list of XLIFF files for the given job and step descriptors using MTOM or BASE64, depending on the chosen web service. Auto-populate in additional options will set default values. This method returns the file descriptors, which should be used in the method described in point 3.

  21. checkUploadXliffCompletion()

    Checks if XLIFF files are uploaded. This method requires a list of file descriptors and returns the status for each XLIFF file (XTM_UPLOAD_XLIFF_COMPLETION_STATUS)

GENERATED_FILE_TYPE – possible file types that can be generated:

Table 36. : GENERATED_FILE_TYPE – possible file types that can be generated

Option

Description

TARGET

Target file.

XLIFF

XLIFF file.

QA_REPORT

QA Report.

HTML

HTML in WYSIWYG format if possible.

HTML_TABLE

HTML containing a table.

PDF

PDF in WYSIWYG format if possible.

PDF_TABLE

PDF containing a table.

TIPP

TIPP file.

HTML_EXTENDED_TABLE

Extended HTML table.

PDF_EXTENDED_TABLE

Extended PDF table.

TARGET_COLOURED_BY_MATCH_RATE

Target colour-coded by match rate.

TAGET_COLOURED_BY_XLIFF_DOC_STATUS

Target colour-coded by the status.

HTML_COLOURED

HTML colour-coded according to the stylesheet.

PDF_COLOURED

PDF colour-coded according to the stylesheet.

XLIFF_DOC

XLIFF:doc file.

LQA_REPORT

LQA report.

LQA_EXTENDED_TABLE_REPORT

LQA report containing a detailed list of the LQA errors.

TARGET_PSEUDO

Pseudo target file.

PDF_COLOURED_BY_XLIFF_DOC_STATUS

PDF colour-coded by the XLIFF:doc status.

PDF_COLOURED_BY_MATCH_RATE

PDF colour-coded by the match rate.


XTM_JOB_FILE_COMPLETION_STATUS – possible job file completion statuses:

Table 37. : XTM_JOB_FILE_COMPLETION_STATUS – possible job file completion statuses

Option

Description

IN_PROGRESS

The file is still being generated.

FINISHED

The file has been generated.

ERROR

The file could not be generated.


GENERATED_PROJECT_FILE_TYPE – possible project file types which can be generated:

Table 38. : GENERATED_PROJECT_FILE_TYPE – possible project file types which can be generated

Option

Description

TIPP

TIPP file.

LQA_REPORT

LQA report.

LQA_EXTENDED_TABLE_REPORT

LQA report containing a detailed list of the LQA errors.

MULTI_EXCEL

Multi-lingual Excel.

PDF

PDF file.

PDF_COLOURED_BY_MATCH_RATE

PDF colour-coded by the match rate.

PDF_COLOURED_BY_XLIFF_DOC_STATUS

PDF colour-coded by the XLIFF:doc status.


XTM_PROJECT_FILE_COMPLETION_STATUS – possible project file completion statuses:

Table 39. : XTM_PROJECT_FILE_COMPLETION_STATUS – possible project file completion statuses

Option

Description

IN_PROGRESS

The file is still generating.

FINISHED

The file has been generated.

ERROR

The file could not be generated.


XTM_UPLOAD_PROJECT_FILE_TYPE – possible project file types to upload:

Table 40. : XTM_UPLOAD_PROJECT_FILE_TYPE – possible project file types to upload

Option

Description

TIPP

TIPP.

PREVIEW_FILES

A ZIP archive containing preview files.

SEGMENT_ID_FILES

A ZIP archive containing images relating to segment IDs.


XTM_UPLOAD_XLIFF_COMPLETION_STATUS – possible XLIFF completion statuses:

Table 41. : XTM_UPLOAD_XLIFF_COMPLETION_STATUS – possible XLIFF completion statuses

Option

Description

IN_PROGRESS

XLIFF is still uploading.

FINISHED

XLIFF upload is completed successfully.

ERROR

XLIFF upload could not be completed.

NOT_EXIST

The given XLIFF does not exist.