Files
In the SOAP API, you can use these file-related methods:
You can generate, check the status, download, and upload files:
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 generatingXLIFFfiles, there is a possibility to enable or disable populating the target with the source (flag in additionalXLIFFoptions).This method also enables the generation of a
TIPPfile 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.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.downloadJobFileURL()
Downloads all files that have been generated. This method requires a list of file descriptors and returns URLs to files.
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
zipfile.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.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.downloadProjectFileURL()
Downloads all files that have been generated. This method requires a list of file descriptors and returns URLs to the files.
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
zipor aTIPPfile.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 aTIPPfile, the target language will be read from the manifest.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 aTIPPfile, the target language will be read from the manifest.updateReferenceFilesURL()
Uploads new reference materials to the project or customer. This method requires the
XTMUpdateReferenceFilesURLAPIobject, 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.updateReferenceFilesMTOM()
Uploads new reference materials to the project or customer using MTOM or BASE64, depending on the chosen webservice. This method requires the
XTMUpdateReferenceFilesMTOMAPIobject, 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.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
zipfile. There is an additional option to download only the latest version of any uploaded target files (XTMDownloadJobTypeEnum).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).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
zipfile. There is an additional option to download only the latest version of any uploaded target file (XTMDownloadJobTypeEnum).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).downloadReferenceMaterialsMTOM()
Downloads reference materials for projects or customers. This method requires a project descriptor or a customer descriptor, which can be specified in the
XTMDownloadReferenceMaterialsAPIobject. 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 azipfile.downloadReferenceMaterialsURL()
Downloads reference materials for projects or customers. This method requires a project descriptor or a customer descriptor, which can be specified in the
XTMDownloadReferenceMaterialsAPIobject. 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.uploadXliffURL()
Uploads a list of
XLIFFfiles 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.uploadXliffMTOM()
Uploads a list of
XLIFFfiles 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.checkUploadXliffCompletion()
Checks if
XLIFFfiles are uploaded. This method requires a list of file descriptors and returns the status for eachXLIFFfile (XTM_UPLOAD_XLIFF_COMPLETION_STATUS)
GENERATED_FILE_TYPE – possible file types that can be generated:
Option | Description |
|---|---|
| Target file. |
| XLIFF file. |
| QA Report. |
| HTML in WYSIWYG format if possible. |
| HTML containing a table. |
| PDF in WYSIWYG format if possible. |
| PDF containing a table. |
| TIPP file. |
| Extended HTML table. |
| Extended PDF table. |
| Target colour-coded by match rate. |
| Target colour-coded by the status. |
| HTML colour-coded according to the stylesheet. |
| PDF colour-coded according to the stylesheet. |
| XLIFF:doc file. |
| LQA report. |
| LQA report containing a detailed list of the LQA errors. |
| Pseudo target file. |
| PDF colour-coded by the XLIFF:doc status. |
| PDF colour-coded by the match rate. |
XTM_JOB_FILE_COMPLETION_STATUS – possible job file completion statuses:
Option | Description |
|---|---|
| The file is still being generated. |
| The file has been generated. |
| The file could not be generated. |
GENERATED_PROJECT_FILE_TYPE – possible project file types which can be generated:
Option | Description |
|---|---|
| TIPP file. |
| LQA report. |
| LQA report containing a detailed list of the LQA errors. |
| Multi-lingual Excel. |
| PDF file. |
| PDF colour-coded by the match rate. |
| PDF colour-coded by the XLIFF:doc status. |
XTM_PROJECT_FILE_COMPLETION_STATUS – possible project file completion statuses:
Option | Description |
|---|---|
| The file is still generating. |
| The file has been generated. |
| The file could not be generated. |
XTM_UPLOAD_PROJECT_FILE_TYPE – possible project file types to upload:
Option | Description |
|---|---|
| TIPP. |
| A ZIP archive containing preview files. |
| A ZIP archive containing images relating to segment IDs. |
XTM_UPLOAD_XLIFF_COMPLETION_STATUS – possible XLIFF completion statuses:
Option | Description |
|---|---|
| XLIFF is still uploading. |
| XLIFF upload is completed successfully. |
| XLIFF upload could not be completed. |
| The given XLIFF does not exist. |