{"openapi":"3.0.1","info":{"title":"XTM REST API","description":"# Introduction\n\nXTM Cloud has SOAP and REST APIs that are public-facing.\nThe XTM functionality covered by the two APIs is different. This document describes the\nREST API methods. You can find more information about the SOAP API at https://xtm.cloud/soap-api/.\n\nThe API methods described in this document mostly return HTTP code with body content in JSON format. When the response format is different,\nit is clearly indicated in the description. Obligatory fields are marked as Required.\n\nFor support with the REST API, please visit https://xtm-cloud.atlassian.net/servicedesk/customer/portals.\n\nREST API method responses include custom headers - `xtm-trace-id` and `xtm-span-id` -\nwhich help track user requests throughout the XTM system. Including these headers in Support requests facilitates query analysis.\n","version":"25.2","x-logo":{"url":"https://xtm.cloud/wp-content/themes/xtm/svg/logo.svg","backgroundColor":"#fafafa"}},"servers":[{"url":"/project-manager-api-rest"}],"security":[{"OAuth2-Password":[]}],"tags":[{"name":"Concordance","description":"This section contains methods that relate to concordance."},{"name":"Customer files","description":"This section contains methods that relate to customer files."},{"name":"User workflow steps","description":"This section contains methods that relate to user workflow steps."},{"name":"Project files","description":"This section contains methods that relate to project files."},{"name":"User subject matters","description":"This section contains methods that relate to user subject matters."},{"name":"Terminology import","description":"This section contains methods that relate to importing terminology data."},{"name":"Customer","description":"This section contains methods that relate to customers."},{"name":"Project bundles","description":"This section contains methods that relate to bundles in projects."},{"name":"User","description":"This section contains methods that relate to users."},{"name":"Project custom fields","description":"This section contains methods that relate to project custom fields. For a broader approach to custom fields, visit the custom fields section."},{"name":"Project links","description":"This section contains methods that relate to project links."},{"name":"Workflow","description":"This section contains methods that relate to workflows. For a project-related approach, visit the project workflows section."},{"name":"Project workflows","description":"This section contains methods that relate to project workflows. For a broader approach to workflow, visit the workflow section."},{"name":"External user","description":"This section contains methods that relate to external users."},{"name":"Custom field","description":"This section contains methods that relate to custom fields. For a project-related approach, visit the project custom fields section."},{"name":"Project templates","description":"This section contains methods that relate to project templates."},{"name":"Project jobs","description":"This section contains methods that relate to project jobs."},{"name":"Project costs","description":"This section contains methods that relate to project costs."},{"name":"Project activity","description":"This section contains methods that relate to project activity."},{"name":"User language combinations","description":"This section contains methods that relate to user language combinations."},{"name":"Project LQA","description":"This section contains methods that relate to project LQA."},{"name":"System","description":"This section contains methods that relate to system data."},{"name":"User access rights","description":"This section contains methods that relate to user access rights."},{"name":"LSP rate cards","description":"This section contains methods that relate to LSP rate cards"},{"name":"Terminology penalty profiles","description":"This section contains methods that relate to terminology penalty profiles."},{"name":"Translation memory import","description":"This section contains methods that relate to importing translation memory data."},{"name":"Project states","description":"This section contains methods that relate to project states."},{"name":"User rate cards","description":"This section contains methods that relate to user rate cards."},{"name":"Tag groups","description":"This section contains methods that relate to tag groups."},{"name":"Terminology export","description":"This section contains methods that relate to exporting terminology data."},{"name":"Tag","description":"This section contains methods that relate to tags."},{"name":"XTM Basic","description":"Access tokens are generated from user credentials. Token authentication occurs when an API request is received by XTM. Tokens grant permanent access."},{"name":"Translation memory penalty profiles","description":"This section contains methods that relate to translation memory penalty profiles."},{"name":"Project analytics","description":"This section contains methods that relate to projects analytics."},{"name":"Project","description":"This section contains methods that relate to projects."},{"name":"Roles","description":"This section contains methods that relate to roles. Roles reflect the naming and functionality of the application GUI."},{"name":"Translation memory export","description":"This section contains methods that relate to exporting translation memory data."},{"name":"Project callbacks","description":"This section contains methods that relate to project callbacks."},{"name":"Terminology","description":"This section contains methods that relate to terminology."},{"name":"Subject matter","description":"This section contains methods that relate to subject matters."},{"name":"Practice online","description":"Try out the XTM REST API using a dedicated online tool that will help you create REST API requests correctly. All you have to do is enter the details from your existing XTM account in the required fields. The tool will send real requests that will be processed on your XTM account.\n\n [Click here to get started](https://api-examples.xtm-intl.com/)"},{"name":"Definitions","description":"**Project**: Processing one or more files from one source language to one or more target languages.\n\n**Job**: Process one file in the source language to transform it into one target language.\n\n**Step**: Workflows are composed of steps. The available default steps are: translate, correct, review, approve TM and LQA.\n\n**Bundle**: The source text segments can split into sections which are called bundles. Bundles can be allocated to different Linguists.\n\n**Task**: Processing a bundle in one step is a task.\n\n
Version | Date | Change |
---|
\n 25.2 | \n 04/2025 | \n \n\t\t\tNew methods\n\t\t\t\n\t\t\tNew response attributes\n\t\t\t | \n
\n\n 13.10 | \n 12/2024 | \n \n\t\t\tNew methods\n\t\t\t\n\t\t\tNew request params\n\t\t\n\t\t\t- POST /projects
\n\t\t\t\n\t\t\t\t - New request param: customFields (in: formData, type: array of objects)
\n\t\t\t \n\t\t\t- GET /projects/{projectId}/status
\n\t\t\t\n\t\t\t\t - New request param: displayStepNames (in: query, type: string)
\n\t\t\t\t - New request param: stepReferenceNames (in: query, type: string)
\n\t\t\t \n\t\t \n\t\t\tNew response attributes\n\t\t | \n
\n\n 13.9 | \n 11/2024 | \n \n\t\t\tNew methods\n\t\t\t\n\t | \n
\n\n 13.8 | \n 08/2022 | \n \n\t\t\tNew request params\n\t\t\n\t\t\t- GET /projects/{projectId}/files/sources/download
\n\t\t\t\n\t\t\t\t - New request param: folderStructure (in: query, type: string)
\n\t\t\t \n\t\t\t- POST /projects/{projectId}/workflow/assign
\n\t\t\t\n\t\t\t\t - New request param: workflowState (in: query, type: string)
\n\t\t\t \n\t\t\t- POST /projects/multi-create
\n\t\t\t\n\t\t\t\t - New request param: projectsMultiCreationModelAttributeRequest.callbacks.projectLanguageChangedCallbacks (in: formData, type: array of objects)
\n\t\t\t\t - New request param: projectsMultiCreationModelAttributeRequest.callbacks.dueDateChangedCallbacks (in: formData, type: array of objects)
\n\t\t\t\t - New request param: projectsMultiCreationModelAttributeRequest.callbacks.sourceFileUpdatedCallbacks (in: formData, type: array of objects)
\n\t\t\t\t - New request param: projectsMultiCreationModelAttributeRequest.callbacks.projectActivityChangedCallbacks (in: formData, type: array of objects)
\n\t\t\t \n\t\t\t- POST /projects
\n\t\t\t\n\t\t\t\t - New request param: callbacks.projectLanguageChangedCallbacks (in: formData, type: array of objects)
\n\t\t\t\t - New request param: callbacks.dueDateChangedCallbacks (in: formData, type: array of objects)
\n\t\t\t\t - New request param: callbacks.sourceFileUpdatedCallbacks (in: formData, type: array of objects)
\n\t\t\t\t - New request param: callbacks.projectActivityChangedCallbacks (in: formData, type: array of objects)
\n\t\t\t \n\t\t\t- GET /projects/{projectId}/status
\n\t\t\t\n\t\t\t\t - New request param: displayStepNames (in: query, type: string)
\n\t\t\t\t - New request param: stepReferenceNames (in: query, type: string)
\n\t\t\t \n\t\t\t- PUT /projects/{projectId}/due-dates
\n\t\t\t\n\t\t\t\t - New request param: steps[]/displayStepName (in: body, type: string)
\n\t\t\t\t - New request param: steps[]/stepReferenceName (in: body, type: string)
\n\t\t\t\t - New request param: jobs[]/displayStepName (in: body, type: string)
\n\t\t\t\t - New request param: jobs[]/stepReferenceName (in: body, type: string)
\n\t\t\t \n\t\t \n\t\t\tNew response attributes\n\t\t\n\t\t\t- POST /projects/search
\n\t\t\t\n\t\t\t\t - New response attribute: modificationDate (in: body, type: string)
\n\t\t\t \n\t\t\t- GET /projects
\n\t\t\t\n\t\t\t\t - New response attribute: modificationDate (in: body, type: string)
\n\t\t\t \n\t\t\t- GET /projects/{projectId}
\n\t\t\t\n\t\t\t\t - New response attribute: modificationDate (in: body, type: string)
\n\t\t\t \n\t\t\t- GET /projects/{projectId}/status
\n\t\t\t\n\t\t\t\t - New response attribute: jobs[]/steps[]/displayStepName (in: body, type: string)
\n\t\t\t\t - New response attribute: jobs[]/steps[]/stepReferenceName (in: body, type: string)
\n\t\t\t \n\t\t\t- GET /projects/{projectId}/workflows/time-trackings/jobs
\n\t\t\t\n\t\t\t\t - New response attribute: jobs[]/steps[]/displayStepName (in: body, type: string)
\n\t\t\t\t - New response attribute: jobs[]/steps[]/stepReferenceName (in: body, type: string)
\n\t\t\t \n\t\t\t- GET /projects/{projectId}/statistics
\n\t\t\t\n\t\t\t\t - New response attribute: []/userStatistics[]/stepStatistics[]/stepReferenceName (in: body, type: string)
\n\t\t\t \n\t\t \n\t\t\tNew method\n\t\t\t\n\t\t\tChanged request params\n\t\t\n\t\t\tChanged response attributes\n\t\t\n\t\t\t- GET /projects/{projectId}/workflow/assignment
\n\t\t\t\n\t\t\t\t - Changed response attribute: jobs[]/steps/name (in: body, type: string). Returns the step reference name instead of the step name
\n\t\t\t \n\t\t\t- GET /projects/{projectId}/workflow
\n\t\t\t\n\t\t\t\t - Changed response attribute: steps[]/name (in: body, type: string). Returns the step reference name instead of the step name
\n\t\t\t \n\t | \n
\n\n 13.7 | \n 06/2024 | \n \n\t\t\tNew methods\n\t\t\t\n\t | \n
\n\n 13.6 | \n 03/2024 | \n \n\t\t\tNew request params\n\t\t\n\t\t\t- POST /projects
\n\t\t\t\n\t\t\t\t - New request param: callbacks/analysisFinishedCallbacks (in: formData, type: array of objects)
\n\t\t\t\t - New request param: callbacks/jobFinishedCallbacks (in: formData, type: array of objects)
\n\t\t\t\t - New request param: callbacks/invoiceStatusChangedCallbacks (in: formData, type: array of objects)
\n\t\t\t\t - New request param: callbacks/projectAcceptedCallbacks (in: formData, type: array of objects)
\n\t\t\t\t - New request param: callbacks/projectCreatedCallbacks (in: formData, type: array of objects)
\n\t\t\t\t - New request param: callbacks/projectFinishedCallbacks (in: formData, type: array of objects)
\n\t\t\t\t - New request param: callbacks/workflowTransitionCallbacks (in: formData, type: array of objects)
\n\t\t\t\t - New request param: customerSettings (in: formData, type: object)
\n\t\t\t \n\t\t\t- POST /projects/multi-create
\n\t\t\t\n\t\t\t\t - New request param: projectsMultiCreationModelAttributeRequest/callbacks/analysisFinishedCallbacks (in: formData, type: array of objects)
\n\t\t\t\t - New request param: projectsMultiCreationModelAttributeRequest/callbacks/jobFinishedCallbacks (in: formData, type: array of objects)
\n\t\t\t\t - New request param: projectsMultiCreationModelAttributeRequest/callbacks/invoiceStatusChangedCallbacks (in: formData, type: array of objects)
\n\t\t\t\t - New request param: projectsMultiCreationModelAttributeRequest/callbacks/projectAcceptedCallbacks (in: formData, type: array of objects)
\n\t\t\t\t - New request param: projectsMultiCreationModelAttributeRequest/callbacks/projectCreatedCallbacks (in: formData, type: array of objects)
\n\t\t\t\t - New request param: projectsMultiCreationModelAttributeRequest/callbacks/projectFinishedCallbacks (in: formData, type: array of objects)
\n\t\t\t\t - New request param: projectsMultiCreationModelAttributeRequest/callbacks/workflowTransitionCallbacks (in: formData, type: array of objects)
\n\t\t\t \n\t\t\t- PUT /projects/{projectId}
\n\t\t\t\n\t\t\t\t - New request param: customerSettings (in: body, type: object)
\n\t\t\t \n\t\t\t- PATCH /projects/{projectId}
\n\t\t\t\n\t\t\t\t - New request param: customerSettings (in: body, type: object)
\n\t\t\t \n\t\t\t- GET /projects/{projectId}/status
\n\t\t\t\n\t\t\t\t - New request param: bundleIds (in: query, type: array of integers)
\n\t\t\t\t - New enum value BUNDLES has been added for param fetchLevel (in: query, type: string)
\n\t\t\t \n \n\t\t\tNew response attributes\n\t\t\n\t\t\t- GET /projects/{projectId}/status
\n\t\t\t\n\t\t\t\t - New response attribute: finishDate (in: body, type: string)
\n\t\t\t\t - New response attribute: jobs/finishDate (in: body, type: string)
\n\t\t\t\t - New response attribute: jobs/steps/finishDate (in: body, type: string)
\n\t\t\t\t - New response attribute: jobs/steps/bundles (in: body, type: array of objects)
\n\t\t\t \n\t\t \n\t | \n
\n\n 13.5 | \n 01/2024 | \n \n\t\t\tNew authorization method\n\t\t\t\n\t\t\n\t\t\tNew request params\n \n - PATCH /projects/{projectId}
\n \n\t\t - New request param: terminology/tagIds (in: body, type: array of integer)
\n \n \n\t\t - New request param: terminology/penaltyProfileId (in: body, type: integer)
\n \n \n\t\t - New request param: translationMemory/tagIds (in: body, type: array of integer)
\n \n \n\t\t - New request param: translationMemory/penaltyProfileId (in: body, type: integer)
\n \n \n\t\t - New request param: translationMemory/languageVariantsPenaltyProfileId (in: body, type: integer)
\n \n \n \n - PUT /projects/{projectId}
\n \n\t\t - New request param: terminology/tagIds (in: body, type: array of integer)
\n \n \n\t\t - New request param: terminology/penaltyProfileId (in: body, type: integer)
\n \n \n\t\t - New request param: translationMemory/tagIds (in: body, type: array of integer)
\n \n \n\t\t - New request param: translationMemory/penaltyProfileId (in: body, type: integer)
\n \n \n\t\t - New request param: translationMemory/languageVariantsPenaltyProfileId (in: body, type: integer)
\n \n \n \n - POST /projects
\n \n\t\t - New request param: terminology/tagIds (in: body, type: array of integer)
\n \n \n\t\t - New request param: terminology/penaltyProfileId (in: body, type: integer)
\n \n \n\t\t - New request param: translationMemory/tagIds (in: body, type: array of integer)
\n \n \n\t\t - New request param: translationMemory/penaltyProfileId (in: body, type: integer)
\n \n \n\t\t - New request param: translationMemory/languageVariantsPenaltyProfileId (in: body, type: integer)
\n \n \n \n \n\t\t\tNew methods\n\t\t\t\n\t\t\n\t\t\t\n\t\t\tImproved organisation of documentation\n\t\t\t\n\t\t\n\t | \n
\n\n 13.3 | \n 06/2023 | \n \n\t\t\tNew request params\n\t\t\n\t\t\tNew methods\n\t\t\t\n\t\t\n\t\t\tNew response\n\t\t\t\n\t\t\t- POST /projects
\n\t\t\t\t- Resource not found. 404 HTTP code
\t\t\t \n\t\t\n\t | \n
\n\n 13.2 | \n 10/2022 | \n \n\t\t\tNew request params\n\t\t\n\t\t\tNew response attributes\n\t\t\n\t\t\tNew methods\n\t\t\t\n\t\t\n\t | \n
\n\n 13.1 | \n 04/2022 | \n \n\t\t\tNew request params\n\t\t\n\t\t\t- POST /projects
\n\t\t\t\n\t\t\t\t - New request param: segmentLockingType (in: formData, type: string)
\n\t\t\t\t - New request param: newSourceDueDate (in: formData, type: string)
\n\t\t\t\t - New request param: workflowDueDate (in: formData, type: string)
\n\t\t\t\t - New request param: workflowStartDate (in: formData, type: string)
\n\t\t\t \n\t\t\t- POST /projects/multi-create
\n\t\t\t\n\t\t\t\t - New request param: segmentLockingType (in: formData, type: string)
\n\t\t\t\t - New request param: workflowDueDate (in: formData, type: string)
\n\t\t\t\t - New request param: workflowStartDate (in: formData, type: string)
\n\t\t\t \n\t\t\t- PUT /projects/{projectId}/due-dates
\n\t\t\t\n\t\t\t\t - New request param: workflowDueDate (in: body, type: string)
\n\t\t\t\t - New request param: workflowStartDate (in: body, type: string)
\n\t\t\t \n\t\t\t- PUT /projects/{projectId}
\n\t\t\t\n\t\t\t\t - New request param: segmentLockingType (in: body, type: string)
\n\t\t\t \n\t\t\t- PATCH /projects/{projectId}
\n\t\t\t\n\t\t\t\t - New request param: segmentLockingType (in: body, type: string)
\n\t\t\t \n\t\t \n\t\t\tNew response attributes\n\t\t\n\t\t\t- GET /projects/{projectId}
\n\t\t\t\n\t\t\t\t - New response attributes: segmentLockingType (in: body, type: string)
\n\t\t\t \n\t\t\t- GET /projects/{projectId}/costs/{costId}
\n\t\t\t\n\t\t\t\t - New response attributes: userCosts[]/priceWithDistance (in: body, type: number)
\n\t\t\t\t - New response attributes: userCosts[]/targetLanguageCosts[]/priceWithDistance (in: body, type: number)
\n\t\t\t \n\t\t \n\t | \n
\n\n 13.0 | \n 03/2022 | \n \n\t\t\tNew request params\n\t\t\n\t\t\t- POST /projects
\n\t\t\t\n\t\t\t\t - New request param: callbacks.invoiceStatusChangedCallback (in: formData, type: string)
\n\t\t\t\t - New request param: callbacks.projectAcceptedCallback (in: formData, type: string)
\n\t\t\t\t - New request param: callbacks.projectCreatedCallback (in: formData, type: string)
\n\t\t\t\t - New request param: newSourceType (in: formData, type: string)
\n\t\t\t \n\t\t\t- POST /projects/multi-create
\n\t\t\t\n\t\t\t\t - New request param: callbacks.invoiceStatusChangedCallback (in: formData, type: string)
\n\t\t\t\t - New request param: callbacks.projectAcceptedCallback (in: formData, type: string)
\n\t\t\t\t - New request param: callbacks.projectCreatedCallback (in: formData, type: string)
\n\t\t\t \n\t\t\t- POST /projects/{projectId}/links/editor
\n\t\t\t\n\t\t\t\t - New request param: generalSettings/taskManageType (in: body, type: string)
\n\t\t\t \n\t\t \n\t\t\tNew response attributes\n\t\t\n\t\t\t- GET /projects/{projectId}
\n\t\t\t\n\t\t\t\t - New response attributes: invoiceStatus (in: body, type: string)
\n\t\t\t\t - New response attributes: newSourceType (in: body, type: string)
\n\t\t\t \n\t\t\t- GET /projects/{projectId}/workflow/assignment
\n\t\t\t\n\t\t\t\t - New response attributes: []/jobs[]/steps[]/bundles[]/acceptanceStatus (in: body, type: string)
\n\t\t\t \n\t\t \n\t\t\tNew methods\n\t\t\t\n\t\t\tRequest param hidden\n\t\t\t\n\t\t\t- PUT /projects/{projectId}
\n\t\t\t\n\t\t\t\t - Request param hidden: templateId (in: body, type: integer)
\n\t\t\t\t Optional param has been hidden from docs as adding it does not update the project as might be expected.\n\t\t\t\t Param can still be added as it is used by a client to change the XTM template name on the Project list.\n\t\t\t \n\t\t \n\t | \n
\n\n 12.9 | \n 11/2021 | \n \n\t\t\tNew request params\n\t\t\n\t\t\t- GET /projects
\n\t\t\t\n\t\t\t\t - New request param: externalIds (in: query, type: array)
\n\t\t\t \n\t\t\t- POST /projects/search
\n\t\t\t\n\t\t\t\t - New request param: externalIds (in: body, type: integer[])
\n\t\t\t \n\t\t\t\t- GET /projects/{projectId}/statistics
\n\t\t\t\n\t\t\t\t - New request param: fetchType (in: query, type: string)
\n\t\t\t \t\n\t\t\t\t- GET /projects/{projectId}/status
\n\t\t\t\n\t\t\t\t - New request param: jobIds (in: query, type: integer[])
\n\t\t\t\t - New request param: stepNames (in: query, type: string[])
\n\t\t\t\t - New request param: targetLanguages (in: query, type: string[])
\n\t\t\t \n\t\t\t\t- PUT /projects/{projectId}/due-dates
\n\t\t\t\n\t\t\t\t - New request param: jobs[]/stepName (in: body, type: string)
\n\t\t\t \n\t\t \n\t\t\tNew response attributes\n\t\t\n\t\t\t- GET /projects
\n\t\t\t\n\t\t\t\t - New response attributes: []/externalId (in: body, type: integer)
\n\t\t\t \n\t\t\t- POST /projects/search
\n\t\t\t\n\t\t\t\t - New response attributes: []/externalId (in: body, type: integer)
\n\t\t\t \n\t\t\t- GET /projects/{projectId}/status
\n\t\t\t\n\t\t\t\t - New response attributes: dueDate (in: body, type: string)
\n\t\t\t\t - New response attributes: jobs[]/dueDate (in: body, type: string)
\n\t\t\t\t - New response attributes: jobs[]/steps[]/dueDate (in: body, type: string)
\n\t\t\t \n\t\t\t- GET /projects/templates/{templateId}
\n\t\t\t\n\t\t\t\t - New response attributes: newSourceLanguage (in: body, type: string)
\n\t\t\t\t - New response attributes: newSourceType (in: body, type: string)
\n\t\t\t\t - New response attributes: newSourceWorkflowId (in: body, type: string)
\n\t\t\t \n\t\t\t- GET /projects/{projectId}
\n\t\t\t\n\t\t\t\t - New response attributes: customerName (in: body, type: string)
\n\t\t\t \n\t\t\t- GET /projects/{projectId}/statistics
\n\t\t\t\n\t\t\t\t - New response attributes: []/usersStatistics[]/stepsStatistics[]/jobsStatistics[]/creationDate (in: body, type: string)
\n\t\t\t\t - New response attributes: []/usersStatistics[]/stepsStatistics[]/jobsStatistics[]/lastCompletionDate (in: body, type: string)
\n\t\t\t\t - New response attributes: []/usersStatistics[]/stepsStatistics[]/jobsStatistics[]/machineTranslationEDCWords (in: body, type: Object)
\n\t\t\t\t - New response attributes: []/usersStatistics[]/stepsStatistics[]/jobsStatistics[]/sourceStatistics/noMatchingCharacters (in: body, type: integer)
\n\t\t\t\t - New response attributes: []/usersStatistics[]/stepsStatistics[]/jobsStatistics[]/sourceStatistics/noMatchingSegments (in: body, type: integer)
\n\t\t\t\t - New response attributes: []/usersStatistics[]/stepsStatistics[]/jobsStatistics[]/sourceStatistics/noMatchingWhitespaces (in: body, type: integer)
\n\t\t\t\t - New response attributes: []/usersStatistics[]/stepsStatistics[]/jobsStatistics[]/sourceStatistics/noMatchingWords (in: body, type: integer)
\n\t\t\t\t - New response attributes: []/usersStatistics[]/stepsStatistics[]/jobsStatistics[]/sourceStatistics/totalSegments (in: body, type: integer)
\n\t\t\t\t - New response attributes: []/usersStatistics[]/stepsStatistics[]/jobsStatistics[]/targetStatistics/noMatchingCharacters (in: body, type: integer)
\n\t\t\t\t - New response attributes: []/usersStatistics[]/stepsStatistics[]/jobsStatistics[]/targetStatistics/noMatchingSegments (in: body, type: integer)
\n\t\t\t\t - New response attributes: []/usersStatistics[]/stepsStatistics[]/jobsStatistics[]/targetStatistics/noMatchingWhitespaces (in: body, type: integer)
\n\t\t\t\t - New response attributes: []/usersStatistics[]/stepsStatistics[]/jobsStatistics[]/targetStatistics/noMatchingWords (in: body, type: integer)
\n\t\t\t\t - New response attributes: []/usersStatistics[]/stepsStatistics[]/jobsStatistics[]/targetStatistics/totalSegments (in: body, type: integer)
\n\t\t\t \n\t\t \n\t\t\tNew response\n\t\t\t\n\t\t\n\t\t\tNew callbacks authentication type OAuth2\n\t | \n
\n\n 12.8 | \n 06/2021 | \n \n \n\t\t\t- New request params
\n\t\t\n\t\t\t- GET /projects
\n\t\t\t\n\t\t\t\t - New request param: name (in: query, type: string)
\n\t\t\t \n\t\t\t- New methods
\n\t\t\t\n\t\t \n\t\t \n\t | \n
\n\n 12.7 | \n 03/2021 | \n \n \n\t\t\t- New request params
\n\t\t\n\t\t\t- GET /projects
\n\t\t\t\n\t\t\t\t - New request param: activity (in: body, type: array)
\n\t\t\t \n\t\t\t- POST /projects
\n\t\t\t\n\t\t\t\t - New request param: filterTemplateId (in: formData, type: string)
\n\t\t\t\t - New request param: translationFiles[0].metadata (in: formData, type: string)
\n\t\t\t\t - New request param: translationFiles[0].metadataType (in: formData, type: string)
\n\t\t\t\t - New request param: translationFiles[0].targetLanguagesV2[0].code (in: formData, type: string)
\n\t\t\t\t - New request param: translationFiles[0].targetLanguagesV2[0].workflowId (in: formData, type: integer)
\n\t\t\t \n\t\t\t\t- POST /projects/multi-create
\n\t\t\t\n\t\t\t\t - New request param: filterTemplateId (in: formData, type: string)
\n\t\t\t\t - New request param: translationFiles[0].metadata (in: formData, type: string)
\n\t\t\t\t - New request param: translationFiles[0].metadataType (in: formData, type: string)
\n\t\t\t\t - New request param: translationFiles[0].targetLanguagesV2[0].code (in: formData, type: string)
\n\t\t\t\t - New request param: translationFiles[0].targetLanguagesV2[0].workflowId (in: formData, type: integer)
\n\t\t\t \t\n\t\t\t\t- POST /projects/{projectId}/files/generate
\n\t\t\t\n\t\t\t\t - New request param: extendedTableOptions/excelOptions/includeEditDistanceScore (in: body, type: string)
\n\t\t\t\t - New request param: extendedTableOptions/htmlOptions/includeEditDistanceScore (in: body, type: string)
\n\t\t\t\t - New request param: extendedTableOptions/pdfOptions/includeEditDistanceScore (in: body, type: string)
\n\t\t\t \n\t\t\t\t- POST /projects/{projectId}/files/translations/upload
\n\t\t\t\n\t\t\t\t - New request param: translationFiles[0].targetLanguagesV2[0].code (in: formData, type: string)
\n\t\t\t\t - New request param: translationFiles[0].targetLanguagesV2[0].workflowId (in: formData, type: integer)
\n\t\t\t \n\t\t\t\t- POST /projects/{projectId}/target-languages
\n\t\t\t\n\t\t\t\t - New request param: jobsCreationType (in: body, type: string)
\n\t\t\t \n\t\t \n\t\t\t- New response attributes
\n\t\t\n\t\t\t- GET /projects/templates/{templateId}
\n\t\t\t\n\t\t\t\t - New response attributes: filterTemplateId (in: body, type: string)
\n\t\t\t \n\t\t\t- GET /projects/{projectId}/costs/{costId}
\n\t\t\t\n\t\t\t\t - New response attributes: userCosts[]/extraCosts/additionalCost (in: body, type: number)
\n\t\t\t\t - New response attributes: userCosts[]/extraCosts/additionalCostPercent (in: body, type: number)
\n\t\t\t\t - New response attributes: userCosts[]/extraCosts/fixedPricesSum (in: body, type: number)
\n\t\t\t\t - New response attributes: userCosts[]/extraCosts/managementFeeSum (in: body, type: number)
\n\t\t\t\t - New response attributes: userCosts[]/extraCosts/minimalPricePadding (in: body, type: number)
\n\t\t\t\t - New response attributes: userCosts[]/extraCosts/nonAnalyzableCost (in: body, type: number)
\n\t\t\t\t - New response attributes: userCosts[]/extraCosts/nonAnalyzableCostsPercent (in: body, type: number)
\n\t\t\t \n\t\t \n\t\t\t- New methods
\n\t\t\t\n\t\t\t- Removed methods
\n\t\t\t\n\t\t\t- GET /projects/analysis-templates
\n\t\t\t \n\t\t \n\t | \n
\n\n 12.6 | \n 12/2020 | \n \n \n\t\t\t- New request params
\n\t\t\n\t\t\t- POST /projects
\n\t\t\t\n\t\t\t\t - New request param: groupFilesDitaLevel (in: formData, type: integer)
\n\t\t\t\t - New request param: groupFilesType (in: formData, type: string)
\n\t\t\t\t - New request param: overrideFields.overrideFromRequest (in: formData, type: array)
\n\t\t\t\t - New request param: translationFiles[0].tagIds (in: formData, type: array)
\n\t\t\t\t - New request param: translationFiles[0].translationType (in: formData, type: string)
\n\t\t\t\t - New request param: translationFiles[0].workflowId (in: formData, type: integer)
\n\t\t\t \n\t\t\t- POST /projects/multi-create
\n\t\t\t\n\t\t\t\t - New request param: groupFilesDitaLevel (in: formData, type: integer)
\n\t\t\t\t - New request param: groupFilesType (in: formData, type: string)
\n\t\t\t\t - New request param: translationFiles[0].tagIds (in: formData, type: array)
\n\t\t\t\t - New request param: translationFiles[0].translationType (in: formData, type: string)
\n\t\t\t\t - New request param: translationFiles[0].workflowId (in: formData, type: integer)
\n\t\t\t \n\t\t\t\t- POST /projects/{projectId}/files/generate
\n\t\t\t\n\t\t\t\t - New request param: extendedTableOptions/excelOptions/extendedReportType (in: body, type: string)
\n\t\t\t\t - New request param: extendedTableOptions/excelOptions/languagesType (in: body, type: string)
\n\t\t\t\t - New request param: extendedTableOptions/htmlOptions/extendedReportType (in: body, type: string)
\n\t\t\t\t - New request param: extendedTableOptions/htmlOptions/languagesType (in: body, type: string)
\n\t\t\t\t - New request param: extendedTableOptions/pdfOptions/extendedReportType (in: body, type: string)
\n\t\t\t\t - New request param: extendedTableOptions/pdfOptions/languagesType (in: body, type: string)
\n\t\t\t \t\n\t\t\t\t- POST /projects/{projectId}/files/upload
\n\t\t\t\n\t\t\t\t - New request param: files[0].tagIds (in: formData, type: array)
\n\t\t\t\t - New request param: files[0].translationType (in: formData, type: string)
\n\t\t\t\t - New request param: files[0].workflowId (in: formData, type: integer)
\n\t\t\t \n\t\t\t\t- POST /projects/{projectId}/links/editor
\n\t\t\t\n\t\t\t\t - New request param: userSettings/overrideFields (in: body, type: string)
\n\t\t\t\t - New request param: userSettings/terminologyRights (in: body, type: string)
\n\t\t\t \n\t\t \n\t\t\t- New methods
\n\t\t\t\n\t\t \n\t | \n
\n\n 12.5 | \n 10/2020 | \n \n \n\t\t\t - New responses
\n\t\t\t \n\t\t\t - GET /lsps/{lspId}/rate-cards
\n\t\t\t \n\t\t\t\t - New response attribute: rateCards[]/minChargePerLanguage (in: body, type: number)
\n\t\t\t\t - New response attribute: rateCards[]/rates[]/minChargePerLanguage (in: body, type: number)
\n\t\t\t \n\t\t\t - GET /projects/{projectId}/status
\n\t\t\t \n\t\t\t\t - New response attribute: subcontracted (in: body, type: boolean)
\n\t\t\t \n\t\t\t - GET /users/{userId}/rate-cards
\n\t\t\t \n\t\t\t\t - New response attribute: rateCards[]/minChargePerLanguage (in: body, type: number)
\n\t\t\t\t - New response attribute: rateCards[]/rates[]/minChargePerLanguage (in: body, type: number)
\n\t\t\t \n\t\t\t \n\t\t\t- New request params
\n\t\t\n\t\t\t- POST /projects
\n\t\t\t\n\t\t\t\t - New request param: projectManagerType (in: formData, type: string)
\n\t\t\t\t - New request param: translationFiles[0].targetLanguages (in: formData, type: array)
\n\t\t\t \n\t\t\t- POST /projects/multi-create
\n\t\t\t\n\t\t\t\t - New request param: translationFiles[0].sourceLanguage (in: formData, type: string)
\n\t\t\t\t - New request param: translationFiles[0].targetLanguages (in: formData, type: array)
\n\t\t\t \n\t\t\t\t- POST /projects/{projectId}/costs/{costId}/pos
\n\t\t\t\n\t\t\t\t - New request param: sendEmail (in: body, type: string)
\n\t\t\t \t\n\t\t\t\t- POST /projects/{projectId}/files/upload
\n\t\t\t\n\t\t\t\t - New request param: files[0].targetLanguages (in: formData, type: array)
\n\t\t\t \n\t\t \n\t\t\t- New methods
\n\t\t\t\n\t\t \n\t | \n
\n\n 12.4 | \n 07/2020 | \n \n \n\t\t\t - New responses
\n\t\t\t \n\t\t\t - GET /projects/{projectId}/costs/{costId}
\n\t\t\t \n\t\t\t\t - New response attribute: errors[]/parameters (in: body, type: key-value)
\n\t\t\t\t - New response attribute: errors[]/type (in: body, type: string)
\n\t\t\t\t - New response attribute: warnings[]/parameters (in: body, type: key-value)
\n\t\t\t\t - New response attribute: warnings[]/type (in: body, type: string)
\n\t\t\t \n\t\t\t \n\t\t\t- New request params
\n\t\t\n\t\t\t- GET /projects
\n\t\t\t\n\t\t\t\t - New request param: modifiedDateFrom (in: query, type: string)
\n\t\t\t\t - New request param: modifiedDateTo (in: query, type: string)
\n\t\t\t\t - New request param: sort (in: query, type: string)
\n\t\t\t \n\t\t\t- POST /projects
\n\t\t\t\n\t\t\t\t - New request param: externalCreatorId (in: formData, type: integer)
\n\t\t\t \n\t\t\t- POST /projects/multi-create
\n\t\t\t\n\t\t\t\t - New request param: externalCreatorId (in: formData, type: integer)
\n\t\t\t \n\t\t\t\t- POST /projects/{projectId}/custom-fields
\n\t\t\t\n\t\t\t\t - New request param: []/value/dateValue (in: body, type: string)
\n\t\t\t \n\t\t\t\t- POST /projects/{projectId}/files/upload
\n\t\t\t\n\t\t\t\t - New request param: reanalyseProject (in: formData, type: string)
\n\t\t\t \n\t\t\t\t- POST /projects/{projectId}/links/editor
\n\t\t\t\n\t\t\t\t - New request param: hiddenFeatures/comments (in: body, type: string)
\n\t\t\t\t - New request param: hiddenFeatures/concordance (in: body, type: string)
\n\t\t\t\t - New request param: hiddenFeatures/history (in: body, type: string)
\n\t\t\t\t - New request param: hiddenFeatures/inlineTagsTab (in: body, type: string)
\n\t\t\t\t - New request param: hiddenFeatures/matches (in: body, type: string)
\n\t\t\t\t - New request param: hiddenFeatures/otherXliffDocStatuses (in: body, type: string)
\n\t\t\t\t - New request param: hiddenFeatures/previewExcelExtendedTable (in: body, type: string)
\n\t\t\t\t - New request param: hiddenFeatures/previewExcelMultilingual (in: body, type: string)
\n\t\t\t\t - New request param: hiddenFeatures/previewHtml (in: body, type: string)
\n\t\t\t\t - New request param: hiddenFeatures/previewHtmlInteractive (in: body, type: string)
\n\t\t\t\t - New request param: hiddenFeatures/previewHtmlSourceTargetTable (in: body, type: string)
\n\t\t\t\t - New request param: hiddenFeatures/previewPdf (in: body, type: string)
\n\t\t\t\t - New request param: hiddenFeatures/previewPdfInteractive (in: body, type: string)
\n\t\t\t\t - New request param: hiddenFeatures/previewPdfSourceTargetTable (in: body, type: string)
\n\t\t\t\t - New request param: hiddenFeatures/terminologyTab (in: body, type: string)
\n\t\t\t \n\t\t\t\t- PUT /projects/{projectId}
\n\t\t\t\n\t\t\t\t - New request param: updateFieldsType (in: query, type: string)
\n\t\t\t \n\t\t\t\t- PUT /projects/{projectId}/due-dates
\n\t\t\t\n\t\t\t\t - New request param: newSourceDueDate (in: query, type: string)
\n\t\t\t \n\t\t \n\t\t\t- New methods
\n\t\t\t\n\t\t \n\t | \n
\n\n 12.3 | \n 04/2020 | \n \n \n\t - New responses
\n\t \n\t - GET /projects/{projectId}/costs/{costId}
\n\t \n\t\t - New response attribute: errors[]/parameters (in: body, type: key-value)
\n\t\t - New response attribute: errors[]/type (in: body, type: string)
\n\t\t - New response attribute: warnings[]/parameters (in: body, type: key-value)
\n\t\t - New response attribute: warnings[]/type (in: body, type: string)
\n\t \n\t \n - New request params
\n \n - POST /projects/{projectId}/files/generate
\n \n\t\t - New request param: extendedTableOptions/excelOptions/... (in: body, type: string)
\n\t\t - New request param: extendedTableOptions/htmlOptions/... (in: body, type: string)
\n\t\t - New request param: extendedTableOptions/pdfOptions/... (in: body, type: string)
\n \n \n - New methods
\n \n \n | \n
\n 12.2 | \n 01/2020 | \n \n \n - New responses
\n \n - GET /customers
\n \n - New response attribute: address/fax (in: body, type: string)
\n - New response attribute: address/msn (in: body, type: string)
\n\t\t - New response attribute: address/phone2 (in: body, type: string)
\n\t\t - New response attribute: address/skype (in: body, type: string)
\n \n - GET projects/{projectId}
\n \n - New response attribute: name (in: body, type: string)
\n \n - GET /users
\n \n - New response attribute: /address/fax (in: body, type: string)
\n\t\t - New response attribute: /address/msn (in: body, type: string)
\n\t\t - New response attribute: /address/phone2 (in: body, type: string)
\n\t\t - New response attribute: /address/skype (in: body, type: string)
\n \n \n\t- New request params
\n\t\n\t\t- New methods
\n\t\t\n\t\t \n\t | \n
\n\t12.1 | \n\t10/2019 | \n\t\n\t\t\n\t\t\t- New responses
\n\t\t\t\n\t\t\t\t- GET /lsps/{lspId}/rate-cards
\n\t\t\t\t\n\t\t\t\t\t- New response attribute: rateCards (in: body, type: array)
\n\t\t\t\t\t\n\t\t\t\t\t\t- New response attribute: rateCards[]/halvedManagementFee (in: body, type: boolean))
\n\t\t\t\t\t\t- New response attribute: rateCards[]/minManagementFee (in: body, type: number))
\n\t\t\t\t\t \n\t\t\t\t \n\t\t\t\t- GET /users/{userId}/rate-cards
\n\t\t\t\t\n\t\t\t\t\t- New response attribute: rateCards (in: body, type: array)
\n\t\t\t\t\t\n\t\t\t\t\t\t- New response attribute: rateCards[]/halvedManagementFee (in: body, type: boolean))
\n\t\t\t\t\t\t- New response attribute: rateCards[]/minManagementFee (in: body, type: number))
\n\t\t\t\t\t \n\t\t\t\t \n\t\t\t\t- GET /users
\n\t\t\t\t\n\t\t\t\t\t- New response attribute: userType (in: body, type: string)
\n\t\t\t\t \n\t\t\t \n\t\t- New methods
\n\t\t\n\t\t \n\t | \n
\n\t12.0 | \n\t07/2019 | \n\t\n\t\t\n\t\t\t- New request params
\n\t\t\t\n\t\t\t\t- GET /projects
\n\t\t\t\t\n\t\t\t\t\t- New request param: createdDateFrom (in: query, type: string)
\n\t\t\t\t\t- New request param: createdDateTo (in: query, type: string)
\n\t\t\t\t\t- New request param: finishedDateFrom (in: query, type: string)
\n\t\t\t\t\t- New request param: finishedDateTo (in: query, type: string)
\n\t\t\t\t \n\t\t\t \n\t\t\t- New responses
\n\t\t\t\n\t\t\t\t- GET /lsps/{lspId}/rate-cards
\n\t\t\t\t\n\t\t\t\t\t- New response attribute: rateCards (in: body, type: array)
\n\t\t\t\t\t\n\t\t\t\t\t\t- New response attribute: []/languageCombinationsType (in: body, type: string))
\n\t\t\t\t\t\t- New response attribute: []/[]/subjectMattersType (in: body, type: string))
\n\t\t\t\t\t \n\t\t\t\t \n\t\t\t\t- GET /users/{userId}/rate-cards
\n\t\t\t\t\n\t\t\t\t\t- New response attribute: rateCards (in: body, type: array)
\n\t\t\t\t\t\n\t\t\t\t\t\t- New response attribute: []/languageCombinationsType (in: body, type: string))
\n\t\t\t\t\t\t- New response attribute: []/[]/subjectMattersType (in: body, type: string))
\n\t\t\t\t\t \n\t\t\t\t \n\t\t\t\t- GET projects/{projectId}
\n\t\t\t\t\n\t\t\t\t\t- New response attribute: finishDate (in: body, type: string)
\n\t\t\t\t \n\t\t\t \n\t\t\t- New methods
\n\t\t\t\n\t\t \n\t | \n
\n11.7 | \t05/2019 | \n\t\n\t\t\n\t\t\t- New request params
\n\t\t\t\n\t\t\t\t- GET /projects/{projectId}/files/download
\n\t\t\t\t\n\t\t\t\t\t- New request param: fileNameFilter (in: query, type: string)
\n\t\t\t\t\t- New request param: fileNameFilterType (in: query, type: string)
\n\t\t\t\t \n\t\t\t\t- GET /workflows/steps
\n\t\t\t\t\n\t\t\t\t\t- New request param: activity (in: query, type: string)
\n\t\t\t\t \n\t\t\t \n\t\t\t- New methods
\n\t\t\t\n\t\t \n\t | \n
\n11.6 | \t02/2019 | \n\t\n\t\t\n\t\t\t- New responses
\n\t\t\t\n\t\t\t\t- GET /workflows
\n\t\t\t\t\n\t\t\t\t\t- New response attribute: steps (in: body, type: array)
\n\t\t\t\t\t\n\t\t\t\t\t\t- New response attribute: id (in: body, type: integer)
\n\t\t\t\t\t\t- New response attribute: name (in: body, type: string)
\n\t\t\t\t\t\t- New response attribute: orderNumber (in: body, type: integer)
\n\t\t\t\t\t \n\t\t\t\t \n\t\t\t \n\t\t\t- New methods
\n\t\t\t\n\t\t \n\t | \n
11.5 | 12/2018 | |
11.2 | 06/2018 | - New methods
- New parameters
- GET /customers
- New request parameter: fetchAddress (in: query, type: string)
- New response attribute: address/address1 (in: body, type: string)
- New response attribute: address/address2 (in: body, type: string)
- New response attribute: address/city (in: body, type: string)
- New response attribute: address/country (in: body, type: string)
- New response attribute: address/email (in: body, type: string)
- New response attribute: address/mobilePhone (in: body, type: string)
- New response attribute: address/phone (in: body, type: string)
- New response attribute: address/postCode (in: body, type: string)
- New response attribute: address/state (in: body, type: string)
- New response attribute: address/vatNumber (in: body, type: string)
- New response attribute: address/website (in: body, type: string)
- GET /projects
- New response attribute: activity (in: body, type: string)
- PUT /projects/{projectId}/due-dates
- New request parameter: jobs[]/dueDate (in: body, type: string)
- New request parameter: jobs[]/id (in: body, type: integer)
- New request parameter: projectDueDate (in: body, type: string)
- New request parameter: targetLanguages[]/dueDate (in: body, type: string)
- New request parameter: targetLanguages[]/languageCode (in: body, type: string)
|
11.1 | 04/2018 | - New methods
- New responses
- Removed responses
|
11.0 | 03/2018 | - New method: PUT /projects/{projectId}/due-dates
- New fields in: GET /projects:
- New response headers in: GET /projects:
- xtm-page
- xtm-page-items-count
- xtm-page-size
- xtm-total-items-count
- New fields in: POST /projects:
- referenceFiles[0].file
- referenceFiles[0].name
- New field: targetLanguage in RSJobAnalysisResponse
- New field: targetLanguage in RSJobStatusResponse
- New field: sourceLanguage in RSProjectAnalysisResponse
- New field: sourceLanguage in RSProjectStatusResponse
- New responses:
- RSProjectDueDateUpdateRequest
- RSProjectDueDateUpdateResponse
- RSProjectStepDueDateRequest
|
10.7 | 01/2018 | - New methods
- New parameters
- POST /projects
- New request parameter: analysisTemplateId (in: formData, type: string)
- New request parameter: newSourceWorkflowId (in: formData, type: integer)
- New request parameter: workflowId (in: formData, type: integer)
|
"},{"name":"OAuth 2.0","description":"\n## Password flow (Resource Owner Password Credentials) ## \n\nThis is the one of the simplest OAuth 2.0 authorization flows, suitable for integrations used by single user accounts. User credentials are stored in the client application instead of redirecting users to the XTM website.\nIn this approach you need to take three steps:\n\n\n