# Phrase Developer Hub: English API Reference TMS V1 API Documentation Job ## Job - [Get Job Preview Package assets](https://developers.phrase.com/en/api/tms/v1/job/get-job-preview-package-assets.md): URLs for this API are provided in html skeleton (preview) part of mxliff. Assets are served with a sandbox Content-Security-Policy so they never execute on the application origin. - [Download handover file(s)](https://developers.phrase.com/en/api/tms/v1/job/download-handover-files.md): For downloading multiple files as ZIP file provide multiple IDs in query parameters. * For example `?jobUid={id1}&jobUid={id2}` * When no files matched given IDs error 404 is returned, otherwise ZIP file will include those that were found - [Upload handover file](https://developers.phrase.com/en/api/tms/v1/job/upload-handover-file.md): For following jobs the handover file is not supported: * Continuous jobs * Jobs from connectors * Split jobs * Multilingual jobs - [Delete handover file](https://developers.phrase.com/en/api/tms/v1/job/delete-handover-file.md) - [List jobs](https://developers.phrase.com/en/api/tms/v1/job/list-jobs.md) - [Create job](https://developers.phrase.com/en/api/tms/v1/job/create-job.md): Upload a source file to create a translation job in the specified project. An API call to create a [job](https://support.phrase.com/hc/en-us/articles/5709686763420-Jobs-TMS-) within a specified [project](https://support.phrase.com/hc/en-us/articles/5709748435484-Projects-TMS-). The source file can b… - [Edit jobs (batch)](https://developers.phrase.com/en/api/tms/v1/job/edit-jobs-batch.md): Returns only jobs which were updated by the batch operation. - [Delete job (batch)](https://developers.phrase.com/en/api/tms/v1/job/delete-job-batch.md) - [Download bilingual file (also used to bulk-edit translations, confirm, or lock/unlock segments via re-import)](https://developers.phrase.com/en/api/tms/v1/job/download-bilingual-file-also-used-to-bulk-edit-translations-confirm-or-lockunlock-segments-via-re-import.md): This API call generates a bilingual file in the chosen format by merging all submitted jobs together. Note that all submitted jobs must belong to the same project; it's not feasible to merge jobs from multiple projects. - [Clone jobs](https://developers.phrase.com/en/api/tms/v1/job/clone-jobs.md): Clones the selected jobs into new target languages, optionally applying per-workflow-step settings: linguist/vendor assignment per target language, due date and notify-linguist (email template + reminder interval) per workflow step. The project must have more than… - [Compare jobs on workflow levels](https://developers.phrase.com/en/api/tms/v1/job/compare-jobs-on-workflow-levels.md) - [Create job from connector asynchronous download task](https://developers.phrase.com/en/api/tms/v1/job/create-job-from-connector-asynchronous-download-task.md): Creates the job in project specified by path param projectUid. Source file is defined by downloadTaskId parameter. That is value of finished download async task [Connector - Download file (async)](../connector/download-file-async). - [Copy Source to Target](https://developers.phrase.com/en/api/tms/v1/job/copy-source-to-target.md) - [Trigger quality evaluation for selected job parts](https://developers.phrase.com/en/api/tms/v1/job/trigger-quality-evaluation-for-selected-job-parts.md): Runs quality evaluation asynchronously. Evaluation is based on the Content Group linked to the project — link one first via POST /api2/v1/projects/{projectUid}/contentGroup. Returns 422 Unprocessable Entity if the project has no Content Group linked. Job parts must belong to the same project, workfl… - [Extract candidate terms](https://developers.phrase.com/en/api/tms/v1/job/extract-candidate-terms.md): Suggests candidate terms from the content of the given jobs, based on frequency and other heuristics. Returns an XLSX file listing the suggested terms. - [Notify assigned users](https://developers.phrase.com/en/api/tms/v1/job/notify-assigned-users.md) - [Pseudo-translate job](https://developers.phrase.com/en/api/tms/v1/job/pseudo-translate-job.md) - [Search jobs in project](https://developers.phrase.com/en/api/tms/v1/job/search-jobs-in-project.md): This API call can be used to verify (search) which of the provided jobs belong to the specified project. For the jobs that belong to the project, a subset of [Get job](../job/get-job) information will be returned and the rest of the jobs will be filtered out. - [Get segments count](https://developers.phrase.com/en/api/tms/v1/job/get-segments-count.md): This API provides the current count of segments (progress data). - [Update source](https://developers.phrase.com/en/api/tms/v1/job/update-source.md): Reimports an already-imported job by replacing its source file with a new one. This is a job-level operation, distinct from the organization-level import settings templates managed via the import settings API. - [Update target](https://developers.phrase.com/en/api/tms/v1/job/update-target.md): API update target file for specified job - [Delete all translations](https://developers.phrase.com/en/api/tms/v1/job/delete-all-translations.md) - [Get Web Editor URL](https://developers.phrase.com/en/api/tms/v1/job/get-web-editor-url.md): Possible warning codes are: - `NOT_ACCEPTED_BY_LINGUIST` - Job is not accepted by linguist - `NOT_ASSIGNED_TO_LINGUIST` - Job is not assigned to linguist - `PDF` - One of requested jobs is PDF - `PREVIOUS_WORKFLOW_NOT_COMPLETED` - Previous workflow step is not completed - `PREVIOUS_WORKFLO… - [Get custom fields](https://developers.phrase.com/en/api/tms/v1/job/get-custom-fields.md) - [Edit custom fields (batch)](https://developers.phrase.com/en/api/tms/v1/job/edit-custom-fields-batch.md) - [Create custom field instances](https://developers.phrase.com/en/api/tms/v1/job/create-custom-field-instances.md) - [Get custom field](https://developers.phrase.com/en/api/tms/v1/job/get-custom-field.md) - [Edit custom field](https://developers.phrase.com/en/api/tms/v1/job/edit-custom-field.md) - [Delete custom field](https://developers.phrase.com/en/api/tms/v1/job/delete-custom-field.md) - [Get job](https://developers.phrase.com/en/api/tms/v1/job/get-job.md): This API call provides specific information about a [job](https://support.phrase.com/hc/en-us/articles/5709686763420-Jobs-TMS-) within a project. - [Edit job (assign provider, due date, status)](https://developers.phrase.com/en/api/tms/v1/job/edit-job-assign-provider-due-date-status.md): This API call facilitates job editing using a PUT method. - [Patch job (assign provider, due date, status)](https://developers.phrase.com/en/api/tms/v1/job/patch-job-assign-provider-due-date-status.md): This API call allows for partial updates to jobs, modifying specific fields without overwriting those not included in the update request. - [Copy Source to Target job](https://developers.phrase.com/en/api/tms/v1/job/copy-source-to-target-job.md) - [Get import settings for job](https://developers.phrase.com/en/api/tms/v1/job/get-import-settings-for-job.md): Returns the job-level import settings currently applied to this already-imported job. This is distinct from the organization-level import settings templates managed via the import settings API (`/api2/v1/importSettings`). Use together with the edit job import settings endpoint to change these settin… - [Edit job import settings](https://developers.phrase.com/en/api/tms/v1/job/edit-job-import-settings.md): Updates the job-level import settings for this already-imported job so that a subsequent reimport of the job's source file uses the new settings. This is distinct from the organization-level import settings templates managed via the import settings API (`/api2/v1/importSettings`). Replaces the entir… - [Download original file](https://developers.phrase.com/en/api/tms/v1/job/download-original-file.md): The response Content-Type is always application/octet-stream regardless of the original file format. The filename in Content-Disposition preserves the original name and may have no extension if the job was imported without one. - [Download preview file](https://developers.phrase.com/en/api/tms/v1/job/download-preview-file.md) - [Download preview file](https://developers.phrase.com/en/api/tms/v1/job/download-preview-file-1.md): Takes bilingual file (.mxliff only) as argument. If not passed, data will be taken from database - [Pseudo-translates job](https://developers.phrase.com/en/api/tms/v1/job/pseudo-translates-job.md) - [Get segments](https://developers.phrase.com/en/api/tms/v1/job/get-segments.md) - [Edit job status](https://developers.phrase.com/en/api/tms/v1/job/edit-job-status.md): Changes the status of a single job. - [Split job](https://developers.phrase.com/en/api/tms/v1/job/split-job.md): Splits job by one of the following methods: * **After specific segments** - fill in `segmentOrdinals` * **Into X parts** - fill in `partCount` * **Into parts with specific size** - fill in `partSize`. partSize represents segment count in each part. * **Into parts with specific word count** - fill in… - [Get status changes](https://developers.phrase.com/en/api/tms/v1/job/get-status-changes.md) - [Download target file](https://developers.phrase.com/en/api/tms/v1/job/download-target-file.md): This call will return target file with translation. This means even for other jobs that were created via 'split jobs' etc. - [Get target file's warnings](https://developers.phrase.com/en/api/tms/v1/job/get-target-files-warnings.md): This call will return target file's warnings. This means even for other jobs that were created via 'split jobs' etc. - [Wildcard search job's translation memories](https://developers.phrase.com/en/api/tms/v1/job/wildcard-search-jobs-translation-memories.md): Deprecated. Use endpoint Wildcard search job's translation memories (v3) instead. - [Get translation resources](https://developers.phrase.com/en/api/tms/v1/job/get-translation-resources.md) - [Get job's workflowStep](https://developers.phrase.com/en/api/tms/v1/job/get-jobs-workflowstep.md) ## OpenAPI Specs - [phrase-tms-v1](/openapi/phrase-tms-v1.json)