Phraseconnector v1 | OneTeg Documentation

Version 1

Connector Overview: This page documents all 414 actions for the Phraseconnector v1.

Additional Workflow Step (3)

POST createAWFStep

/api2/v1/additionalWorkflowSteps

Create additional workflow step

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Name`	Name of the additional workflow step

DELETE deleteAWFStep

/api2/v1/additionalWorkflowSteps/{id}

Delete additional workflow step

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	N/A
`Response Type`	N/A

GET listAWFSteps

/api2/v1/additionalWorkflowSteps

List additional workflow steps

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 50, default 50
`Name`	Name of the additional workflow step to filter
`Response Type`	N/A

Analysis (14)

PUT analyses-batchEdit-v2

/api2/v2/analyses/bulk

If no netRateScheme is provided in request, then netRateScheme associated with provider will
be used if it exists, otherwise it will remain the same as it was.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Name`	N/A

DELETE bulkDeleteAnalyses

/api2/v1/analyses/bulk

Delete analyses (batch)

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Content-type`	N/A
`Response Type`	N/A

POST createAnalyseAsyncV2

/api2/v2/analyses

Returns created analyses - batching analyses by number of segments (api.segment.count.approximation, default 100000), in case request contains more segments than maximum (api.segment.max.count, default 300000), returns 400 bad request.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (17)

Option Name	Description
`Type`	default: PreAnalyse
`Includefuzzyrepetitions`	Default: true
`Separatefuzzyrepetitions`	Default: false
`Includeconfirmedsegments`	Default: true
`Includenumbers`	Default: true
`Includelockedsegments`	Default: true
`Countsourceunits`	Default: true
`Includetransmemory`	Default: true. Works only for type=PreAnalyse.
`Includenontranslatables`	Default: false. Works only for type=PreAnalyse.
`Includemachinetranslationmatches`	Default: false. Works only for type=PreAnalyse.
`Transmemorypostediting`	Default: false. Works only for type=PostAnalyse.
`Nontranslatablepostediting`	Default: false. Works only for type=PostAnalyse.
`Machinetranslatepostediting`	Default: false. Works only for type=PostAnalyse.
`Name`	N/A
`Compareworkflowlevel`	Required for type=Compare
`Useprojectanalysissettings`	Default: false. Use default project settings. Will be overwritten with setting sent in the API call.
`Callbackurl`	N/A

POST createAnalysesForLangs

/api2/v1/analyses/byLanguages

Create analyses by languages

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (17)

Option Name	Description
`Type`	default: PreAnalyse
`Includefuzzyrepetitions`	Default: true
`Separatefuzzyrepetitions`	Default: false
`Includeconfirmedsegments`	Default: true
`Includenumbers`	Default: true
`Includelockedsegments`	Default: true
`Countsourceunits`	Default: true
`Includetransmemory`	Default: true. Works only for type=PreAnalyse.
`Includenontranslatables`	Default: false. Works only for type=PreAnalyse.
`Includemachinetranslationmatches`	Default: false. Works only for type=PreAnalyse.
`Transmemorypostediting`	Default: false. Works only for type=PostAnalyse.
`Nontranslatablepostediting`	Default: false. Works only for type=PostAnalyse.
`Machinetranslatepostediting`	Default: false. Works only for type=PostAnalyse.
`Name`	N/A
`Compareworkflowlevel`	Required for type=Compare
`Useprojectanalysissettings`	Default: false. Use default project settings. Will be overwritten with setting sent in the API call.
`Callbackurl`	N/A

POST createAnalysesForProviders

/api2/v1/analyses/byProviders

Create analyses by providers

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (17)

Option Name	Description
`Type`	default: PreAnalyse
`Includefuzzyrepetitions`	Default: true
`Separatefuzzyrepetitions`	Default: false
`Includeconfirmedsegments`	Default: true
`Includenumbers`	Default: true
`Includelockedsegments`	Default: true
`Countsourceunits`	Default: true
`Includetransmemory`	Default: true. Works only for type=PreAnalyse.
`Includenontranslatables`	Default: false. Works only for type=PreAnalyse.
`Includemachinetranslationmatches`	Default: false. Works only for type=PreAnalyse.
`Transmemorypostediting`	Default: false. Works only for type=PostAnalyse.
`Nontranslatablepostediting`	Default: false. Works only for type=PostAnalyse.
`Machinetranslatepostediting`	Default: false. Works only for type=PostAnalyse.
`Name`	N/A
`Compareworkflowlevel`	Required for type=Compare
`Useprojectanalysissettings`	Default: false. Use default project settings. Will be overwritten with setting sent in the API call.
`Callbackurl`	N/A

DELETE delete

/api2/v1/analyses/{analyseUid}

Delete analysis

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Analyseuid`	N/A
`Purge`	N/A
`Response Type`	N/A

GET downloadAnalyse

/api2/v1/analyses/{analyseUid}/download

Download analysis

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Analyseuid`	N/A
`Format`	N/A
`Response Type`	N/A

PUT editAnalysis

/api2/v2/analyses/{analyseUid}

If no netRateScheme is provided in
request, then netRateScheme associated with provider will be used if it exists, otherwise it will remain the same
as it was.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Analyseuid`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Name`	N/A

GET getAnalyseLanguagePart

/api2/v1/analyses/{analyseUid}/analyseLanguageParts/{analyseLanguagePartId}

Returns analysis language pair

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Analyseuid`	N/A
`Analyselanguagepartid`	N/A
`Response Type`	N/A

GET getAnalyseV3

/api2/v3/analyses/{analyseUid}

This API endpoint retrieves analysis results, encompassing basic information about the analysis, such as its name,
assigned provider,
net rate scheme,
Analysis settings settings and a subset of
Get project information for the project the analysis belongs to.

The analysis results consist of each analyzed language, presented as an item within the analyseLanguageParts array.
Each of these items contains details regarding the analyzed
jobs,
translation memories
and the resultant data.

The analysis results are divided into two sections:

data stores the raw numbers,
discountedData recalculates the raw numbers using the selected net rate scheme.

Similar to the UI, both raw and net numbers are categorized based on their source into TM, MT, and NT categories,
including repetitions where applicable. These categories are then further subdivided based on the match score.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Analyseuid`	N/A
`Response Type`	N/A

GET getJobPartAnalyse

/api2/v1/analyses/{analyseUid}/jobs/{jobUid}

Returns job's analyse

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Analyseuid`	N/A
`Jobuid`	N/A
`Response Type`	N/A

GET listJobParts

/api2/v1/analyses/{analyseUid}/analyseLanguageParts/{analyseLanguagePartId}/jobs

Returns list of job's analyses

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Analyseuid`	N/A
`Analyselanguagepartid`	N/A
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 50, default 50
`Response Type`	N/A

GET listPartAnalyseV3

/api2/v3/projects/{projectUid}/jobs/{jobUid}/analyses

List analyses

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Jobuid`	N/A
`Pagenumber`	N/A
`Pagesize`	N/A
`Response Type`	N/A

POST recalculate

/api2/v1/analyses/recalculate

Recalculate analysis

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Callbackurl`	N/A

Async Request (3)

GET getAsyncRequest

/api2/v1/async/{asyncRequestId}

This API call will return information about the specified
asynchronous request.

Apart from basic information about the asynchronous operation such as who created it and for what action, the response
will contain a subset of Get project information.

The response contains an asyncResponse field which will remain null until the async request has finished processing.
If any errors occurred during processing of the request, this field will contain such errors or warnings.

_Note_: It is important to keep track of the number of pending asynchronous requests as these are subject to [Phrase
limits](https://support.phrase.com/hc/en-us/articles/5784117234972-Phrase-TMS-Limits#api-limits-async-requests-0-2).

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Asyncrequestid`	N/A
`Response Type`	N/A

GET getCurrentLimitStatus

/api2/v1/async/status

Get current limits

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

GET listPendingRequests

/api2/v1/async

API call to return a list of pending asynchronous requests.

Some operations within Phrase TMS are performed
asynchronously
and their response only serves as an acknowledgement of receipt, not an actual completion of such request.
Since Phrase imposes restrictions on the number of pending asynchronous
requests within an organization, this API call provides the means to check the number of such
pending requests.

When processing a large number of asynchronous operations, Phrase recommends periodically checking this list of
pending requests in order to not receive an error code during the actual processing of the requests.

_Note: Only actions triggered via the APIs are counted towards this limit, the same type of operation carried out via the
UI is not taken into account. This means that even with 200 pending requests, users can still create jobs via the UI._

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`All`	Pending requests for organization instead of current user. Only for ADMIN.
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 50, default 50
`Response Type`	N/A

Authentication (12)

POST login

/api2/v1/auth/login

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Username`	N/A
`Password`	N/A
`Code`	Required only for 2-factor authentication

POST loginByAppleWithCode

/api2/v1/auth/loginWithApple/code

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Native`	For sign in with code from native device
`Response Type`	N/A

Options (1)

Option Name	Description
`Codeorrefreshtoken`	N/A

POST loginByAppleWithRefreshToken

/api2/v1/auth/loginWithApple/refreshToken

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Codeorrefreshtoken`	N/A

POST loginByGoogle

/api2/v1/auth/loginWithGoogle

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Idtoken`	N/A

POST loginOther

/api2/v1/auth/loginOther

Available only for admin

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Username`	N/A

POST loginOtherV3

/api2/v3/auth/loginOther

Available only for admin

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Useruid`	When not filled, default user of identity will be logged in
`Username`	N/A

POST loginToSession

/api2/v1/auth/loginToSession

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Username`	N/A
`Password`	N/A
`Rememberme`	N/A

POST loginToSession_2

/api2/v3/auth/loginToSession

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (6)

Option Name	Description
`Useruid`	When not filled, default user of identity will be logged in
`Username`	N/A
`Password`	N/A
`Rememberme`	N/A
`Twofactorcode`	N/A
`Captchacode`	N/A

POST loginV3

/api2/v3/auth/login

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Useruid`	When not filled, default user of identity will be logged in
`Username`	N/A
`Password`	N/A
`Code`	Required only for 2-factor authentication

POST logout

/api2/v1/auth/logout

Logout

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Content-type`	N/A
`Token`	N/A
`Authorization`	N/A
`Response Type`	N/A

GET refreshAppleToken

/api2/v1/auth/refreshAppleToken

refresh apple token

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Content-type`	N/A
`Token`	N/A
`Response Type`	N/A

GET whoAmI

/api2/v1/auth/whoAmI

Who am I

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Content-type`	N/A
`Response Type`	N/A

Bilingual File (4)

POST compareBilingualFile

/api2/v1/bilingualFiles/compare

Compares bilingual file to job state. Returns list of compared segments.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Workflowlevel`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

POST convertBilingualFile

/api2/v1/bilingualFiles/convert

Convert bilingual file

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`From`	N/A
`To`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

POST getPreviewFile

/api2/v1/bilingualFiles/preview

Supports mxliff format

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

POST uploadBilingualFileV2

/api2/v2/bilingualFiles

Returns updated job parts and projects

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Savetotransmemory`	N/A
`Setcompleted`	N/A
`Response Type`	N/A

Business Unit (5)

POST createBusinessUnit

/api2/v1/businessUnits

Create business unit

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Name`	N/A

DELETE deleteBusinessUnit

/api2/v1/businessUnits/{businessUnitUid}

Delete business unit

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Businessunituid`	N/A
`Response Type`	N/A

GET getBusinessUnit

/api2/v1/businessUnits/{businessUnitUid}

Get business unit

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Businessunituid`	N/A
`Response Type`	N/A

GET listBusinessUnits

/api2/v1/businessUnits

List business units

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Name`	Unique name of the business unit
`Createdby`	Uid of user
`Sort`	N/A
`Order`	N/A
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 50, default 50
`Response Type`	N/A

PUT updateBusinessUnit

/api2/v1/businessUnits/{businessUnitUid}

Edit business unit

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Businessunituid`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Name`	N/A

Client (5)

POST createClient

/api2/v1/clients

Create client

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Name`	N/A
`Externalid`	N/A
`Note`	N/A
`Displaynoteinproject`	Default: false

DELETE deleteClient

/api2/v1/clients/{clientUid}

Delete client

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Clientuid`	N/A
`Response Type`	N/A

GET getClient

/api2/v1/clients/{clientUid}

Get client

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Clientuid`	N/A
`Response Type`	N/A

GET listClients

/api2/v1/clients

List clients

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Name`	Unique name of the Client
`Createdby`	Uid of user
`Sort`	N/A
`Order`	N/A
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 50, default 50
`Response Type`	N/A

PUT updateClient

/api2/v1/clients/{clientUid}

Edit client

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Clientuid`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Name`	N/A
`Externalid`	N/A
`Note`	N/A
`Displaynoteinproject`	Default: false

Connector (9)

GET getConnector

/api2/v1/connectors/{connectorId}

Get a connector

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Connectorid`	N/A
`Response Type`	N/A

GET getConnectorList

/api2/v1/connectors

List connectors

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Type`	N/A
`Response Type`	N/A

GET getFileForConnector

/api2/v1/connectors/{connectorId}/folders/{folder}/files/{file}

Download a file from a subfolder of the selected connector

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Connectorid`	N/A
`Folder`	N/A
`File`	N/A
`Response Type`	N/A

POST getFileForConnectorV2

/api2/v2/connectors/{connectorId}/folders/{folder}/files/{file}

Create an asynchronous request to download a file from a (sub)folder of the selected connector.
After a callback with successful response is received, prepared file can be downloaded by Download prepared file
or Create job from connector asynchronous download task.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Connectorid`	N/A
`Folder`	N/A
`File`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Sourcelang`	N/A
`Targetlang`	N/A
`Callbackurl`	N/A

GET getFolder

/api2/v1/connectors/{connectorId}/folders/{folder}

List files in a subfolder of the selected connector

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Connectorid`	N/A
`Folder`	N/A
`Projectuid`	N/A
`Filetype`	N/A
`Sort`	N/A
`Direction`	N/A
`Response Type`	N/A

GET getPreparedFile

/api2/v2/connectors/{connectorId}/folders/{folder}/files/{file}/tasks/{taskId}

Download the file by referencing successfully finished async download request Connector - Download file (async).

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Connectorid`	N/A
`Folder`	N/A
`File`	N/A
`Taskid`	N/A
`Response Type`	N/A

GET getRootFolder

/api2/v1/connectors/{connectorId}/folders

List files in a root folder of the selected connector

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Connectorid`	N/A
`Projectuid`	N/A
`Filetype`	N/A
`Sort`	N/A
`Direction`	N/A
`Response Type`	N/A

POST uploadFile

/api2/v1/connectors/{connectorId}/folders/{folder}

Upload a file to a subfolder of the selected connector

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Connectorid`	N/A
`Folder`	N/A
`Content-type`	N/A
`Response Type`	N/A

Options (5)

Option Name	Description
`File`	Translated file to upload
`Sourcefilename`	Name or ID of the original file
`Subfoldername`	Optional subfolder to upload the file to
`Mimetype`	Mime type of the file to upload
`Commitmessage`	Commit message for upload to Git, etc.

POST uploadFileV2

/api2/v2/connectors/{connectorId}/folders/{folder}/files/{fileName}/upload

Upload a file to a subfolder of the selected connector

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Connectorid`	N/A
`Folder`	N/A
`Filename`	N/A
`Memsource`	N/A
`Content-type`	N/A
`Mimetype`	Mime type of the file to upload
`Response Type`	N/A

Options (1)

Option Name	Description
`File`	Translated file to upload

Conversations (18)

POST addLQACommentV2

/api2/v2/jobs/{jobUid}/conversations/lqas/{conversationId}/comments

Add LQA comment

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobuid`	N/A
`Conversationid`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Text`	N/A

POST addPlainComment_2

/api2/v3/jobs/{jobUid}/conversations/plains/{conversationId}/comments

Add plain comment

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobuid`	N/A
`Conversationid`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Text`	N/A

POST createLqaConversationV2

/api2/v2/jobs/{jobUid}/conversations/lqas

Create LQA conversation

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobuid`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Lqadescription`	N/A

POST createSegmentTargetConversationV3

/api2/v3/jobs/{jobUid}/conversations/plains

Create plain conversation

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobuid`	N/A
`Response Type`	N/A

DELETE deleteLQAComment

/api2/v1/jobs/{jobUid}/conversations/lqas/{conversationId}/comments/{commentId}

Delete LQA comment

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobuid`	N/A
`Conversationid`	N/A
`Commentid`	N/A
`Response Type`	N/A

DELETE deleteLQAConversation

/api2/v1/jobs/{jobUid}/conversations/lqas/{conversationId}

Delete LQA conversation

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobuid`	N/A
`Conversationid`	N/A
`Response Type`	N/A

DELETE deletePlainComment

/api2/v1/jobs/{jobUid}/conversations/plains/{conversationId}/comments/{commentId}

Delete plain comment

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobuid`	N/A
`Conversationid`	N/A
`Commentid`	N/A
`Response Type`	N/A

DELETE deletePlainConversation

/api2/v1/jobs/{jobUid}/conversations/plains/{conversationId}

Delete plain conversation

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobuid`	N/A
`Conversationid`	N/A
`Response Type`	N/A

POST findConversations

/api2/v1/jobs/conversations/find

Find all conversation

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Since`	N/A
`Includedeleted`	Default: false

GET getLQAConversation

/api2/v1/jobs/{jobUid}/conversations/lqas/{conversationId}

Get LQA conversation

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobuid`	N/A
`Conversationid`	N/A
`Response Type`	N/A

GET getPlainConversation

/api2/v1/jobs/{jobUid}/conversations/plains/{conversationId}

Get plain conversation

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobuid`	N/A
`Conversationid`	N/A
`Response Type`	N/A

GET listAllConversations

/api2/v1/jobs/{jobUid}/conversations

List all conversations

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobuid`	N/A
`Includedeleted`	N/A
`Since`	N/A
`Response Type`	N/A

GET listLQAConversations

/api2/v1/jobs/{jobUid}/conversations/lqas

List LQA conversations

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobuid`	N/A
`Includedeleted`	N/A
`Since`	N/A
`Response Type`	N/A

GET listPlainConversations

/api2/v1/jobs/{jobUid}/conversations/plains

List plain conversations

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobuid`	N/A
`Includedeleted`	N/A
`Since`	N/A
`Response Type`	N/A

PUT updateLQACommentV2

/api2/v2/jobs/{jobUid}/conversations/lqas/{conversationId}/comments/{commentId}

Edit LQA comment

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobuid`	N/A
`Conversationid`	N/A
`Commentid`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Text`	N/A

PUT updateLqaConversationV2

/api2/v2/jobs/{jobUid}/conversations/lqas/{conversationId}

Update LQA conversation

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobuid`	N/A
`Conversationid`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Lqadescription`	N/A
`Status`	N/A

PUT updatePlainCommentV3

/api2/v3/jobs/{jobUid}/conversations/plains/{conversationId}/comments/{commentId}

Edit plain comment

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobuid`	N/A
`Conversationid`	N/A
`Commentid`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Text`	N/A

PUT updatePlainConversation

/api2/v1/jobs/{jobUid}/conversations/plains/{conversationId}

Edit plain conversation

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobuid`	N/A
`Conversationid`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Status`	N/A

Cost Center (5)

POST createCostCenter

/api2/v1/costCenters

Create cost center

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Name`	N/A

DELETE deleteCostCenter

/api2/v1/costCenters/{costCenterUid}

Delete cost center

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Costcenteruid`	N/A
`Response Type`	N/A

GET getCostCenter

/api2/v1/costCenters/{costCenterUid}

Get cost center

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Costcenteruid`	N/A
`Response Type`	N/A

GET listCostCenters

/api2/v1/costCenters

List of cost centers

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Name`	N/A
`Createdby`	Uid of user
`Sort`	N/A
`Order`	N/A
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 50, default 50
`Response Type`	N/A

PUT updateCostCenter

/api2/v1/costCenters/{costCenterUid}

Edit cost center

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Costcenteruid`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Name`	N/A

Custom Fields (4)

POST createCustomField

/api2/v1/customFields

Create custom field

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (6)

Option Name	Description
`Name`	N/A
`Allowedentities`	N/A
`Options`	N/A
`Type`	N/A
`Required`	N/A
`Description`	N/A

GET getCustomField

/api2/v1/customFields/{fieldUid}

Get custom field

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Fielduid`	N/A
`Response Type`	N/A

GET getCustomFieldList

/api2/v1/customFields

Lists custom fields

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 50, default 50
`Name`	Filter by custom field name
`Allowedentities`	Filter by custom field allowed entities
`Types`	Filter by custom field types
`Createdby`	Filter by custom field creators UIDs
`Modifiedby`	Filter by custom field updaters UIDs
`Uids`	Filter by custom field UIDs
`Required`	Filter by custom field required parameter
`Sortfield`	Sort by this field
`Sorttrend`	Sort direction
`Response Type`	N/A

GET getCustomFieldOptionList

/api2/v1/customFields/{fieldUid}/options

Lists options of custom field

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Fielduid`	N/A
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 50, default 50
`Name`	Filter by option name
`Sortfield`	Sort by this field
`Sorttrend`	Sort direction
`Response Type`	N/A

Custom File Type (7)

POST createCustomFileTypes

/api2/v1/customFileTypes

Create custom file type

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Name`	N/A
`Filenamepattern`	N/A
`Type`	N/A

DELETE deleteBatchCustomFileType

/api2/v1/customFileTypes

Delete multiple Custom file type

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Content-type`	N/A
`Response Type`	N/A

DELETE deleteCustomFileType

/api2/v1/customFileTypes/{customFileTypeUid}

Delete Custom file type

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Customfiletypeuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

GET findCustomFileType

/api2/v1/customFileTypes/find

If no matching custom file type is found it returns status 200 and empty body.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Filename`	N/A
`Response Type`	N/A

GET getAllCustomFileType

/api2/v1/customFileTypes

Get All Custom file type

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 50, default 50
`Response Type`	N/A

GET getCustomFileType

/api2/v1/customFileTypes/{customFileTypeUid}

Get Custom file type

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Customfiletypeuid`	N/A
`Response Type`	N/A

PUT updateCustomFileType

/api2/v1/customFileTypes/{customFileTypeUid}

Update Custom file type

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Customfiletypeuid`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Name`	N/A
`Filenamepattern`	N/A
`Type`	N/A

Domain (5)

POST createDomain

/api2/v1/domains

Create domain

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Name`	N/A

DELETE deleteDomain

/api2/v1/domains/{domainUid}

Delete domain

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Domainuid`	N/A
`Response Type`	N/A

GET getDomain

/api2/v1/domains/{domainUid}

Get domain

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Domainuid`	N/A
`Response Type`	N/A

GET listDomains

/api2/v1/domains

List of domains

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Name`	N/A
`Createdby`	Uid of user
`Sort`	N/A
`Order`	N/A
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 50, default 50
`Response Type`	N/A

PUT updateDomain

/api2/v1/domains/{domainUid}

Edit domain

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Domainuid`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Name`	N/A

Email Template (2)

GET getOrgEmailTemplate

/api2/v1/emailTemplates/{templateUid}

Get email template

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Templateuid`	N/A
`Response Type`	N/A

GET listOrgEmailTemplates

/api2/v1/emailTemplates

List email templates

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Type`	N/A
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 50, default 50
`Response Type`	N/A

File (4)

POST createUrlFile

/api2/v1/files

Accepts multipart/form-data, application/octet-stream or application/json.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Content-disposition`	must match pattern ((inline\|attachment); )?filename\*=UTF-8''(.+)
`Response Type`	N/A

Options (5)

Option Name	Description
`Uid`	N/A
`Name`	N/A
`Size`	N/A
`Type`	N/A
`Url`	N/A

DELETE deletesFile

/api2/v1/files/{fileUid}

Delete file

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Fileuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

GET getFileJson

/api2/v1/files/{fileUid}

Get uploaded file as octet-stream or as json based on 'Accept' header

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Fileuid`	N/A
`Response Type`	N/A

GET getFiles

/api2/v1/files

List files

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 50, default 50
`Name`	N/A
`Types`	N/A
`Createdby`	N/A
`Biggerthan`	Size in bytes
`Response Type`	N/A

Glossary (6)

PUT activateGlossary

/api2/v1/glossaries/{glossaryUid}/activate

Activate/Deactivate glossary

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Glossaryuid`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Active`	N/A

POST createGlossary

/api2/v1/glossaries

Create glossary

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Name`	N/A
`Langs`	N/A

DELETE deleteGlossary

/api2/v1/glossaries/{glossaryUid}

Delete glossary

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Glossaryuid`	N/A
`Content-type`	N/A
`Purge`	purge=false - the Glossary can later be restored, 'purge=true - the Glossary is completely deleted and cannot be restored
`Response Type`	N/A

GET getGlossary

/api2/v1/glossaries/{glossaryUid}

Get glossary

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Glossaryuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

GET listGlossaries

/api2/v1/glossaries

List glossaries

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Content-type`	N/A
`Name`	N/A
`Lang`	Language of the glossary
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 50, default 50
`Response Type`	N/A

PUT updateGlossary

/api2/v1/glossaries/{glossaryUid}

Languages can only be added, their removal is not supported

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Glossaryuid`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Name`	N/A
`Langs`	N/A

Import settings (6)

POST createImportSettings

/api2/v1/importSettings

Pre-defined import settings is handy for Create Job.

              See [supported file types](https://wiki.memsource.com/wiki/API_File_Type_List)

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Name`	N/A

DELETE deleteImportSettings

/api2/v1/importSettings/{uid}

Delete import settings

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Uid`	N/A
`Response Type`	N/A

PUT editImportSettings

/api2/v1/importSettings

Edit import settings

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Uid`	N/A
`Name`	N/A

GET getImportSettingsByUid

/api2/v1/importSettings/{uid}

Get import settings

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Uid`	N/A
`Response Type`	N/A

GET getImportSettingsDefault

/api2/v1/importSettings/default

Get organization's default import settings

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

GET listImportSettings

/api2/v1/importSettings

List import settings

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Name`	N/A
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 50, default 50
`Response Type`	N/A

Job (43)

POST comparePart

/api2/v1/projects/{projectUid}/jobs/compare

Compare jobs on workflow levels

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Atworkflowlevel`	N/A
`Withworkflowlevel`	N/A
`Response Type`	N/A

PUT completedFileV2

/api2/v2/projects/{projectUid}/jobs/{jobUid}/targetFile

This call initiates an asynchronous request to generate and download the target file containing translations.
This request covers jobs created via actions like 'split jobs', ensuring accessibility even for such cases.

To monitor the status of this asynchronous request, you have two options:
1. Use Get asynchronous request.
2. Search for the asyncRequestId by utilizing List pending requests.

In contrast to the previous version (v1) of this call, v2 does not directly provide the target file within the response.
Once the asynchronous request is completed, you can download the target file using
Download target file based on async request.

_Note_: The asyncRequestId can be used only once. Once the download is initiated through `Download target file based on
async request`, the asyncRequestId becomes invalid for further use.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Jobuid`	N/A
`Response Type`	N/A

POST copySourceToTarget

/api2/v1/projects/{projectUid}/jobs/copySourceToTarget

Copy Source to Target

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

POST copySourceToTargetJobPart

/api2/v1/projects/{projectUid}/jobs/{jobUid}/copySourceToTarget

Copy Source to Target job

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Jobuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

POST createJobFromAsyncDownloadTask

/api2/v1/projects/{projectUid}/jobs/connectorTask

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).

Please supply job metadata in body.

Accepted metadata:

targetLangs - required
due - ISO 8601
workflowSettings - project with workflow - see examples bellow
assignments - project without workflows - see examples bellow
importSettings - re-usable import settings - see Create import settings
useProjectFileImportSettings - mutually exclusive with importSettings
callbackUrl - consumer callback
path - original destination directory
preTranslate - set pre translate job after import
semanticMarkup - set semantic markup processing after import when enabled for organization
xmlAssistantProfile - apply XML import settings defined using XML assistant

Create job simple (without workflow steps, without assignments):

JSON

{
  "targetLangs": [
    "cs_cz",
    "es_es"
  ]
}

Create and assign job in project without workflow step:

JSON

{
  "targetLangs": [
    "cs_cz"
  ],
  "callbackUrl": "https://my-shiny-service.com/consumeCallback",
  "importSettings": {
    "uid": "abcd123"
  },
  "due": "2007-12-03T10:15:30.00Z",
  "path": "destination directory",
  "assignments": [
    {
      "targetLang": "cs_cz",
      "providers": [
        {
          "id": "4321",
          "type": "USER"
        }
      ]
    }
  ],
  "notifyProvider": {
    "organizationEmailTemplate": {
      "id": "39"
    },
    "notificationIntervalInMinutes": "10"
  }
}

Create and assign job in project with workflow step:

JSON

{
  "targetLangs": [
    "de"
  ],
  "useProjectFileImportSettings": "true",
  "workflowSettings": [
    {
      "id": "64",
      "due": "2007-12-03T10:15:30.00Z",
      "assignments": [
        {
          "targetLang": "de",
          "providers": [
            {
              "id": "3",
              "type": "VENDOR"
            }
          ]
        }
      ],
      "notifyProvider": {
        "organizationEmailTemplate": {
          "id": "39"
        },
        "notificationIntervalInMinutes": "10"
      }
    }
  ]
}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Downloadtaskid`	N/A
`Continuous`	N/A
`Response Type`	N/A

Options (7)

Option Name	Description
`Targetlangs`	N/A
`Due`	only use for projects without workflows; otherwise specify in the workflowSettings object. Use ISO 8601 date format.
`Useprojectfileimportsettings`	Default: false
`Pretranslate`	N/A
`Semanticmarkup`	N/A
`Callbackurl`	N/A
`Path`	N/A

DELETE deleteAllTranslations

/api2/v1/projects/{projectUid}/jobs/translations

Delete all translations

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

DELETE deleteAllTranslationsV2

/api2/v2/projects/{projectUid}/jobs/translations

Delete specific translations

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

DELETE deleteHandoverFile

/api2/v1/projects/{projectUid}/fileHandovers

Delete handover file

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

DELETE deleteParts

/api2/v1/projects/{projectUid}/jobs/batch

Delete job (batch)

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Content-type`	N/A
`Purge`	N/A
`Response Type`	N/A

GET downloadCompletedFile

/api2/v2/projects/{projectUid}/jobs/{jobUid}/downloadTargetFile/{asyncRequestId}

This call will return target file with translation. This means even for other jobs that were created via
'split jobs' etc.

The asyncRequestId can be used only once. Once the download is initiated , the asyncRequestId becomes
invalid for further use.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Jobuid`	N/A
`Asyncrequestid`	N/A
`Format`	N/A
`Response Type`	N/A

PUT editJobImportSettings

/api2/v1/projects/{projectUid}/jobs/{jobUid}/importSettings

Edit job import settings

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Jobuid`	N/A
`Response Type`	N/A

Options (11)

Option Name	Description
`Inputcharset`	N/A
`Outputcharset`	N/A
`Zipcharset`	N/A
`Fileformat`	default: auto-detect
`Autodetectmultilingualfiles`	Try to use multilingual variants for auto-detected CSV and Excel files. Default: true
`Targetlength`	Default: false
`Targetlengthmax`	default: 1000
`Targetlengthpercent`	Default: false
`Targetlengthpercentvalue`	default: 130
`Segmentationruleid`	N/A
`Targetsegmentationruleid`	N/A

PUT editPart

/api2/v1/projects/{projectUid}/jobs/{jobUid}

This API call facilitates job editing using a PUT method.

Unlike Patch job, this call employs a PUT method, necessitating the inclusion of all
parameters in the request. Omitting any parameter will reset its value to the default. For instance, if only the status
field is included, the due date and provider fields will be emptied, even if they had previous values.

It's recommended to either use a call like Get job or List jobs to
gather the unchanged information or consider using the Patch job operation.

This call supports editing the status, due date, and providers. When modifying providers, it's crucial to submit both
the provider's ID and its type (either VENDOR or USER).

The response will offer a subset of information from Get job.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Jobuid`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Status`	N/A
`Datedue`	N/A

PUT editParts

/api2/v1/projects/{projectUid}/jobs/batch

Returns only jobs which were updated by the batch operation.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Status`	N/A
`Datedue`	N/A

POST exportToOnlineRepository

/api2/v3/projects/{projectUid}/jobs/export

Export jobs to online repository

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

POST filePreview

/api2/v1/projects/{projectUid}/jobs/{jobUid}/preview

Takes bilingual file (.mxliff only) as argument. If not passed, data will be taken from database

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Jobuid`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

GET filePreviewJob

/api2/v1/projects/{projectUid}/jobs/{jobUid}/preview

Download preview file

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Jobuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

POST getBilingualFile

/api2/v1/projects/{projectUid}/jobs/bilingualFile

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.

When dealing with MXLIFF or DOCX files, modifications made externally can be imported back into the Phrase TMS project.
Any changes will be synchronized into the editor, allowing actions like confirming or locking segments.

Unlike the user interface (UI), the APIs also support XLIFF as a bilingual format, intended primarily
for export purposes. However, TMX and XLIFF files cannot be imported back into the project to reflect external changes.

While MXLIFF files are editable using various means, their primary intended use is with the
CAT Desktop Editor.
It's crucial to note that alterations to the file incompatible with the CAT Desktop Editor's features may result in
a corrupted file, leading to potential loss or duplication of work.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Format`	N/A
`Preview`	N/A
`Response Type`	N/A

GET getCompletedFileWarnings

/api2/v1/projects/{projectUid}/jobs/{jobUid}/targetFileWarnings

This call will return target file's warnings. This means even for other jobs that were created via 'split jobs' etc.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Jobuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

GET getHandoverFiles

/api2/v1/projects/{projectUid}/fileHandovers

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Jobuid`	JobPart Id of requested handover file
`Response Type`	N/A

GET getImportSettingsForJob

/api2/v1/projects/{projectUid}/jobs/{jobUid}/importSettings

Get import settings for job

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Jobuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

GET getOriginalFile

/api2/v1/projects/{projectUid}/jobs/{jobUid}/original

Download original file

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Jobuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

GET getPart

/api2/v1/projects/{projectUid}/jobs/{jobUid}

This API call provides specific information about a
job within a project.

The response includes fundamental job details such as the current status, assigned providers, language combination, or
workflow step to which the job belongs.
Additionally, it offers a subset of the Get project information.

Furthermore, the response contains timestamps for the last
Update source and Update target operations
executed on the job.

If the job was imported as
continuous, the job will be
marked as such, and the response will include the timestamp of the last update.

Moreover, the response features a boolean flag indicating if the job was imported successfully.
It also highlights potential errors that might have occurred during the import process.

The jobReference field serves as a unique identifier that allows matching corresponding jobs across different
workflow steps.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Jobuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

GET getPartsWorkflowStep

/api2/v1/projects/{projectUid}/jobs/{jobUid}/workflowStep

Get job's workflowStep

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Jobuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

POST getSegmentsCount

/api2/v1/projects/{projectUid}/jobs/segmentsCount

This API provides the current count of segments (progress data).

Every time this API is called, it returns the most up-to-date information. Consequently, these numbers will change
dynamically over time. The data retrieved from this API call is utilized to calculate the progress percentage in the UI.

The call returns the following information:

Counts of characters, words, and segments for each of the locked, confirmed, and completed categories. In this context,
_completed_ is defined as confirmed + locked - confirmed and locked.

The number of added words if the Update source
operation has been performed on the job. In this context, added words are defined as the original word count plus the
sum of words added during all subsequent update source operations.

The count of segments where relevant machine translation (MT) was available (machineTranslationRelevantSegmentsCount)
and the number of segments where the MT output was post-edited (machineTranslationPostEditedSegmentsCount).

A breakdown of Quality assurance
results, including the number of segments on which it was performed, the count of warnings found, and the number of
warnings that were ignored.

Additionally, a breakdown of the aforementioned information from the previous
Workflow step is also provided.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

GET getTranslationResources

/api2/v1/projects/{projectUid}/jobs/{jobUid}/translationResources

Get translation resources

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Jobuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

GET listPartsV2

/api2/v2/projects/{projectUid}/jobs

API call to return a paginated list of jobs
in the given project.

Use the query parameters to further narrow down the searching criteria.

pageNumber - A zero-based parameter indicating the page number you wish to retrieve. The total number of pages is

returned in each response in the totalPages field in the top level of the response.

pageSize - A parameter indicating the size of the page you wish to return.

This has direct effect on the totalPages
retrieved in each response and can hence influence the number of times to iterate over to get all the jobs.

count - When set to true, the response will not contain the list of jobs (the content field) but only the

counts of elements and pages. Can be used to quickly retrieve the number of elements and pages to iterate over.

workflowLevel - A non-zero based parameter indicating which

workflow steps
the returned jobs belong to. If left unspecified, its value is set to 1.

status - A parameter allowing for filtering only for jobs in a specific status.
assignedUser - A parameter allowing for filtering only for jobs assigned to a specific user.

The parameter accepts a user ID.

dueInHours - A parameter allowing for filtering only for jobs whose due date is less or equal to the number

of hours specified.

filename - A parameter allowing for filtering only for jobs with a specific file name.
targetLang - A parameter allowing for filtering only for jobs with a specific target language.
assignedVendor - A parameter allowing for filtering only for jobs assigned to a specific vendor.

The parameter accepts a user ID.

notReady - A parameter allowing for filtering only jobs that have been imported. When set to true the response

will only contain jobs that have not been imported yet.
This will also return jobs that have not been imported correctly, e.g. due to an error.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Pagenumber`	N/A
`Pagesize`	N/A
`Count`	N/A
`Workflowlevel`	N/A
`Status`	N/A
`Assigneduser`	N/A
`Dueinhours`	N/A
`Filename`	N/A
`Targetlang`	N/A
`Assignedvendor`	N/A
`Notready`	N/A
`Response Type`	N/A

GET listSegments

/api2/v1/projects/{projectUid}/jobs/{jobUid}/segments

Get segments

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Jobuid`	N/A
`Content-type`	N/A
`Beginindex`	N/A
`Endindex`	N/A
`Response Type`	N/A

POST notifyAssigned

/api2/v1/projects/{projectUid}/jobs/notifyAssigned

Notify assigned users

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Cc`	N/A
`Bcc`	N/A

PATCH patchPart

/api2/v1/projects/{projectUid}/jobs/{jobUid}

This API call allows for partial updates to jobs, modifying specific fields without overwriting
those not included in the update request.

Differing from Edit job, this call employs a PATCH method, updating only the provided fields
without altering others. It's beneficial when editing a subset of supported fields is required.

The call supports the editing of status, due date, and providers. When editing providers, it's essential to submit
both the ID of the provider and its type (either VENDOR or USER).

The response will provide a subset of information from Get job.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Jobuid`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Status`	N/A
`Datedue`	N/A

PATCH patchUpdateJobParts

/api2/v3/jobs

Allows partial update, not breaking whole batch if single job fails and returns list of errors

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Status`	N/A
`Datedue`	N/A
`Cleardatedue`	N/A

GET previewUrls

/api2/v1/projects/{projectUid}/jobs/{jobUid}/previewUrl

Get PDF preview

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Jobuid`	N/A
`Content-type`	N/A
`Workflowlevel`	N/A
`Response Type`	N/A

POST pseudoTranslateJobPart

/api2/v1/projects/{projectUid}/jobs/{jobUid}/pseudoTranslate

Pseudo-translates job

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Jobuid`	N/A
`Response Type`	N/A

Options (5)

Option Name	Description
`Replacement`	N/A
`Prefix`	N/A
`Suffix`	N/A
`Length`	N/A
`Keyhashprefixlen`	N/A

POST pseudoTranslateV2

/api2/v2/projects/{projectUid}/jobs/pseudoTranslate

Pseudo-translate job

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

POST searchByJob3

/api2/v3/projects/{projectUid}/jobs/{jobUid}/transMemories/search

Search job's translation memories

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Jobuid`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Query`	N/A
`Reverse`	Default: false
`Scorethreshold`	Default: 0.0
`Maxresults`	Default: 15

POST searchPartsInProject

/api2/v1/projects/{projectUid}/jobs/search

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 information will be returned and the rest of the
jobs will be filtered out.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

POST setStatus

/api2/v1/projects/{projectUid}/jobs/{jobUid}/setStatus

Edit job status

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Jobuid`	N/A
`Response Type`	N/A

Options (3)

Option Name

Description

Requestedstatus

N/A

Notifyowner

Default: false; Both project owner and job owner are notified;

the parameter is subordinated to notification settings in the project

Propagatestatus

Default: false;

Controls both job status and email notifications to previous/next provider

POST split

/api2/v1/projects/{projectUid}/jobs/{jobUid}/split

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 wordCount
By document parts - fill in byDocumentParts, works only with PowerPoint files

Only one option at a time is allowed.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Jobuid`	N/A
`Response Type`	N/A

Options (5)

Option Name	Description
`Segmentordinals`	N/A
`Partcount`	N/A
`Partsize`	N/A
`Wordcount`	N/A
`Bydocumentpart`	Can be used only for PowerPoint files

GET statusChanges

/api2/v1/projects/{projectUid}/jobs/{jobUid}/statusChanges

Get status changes

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Jobuid`	N/A
`Content-type`	N/A
`Order`	N/A
`Response Type`	N/A

POST updateSource

/api2/v1/projects/{projectUid}/jobs/source

API updated source file for specified job

Job file can be provided directly in the message body.

Please supply jobs in Memsource header.

For file in the request body provide also the filename in Content-Disposition header.

If a job from a multilingual file is updated, all jobs from the same file are update too even if their UIDs aren't
listed in the jobs field.

Accepted metadata:

jobs - required - list of jobs UID reference (maximum size 100)
preTranslate - pre translate flag (default false)
allowAutomaticPostAnalysis - if automatic post editing analysis should be created. If not specified then value

is taken from the analyse settings of the project

callbackUrl - consumer callback

Job restrictions:

job must belong to project specified in path (projectUid)
job UID must be from the first workflow step
job cannot be split
job cannot be continuous
job cannot originate in a connector
status in any of the job's workflow steps cannot be a final

status (COMPLETED_BY_LINGUIST, COMPLETED, CANCELLED)

job UIDs must be from the same multilingual file if a multilingual file is updated
multiple multilingual files or a mixture of multilingual and other jobs cannot be updated in one call

File restrictions:

file cannot be a .zip file

Example:

JSON

{
  "jobs": [
    {
        "uid": "jobIn1stWfStepAndNonFinalStatusUid"
    }
  ],
  "preTranslate": false,
  "allowAutomaticPostAnalysis": false
  "callbackUrl": "https://my-shiny-service.com/consumeCallback"
}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Memsource`	N/A
`Content-disposition`	must match pattern ((inline\|attachment); )?(filename\*=UTF-8''(.+)\|filename="?(.+)"?)
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

POST updateTarget

/api2/v1/projects/{projectUid}/jobs/target

API update target file for specified job

Job file can be provided directly in the message body.

Please supply jobs in Memsource header.

For file in the request body provide also the filename in Content-Disposition header.

Accepted metadata:

jobs - required - list of jobs UID reference (maximum size 1)
propagateConfirmedToTm - sets if confirmed segments should be stored in TM (default value: true)
callbackUrl - consumer callback
targetSegmentationRule - ID reference to segmentation rule of organization to use for update target
unconfirmChangedSegments - sets if segments should stay unconfirmed

Job restrictions:

job must belong to project specified in path (projectUid)
job cannot be split
job cannot be continuous
job cannot be multilingual
job cannot originate in a connector
job cannot have different file extension than original file

File restrictions:

file cannot be a .zip file
update target is not allowed for jobs with file extensions: xliff, po, tbx, tmx, ttx, ts

Example:

JSON

{
  "jobs": [
    {
        "uid": "jobUid"
    }
  ],
  "propagateConfirmedToTm": true,
  "targetSegmentationRule": {
        "id": "1"
   },
  "callbackUrl": "https://my-shiny-service.com/consumeCallback"
}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Memsource`	N/A
`Content-disposition`	must match pattern ((inline\|attachment); )?(filename\*=UTF-8''(.+)\|filename="?(.+)"?)
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

PUT uploadHandoverFile

/api2/v1/projects/{projectUid}/fileHandovers

For following jobs the handover file is not supported:

Continuous jobs
Jobs from connectors
Split jobs
Multilingual jobs

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Memsource`	N/A
`Content-disposition`	must match pattern ((inline\|attachment); )?(filename\*=UTF-8''(.+)\|filename="?(.+)"?)
`Content-length`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

POST webEditorLinkV2

/api2/v2/projects/{projectUid}/jobs/webEditor

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_WORKFLOW_NOT_COMPLETED_STRICT - Previous workflow step is not completed and project has strictWorkflowFinish set to true
IN_DELIVERED_STATE - Jobs in DELIVERED state
IN_COMPLETED_STATE - Jobs in COMPLETED state
IN_REJECTED_STATE - Jobs in REJECTED state

Possible error codes are:

ASSIGNED_TO_OTHER_USER - Job is accepted by other user
NOT_UNIQUE_TARGET_LANG - Requested jobs contains different target locales
TOO_MANY_SEGMENTS - Count of requested job's segments is higher than 40000
TOO_MANY_JOBS - Count of requested jobs is higher than 290
COMPLETED_JOINED_WITH_OTHER - Jobs in COMPLETED state cannot be joined with jobs in other states
DELIVERED_JOINED_WITH_OTHER - Jobs in DELIVERED state cannot be joined with jobs in other states
REJECTED_JOINED_WITH_OTHER - Jobs in REJECTED state cannot be joined with jobs in other states

Warning response example:

JSON

{
    "warnings": [
        {
            "message": "Not accepted by linguist",
            "args": {
                "jobs": [
                    "abcd1234"
                ]
            },
            "code": "NOT_ACCEPTED_BY_LINGUIST"
        },
        {
            "message": "Previous workflow step not completed",
            "args": {
                "jobs": [
                    "abcd1234"
                ]
            },
            "code": "PREVIOUS_WORKFLOW_NOT_COMPLETED"
        }
    ],
    "url": "/web/job/abcd1234-efgh5678/translate"
}

Error response example:
Status: 400 Bad Request

JSON

{
    "errorCode": "NOT_UNIQUE_TARGET_LANG",
    "errorDescription": "Only files with identical target languages can be joined",
    "errorDetails": [
        {
            "code": "NOT_UNIQUE_TARGET_LANG",
            "args": {
                "targetLocales": [
                    "de",
                    "en"
                ]
            },
            "message": "Only files with identical target languages can be joined"
        },
        {
            "code": "TOO_MANY_SEGMENTS",
            "args": {
                "maxSegments": 40000,
                "segments": 400009
            },
            "message": "Up to 40000 segments can be opened in the Memsource Web Editor, job has 400009 segments"
        }
    ]
}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

POST wildCardSearchByJob3

/api2/v3/projects/{projectUid}/jobs/{jobUid}/transMemories/wildCardSearch

Wildcard search job's translation memories

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Jobuid`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Query`	N/A
`Reverse`	Default: false
`Count`	N/A
`Offset`	N/A

Language AI (2)

GET getConsumedMtus

/api2/v1/mtuUsage

Total amount of consumed MTUs in the current month

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Content-type`	N/A
`Response Type`	N/A

GET listMemsourceTranslateProfile

/api2/v1/memsourceTranslateProfiles

List of Language AI profiles

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Name`	Filter by name
`Sort`	Sort by
`Order`	desc
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 50, default 10
`Includeprojects`	N/A
`Response Type`	N/A

Language Quality Assessment

GET downloadLqaReports

/api2/v1/lqa/assessments/reports

Returns a single xlsx report or ZIP archive with multiple reports.
If any given jobPart is not from LQA workflow step, reports from successive workflow steps may be returned
If none were found returns 404 error, otherwise returns those that were found.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobparts`	Comma separated list of JobPart UIDs, between 1 and 100 UIDs
`Content-type`	N/A
`Response Type`	N/A

Machine Translation Settings (5)

GET getList

/api2/v1/machineTranslateSettings

List machine translate settings

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Name`	N/A
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 50, default 50
`Sort`	Sorting field
`Order`	N/A
`Response Type`	N/A

GET getMTSettings

/api2/v1/machineTranslateSettings/{mtsUid}

Get machine translate settings

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Mtsuid`	N/A
`Response Type`	N/A

GET getMTTypes

/api2/v1/machineTranslateSettings/types

Get machine translate settings types

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

GET getStatus

/api2/v1/machineTranslateSettings/{mtsUid}/status

Get status of machine translate engine

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Mtsuid`	N/A
`Response Type`	N/A

GET getThirdPartyEnginesList

/api2/v1/machineTranslateSettings/thirdPartyEngines

List third party machine translate settings

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Name`	N/A
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 100, default 50
`Sort`	Sorting field
`Order`	N/A
`Response Type`	N/A

Machine Translation

POST machineTranslation

/api2/v1/machineTranslations/{mtSettingsUid}/translate

Translate with MT

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Mtsettingsuid`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Sourcetexts`	N/A
`From`	N/A
`To`	N/A
`Filename`	N/A

Mapping

GET getMappingForTask

/api2/v1/mappings/tasks/{id}

Returns mapping for taskId (mxliff)

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	N/A
`Workflowlevel`	N/A
`Response Type`	N/A

Misc (2)

POST Create a Job

/api2/v1/projects/{projectUid}/jobs

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Content-disposition`	N/A
`Memsource`	N/A
`Content-type`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`File`	N/A

GET Get a Project Jobs

/api2/v1/projects/{projectUid}/jobs

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

Net Rate Scheme (7)

POST createDiscountScheme

/api2/v1/netRateSchemes

Create net rate scheme

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Name`	N/A

PUT editDiscountSchemeWorkflowStep

/api2/v1/netRateSchemes/{netRateSchemeUid}/workflowStepNetSchemes/{netRateSchemeWorkflowStepId}

Edit scheme for workflow step

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Netrateschemeuid`	N/A
`Netrateschemeworkflowstepid`	N/A
`Response Type`	N/A

GET getDiscountScheme

/api2/v1/netRateSchemes/{netRateSchemeUid}

Get net rate scheme

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Netrateschemeuid`	N/A
`Response Type`	N/A

GET getDiscountSchemeWorkflowStep

/api2/v1/netRateSchemes/{netRateSchemeUid}/workflowStepNetSchemes/{netRateSchemeWorkflowStepId}

Get scheme for workflow step

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Netrateschemeuid`	N/A
`Netrateschemeworkflowstepid`	N/A
`Response Type`	N/A

GET getDiscountSchemeWorkflowSteps

/api2/v1/netRateSchemes/{netRateSchemeUid}/workflowStepNetSchemes

List schemes for workflow step

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Netrateschemeuid`	N/A
`Pagenumber`	N/A
`Pagesize`	Page size, accepts values between 1 and 50, default 50
`Response Type`	N/A

GET getDiscountSchemes

/api2/v1/netRateSchemes

List net rate schemes

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Pagenumber`	N/A
`Pagesize`	Page size, accepts values between 1 and 50, default 50
`Name`	Filter by name
`Isdefault`	Filter for default attribute
`Createdinlasthours`	Filter for those created within given hours
`Response Type`	N/A

PUT updateDiscountScheme

/api2/v1/netRateSchemes/{netRateSchemeUid}

Edit net rate scheme

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Netrateschemeuid`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Name`	N/A

Price List (11)

POST createLanguagePair

/api2/v1/priceLists/{priceListUid}/priceSets

Add language pairs

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Pricelistuid`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Sourcelanguages`	N/A
`Targetlanguages`	N/A

POST createPriceList

/api2/v1/priceLists

Create price list

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Name`	N/A
`Currencycode`	N/A
`Billingunit`	Default: Word

DELETE deleteLanguagePair

/api2/v1/priceLists/{priceListUid}/priceSets/{sourceLanguage}/{targetLanguage}

Remove language pair

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Pricelistuid`	N/A
`Sourcelanguage`	N/A
`Targetlanguage`	N/A
`Content-type`	N/A
`Response Type`	N/A

DELETE deleteLanguagePairs

/api2/v1/priceLists/{priceListUid}/priceSets

Remove language pairs

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Pricelistuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

DELETE deletePriceList

/api2/v1/priceLists/{priceListUid}

Delete price list

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Pricelistuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

GET getListOfPriceList

/api2/v1/priceLists

List price lists

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 50, default 50
`Name`	Filter for name
`Response Type`	N/A

GET getPriceList

/api2/v1/priceLists/{priceListUid}

Get price list

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Pricelistuid`	N/A
`Response Type`	N/A

GET getPricesWithWorkflowSteps

/api2/v1/priceLists/{priceListUid}/priceSets

List price sets

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Pricelistuid`	N/A
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 50, default 50
`Sourcelanguages`	N/A
`Targetlanguages`	N/A
`Response Type`	N/A

POST setMinimumPriceForSet

/api2/v1/priceLists/{priceListUid}/priceSets/minimumPrices

Edit minimum prices

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Pricelistuid`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Sourcelanguages`	N/A
`Targetlanguages`	N/A
`Minimumprice`	N/A

POST setPrices

/api2/v1/priceLists/{priceListUid}/priceSets/prices

If object contains only price, all languages and workflow steps will be updated

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Pricelistuid`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Sourcelanguages`	N/A
`Targetlanguages`	N/A
`Price`	N/A

PUT updatePriceList

/api2/v1/priceLists/{priceListUid}

Update price list

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Pricelistuid`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Name`	N/A
`Currencycode`	N/A
`Billingunit`	Default: Word

Project Reference File (6)

DELETE batchDeleteReferenceFiles

/api2/v1/projects/{projectUid}/references

Delete project reference files (batch)

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

POST batchDownloadReferenceFiles

/api2/v1/projects/{projectUid}/references/download

Download project reference files (batch)

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

POST createReferenceFiles

/api2/v2/projects/{projectUid}/references

The json request part allows sending additional data as JSON,
such as a text note that will be used for all the given reference files.
In case no file parts are sent, only 1 reference is created with the given note.
Either at least one file must be sent or the note must be specified.
Example:

JSON

{
    "note": "Sample text"
}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

GET downloadReference

/api2/v1/projects/{projectUid}/references/{referenceFileId}

Download project reference file

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Referencefileid`	N/A
`Content-type`	N/A
`Response Type`	N/A

GET listReferenceFileCreators

/api2/v1/projects/{projectUid}/references/creators

The result is not paged and returns up to 50 users.

If the requested user is not included, the search can be narrowed down with the userName parameter.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Content-type`	N/A
`Username`	N/A
`Response Type`	N/A

GET listReferenceFiles

/api2/v1/projects/{projectUid}/references

List project reference files

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Content-type`	N/A
`Filename`	N/A
`Datecreatedsince`	date time in ISO 8601 UTC format
`Createdby`	UID of user
`Pagenumber`	N/A
`Pagesize`	N/A
`Sort`	N/A
`Order`	N/A
`Response Type`	N/A

Project Template (28)

POST createCustomFieldsOnProjectTemplate

/api2/v1/projectTemplates/{projectTemplateUid}/customFields

Create custom field instances

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projecttemplateuid`	N/A
`Response Type`	N/A

POST createProjectTemplate

/api2/v1/projectTemplates

Create project template

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Name`	N/A
`Usedynamictitle`	N/A
`Dynamictitle`	N/A

DELETE deleteCustomFieldOfProjectTemplate

/api2/v1/projectTemplates/{projectTemplateUid}/customFields/{fieldInstanceUid}

Delete custom field of project template

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projecttemplateuid`	N/A
`Fieldinstanceuid`	N/A
`Response Type`	N/A

DELETE deleteProjectTemplate

/api2/v1/projectTemplates/{projectTemplateUid}

Delete project template

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projecttemplateuid`	N/A
`Response Type`	N/A

PUT editCustomFieldOnProjectTemplate

/api2/v1/projectTemplates/{projectTemplateUid}/customFields/{fieldInstanceUid}

Edit custom field of project template

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projecttemplateuid`	N/A
`Fieldinstanceuid`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Value`	N/A

PUT editCustomFieldsOnProjectTemplate

/api2/v1/projectTemplates/{projectTemplateUid}/customFields

Edit custom fields of the project template (batch)

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projecttemplateuid`	N/A
`Response Type`	N/A

PUT editProjectTemplate

/api2/v1/projectTemplates/{projectTemplateUid}

Edit project template

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projecttemplateuid`	N/A
`Response Type`	N/A

Options (8)

Option Name	Description
`Name`	N/A
`Templatename`	N/A
`Sourcelang`	N/A
`Targetlangs`	N/A
`Usedynamictitle`	N/A
`Dynamictitle`	N/A
`Note`	N/A
`Filehandover`	Default: false

PUT editProjectTemplateAccessSettings

/api2/v1/projectTemplates/{projectTemplateUid}/accessSettings

Edit project template access and security settings

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projecttemplateuid`	N/A
`Response Type`	N/A

Options (18)

Option Name	Description
`Downloadenabled`	Default: false
`Webeditorenabledforlinguists`	Default: false
`Showuserdatatolinguists`	Default: false
`Emailnotifications`	Default: false
`Strictworkflowfinish`	Default: false
`Usevendors`	Default: false
`Linguistsmayeditlockedsegments`	Default: false
`Usersmaysetautopropagation`	Default: true
`Allowloadingexternalcontentineditors`	Default: true
`Allowloadingiframes`	Default: false
`Linguistsmayeditsource`	Default: true
`Linguistsmayedittagcontent`	Default: true
`Linguistsmaydownloadlqareport`	Default: true
`Usernamesdisplayedinlqareport`	Default: true
`Usermaysetinstantqa`	Default: true
`Triggerwebhooks`	Default: true
`Notifyjobownerstatuschanged`	Default: false
`Alloweddomains`	N/A

PUT editProjectTemplateImportSettings

/api2/v1/projectTemplates/{projectTemplateUid}/importSettings

Edit project template import settings

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projecttemplateuid`	N/A
`Response Type`	N/A

Options (11)

Option Name	Description
`Inputcharset`	N/A
`Outputcharset`	N/A
`Zipcharset`	N/A
`Fileformat`	default: auto-detect
`Autodetectmultilingualfiles`	Try to use multilingual variants for auto-detected CSV and Excel files. Default: true
`Targetlength`	Default: false
`Targetlengthmax`	default: 1000
`Targetlengthpercent`	Default: false
`Targetlengthpercentvalue`	default: 130
`Segmentationruleid`	N/A
`Targetsegmentationruleid`	N/A

PUT editProjectTemplateV2

/api2/v2/projectTemplates/{projectTemplateUid}

Edit project template

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projecttemplateuid`	N/A
`Response Type`	N/A

Options (8)

Option Name	Description
`Name`	N/A
`Templatename`	N/A
`Sourcelang`	N/A
`Targetlangs`	N/A
`Usedynamictitle`	N/A
`Dynamictitle`	N/A
`Note`	N/A
`Filehandover`	Default: false

GET getAnalyseSettingsForProjectTemplate

/api2/v1/projectTemplates/{projectTemplateUid}/analyseSettings

Get analyse settings

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projecttemplateuid`	N/A
`Response Type`	N/A

GET getCustomFieldOfProjectTemplate

/api2/v1/projectTemplates/{projectTemplateUid}/customFields/{fieldInstanceUid}

Get custom field of project template

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projecttemplateuid`	N/A
`Fieldinstanceuid`	N/A
`Response Type`	N/A

GET getCustomFieldsPageOfProjectTemplate

/api2/v1/projectTemplates/{projectTemplateUid}/customFields

Get custom fields of project template (page)

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projecttemplateuid`	N/A
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 50, default 20
`Createdby`	Filter by webhook creators UIDs
`Modifiedby`	Filter by webhook updaters UIDs
`Sortfield`	Sort by this field
`Sorttrend`	Sort direction
`Response Type`	N/A

GET getImportSettingsForProjectTemplate

/api2/v1/projectTemplates/{projectTemplateUid}/importSettings

Get import settings

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projecttemplateuid`	N/A
`Response Type`	N/A

GET getMachineTranslateSettingsForProjectTemplate

/api2/v1/projectTemplates/{projectTemplateUid}/mtSettings

Get project template machine translate settings

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projecttemplateuid`	N/A
`Response Type`	N/A

GET getProjectTemplate

/api2/v1/projectTemplates/{projectTemplateUid}

Note: importSettings in response is deprecated and will be always null

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projecttemplateuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

GET getProjectTemplateAccessSettings

/api2/v1/projectTemplates/{projectTemplateUid}/accessSettings

Get project template access and security settings

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projecttemplateuid`	N/A
`Response Type`	N/A

GET getProjectTemplatePreTranslateSettingsV4

/api2/v4/projectTemplates/{projectTemplateUid}/preTranslateSettings

Get project template pre-translate settings

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projecttemplateuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

GET getProjectTemplateQASettings

/api2/v1/projectTemplates/{projectTemplateUid}/qaSettings

Get quality assurance settings

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projecttemplateuid`	N/A
`Response Type`	N/A

GET getProjectTemplateTermBases

/api2/v1/projectTemplates/{projectTemplateUid}/termBases

Get term bases

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projecttemplateuid`	N/A
`Response Type`	N/A

GET getProjectTemplateTransMemories_2

/api2/v3/projectTemplates/{projectTemplateUid}/transMemories

Get translation memories

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projecttemplateuid`	N/A
`Targetlang`	Filter project translation memories by target language
`Wfstepuid`	Filter project translation memories by workflow step
`Response Type`	N/A

GET getProjectTemplates

/api2/v1/projectTemplates

API call to list project templates.

Use the query parameters below to refine your search criteria for project templates:

name - The full project template name or a portion of it. For example, using name=GUI or name=02

will locate project templates named GUI02.

clientId - The client's ID within the system, not interchangeable with its UID.
clientName - The complete or partial name of the client. For instance, using clientName=GUI or clientName=02

will find project templates associated with the client GUI02.

ownerUid - The user UID who owns the project template within the system, interchangeable with its ID.
domainName - The complete or partial name of the domain. Using domainName=GUI or domainName=02 will find

project templates associated with the domain GUI02.

subDomainName - The complete or partial name of the subdomain. For instance, using subDomainName=GUI or

subDomainName=02 will locate project templates linked to the subdomain GUI02.

costCenterId - The cost center's ID within the system, not interchangeable with its UID.
costCenterName - The complete or partial name of the cost center. For example, using costCenterName=GUI or

costCenterName=02 will find project templates associated with the cost center GUI02.

businessUnitName - The complete or partial name of the business unit. For instance, using businessUnitName=GUI

or businessUnitName=02 will locate project templates linked to the business unit GUI02.

sort - Determines if the resulting list of project templates should be sorted by their names or the date they

were created. This field supports either dateCreated or templateName as values.

direction - Indicates the sorting order for the resulting list by using either asc (ascending) or desc

(descending) values.

pageNumber - Indicates the desired page number (zero-based) to retrieve. The total number of pages is returned in

the totalPages field within each response.

pageSize - Indicates the page size, affecting the totalPages retrieved in each response and potentially

impacting the number of iterations needed to obtain all project templates.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Content-type`	N/A
`Name`	N/A
`Clientid`	N/A
`Clientname`	N/A
`Owneruid`	N/A
`Domainname`	N/A
`Subdomainname`	N/A
`Costcenterid`	N/A
`Costcentername`	N/A
`Businessunitname`	N/A
`Sort`	N/A
`Direction`	N/A
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 50, default 50
`Response Type`	N/A

GET relevantTransMemoriesForProjectTemplate

/api2/v1/projectTemplates/{projectTemplateUid}/transMemories/relevant

List project template relevant translation memories

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projecttemplateuid`	N/A
`Name`	N/A
`Domainname`	N/A
`Clientname`	N/A
`Subdomainname`	N/A
`Targetlangs`	N/A
`Strictlangmatching`	N/A
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 50, default 50
`Response Type`	N/A

PUT setProjectTemplateQASettings

/api2/v1/projectTemplates/{projectTemplateUid}/qaSettings

Edit quality assurance settings

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projecttemplateuid`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Checks`	N/A

PUT setProjectTemplateTermBases

/api2/v1/projectTemplates/{projectTemplateUid}/termBases

Edit term bases in project template

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projecttemplateuid`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Targetlang`	N/A

PUT setProjectTemplateTransMemoriesV2

/api2/v2/projectTemplates/{projectTemplateUid}/transMemories

If user wants to edit “All target languages” or "All workflow steps”,

but there are already varied TM settings for individual languages or steps,
then the user risks to overwrite these individual choices.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projecttemplateuid`	N/A
`Response Type`	N/A

PUT updateAnalyseSettingsForProjectTemplate

/api2/v1/projectTemplates/{projectTemplateUid}/analyseSettings

Edit analyse settings

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projecttemplateuid`	N/A
`Response Type`	N/A

Options (17)

Option Name	Description
`Type`	N/A
`Includefuzzyrepetitions`	Default: false
`Separatefuzzyrepetitions`	Default: false
`Includenontranslatables`	Default: false
`Includemachinetranslationmatches`	Default: false
`Includeconfirmedsegments`	Default: false
`Includenumbers`	Default: false
`Includelockedsegments`	Default: false
`Transmemorypostediting`	Default: false
`Nontranslatablepostediting`	Default: false
`Machinetranslatepostediting`	Default: false
`Countsourceunits`	Default: false
`Includetransmemory`	Default: false
`Namingpattern`	N/A
`Analyzebylanguage`	Mutually exclusive with analyzeByProvider. Default: false
`Analyzebyprovider`	Mutually exclusive with analyzeByLanguage. Default: true
`Allowautomaticpostanalysis`	Default: false

PUT updateProjectTemplatePreTranslateSettingsV4

/api2/v4/projectTemplates/{projectTemplateUid}/preTranslateSettings

Update project template pre-translate settings

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projecttemplateuid`	N/A
`Response Type`	N/A

Options (5)

Option Name	Description
`Pretranslateonjobcreation`	Pre-translate & set job to completed: Pre-translate on job creation. Default: false
`Setjobstatuscompleted`	Pre-translate & set job to completed: Set job to completed once pre-translated. Default: false
`Setjobstatuscompletedwhenconfirmed`	Pre-translate & set job to completed when all segments confirmed: Set job to completed once pre-translated and all segments are confirmed. Default: false
`Setprojectstatuscompleted`	Pre-translate & set job to completed: Set project to completed once all jobs pre-translated. Default: false
`Overwriteexistingtranslations`	Overwrite existing translations in target segments. Default: false

Project (51)

POST addTargetLanguageToProject

/api2/v1/projects/{projectUid}/targetLangs

Add target languages to project

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Targetlangs`	N/A

POST addWorkflowSteps

/api2/v1/projects/{projectUid}/workflowSteps

Add workflow steps

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

POST assignLinguistsFromTemplate

/api2/v1/projects/{projectUid}/applyTemplate/{templateUid}/assignProviders

Assigns providers from template

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Templateuid`	N/A
`Projectuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

POST assignLinguistsFromTemplateToJobParts

/api2/v1/projects/{projectUid}/applyTemplate/{templateUid}/assignProviders/forJobParts

Assigns providers from template (specific jobs)

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Templateuid`	N/A
`Projectuid`	N/A
`Response Type`	N/A

POST assignVendorToProject

/api2/v1/projects/{projectUid}/assignVendor

To unassign Vendor from Project, use empty body:

JSON

{}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Datedue`	N/A

GET assignableTemplates

/api2/v1/projects/{projectUid}/assignableTemplates

List assignable templates

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

POST cloneProject

/api2/v1/projects/{projectUid}/clone

Clone project

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Name`	N/A

POST createCustomFieldsOnProject

/api2/v1/projects/{projectUid}/customFields

Create custom field instances

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

POST createProjectFromTemplateV2

/api2/v2/projects/applyTemplate/{templateUid}

Create project from template

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Templateuid`	N/A
`Response Type`	N/A

Options (5)

Option Name	Description
`Name`	N/A
`Sourcelang`	N/A
`Targetlangs`	N/A
`Datedue`	N/A
`Note`	N/A

POST createProjectFromTemplateV2Async

/api2/v2/projects/applyTemplate/async/{templateUid}

Create project from template (async)

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Templateuid`	N/A
`Response Type`	N/A

Options (6)

Option Name	Description
`Name`	N/A
`Sourcelang`	N/A
`Targetlangs`	N/A
`Datedue`	N/A
`Note`	N/A
`Callbackurl`	N/A

POST createProjectV3

/api2/v3/projects

Create project

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (8)

Option Name	Description
`Name`	N/A
`Sourcelang`	N/A
`Targetlangs`	N/A
`Purchaseorder`	N/A
`Datedue`	N/A
`Note`	N/A
`Filehandover`	Default: false
`Propagatetranslationstolowerwfduringupdatesource`	Default: false

DELETE deleteCustomFieldOfProject

/api2/v1/projects/{projectUid}/customFields/{fieldInstanceUid}

Delete custom field of project

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Fieldinstanceuid`	N/A
`Response Type`	N/A

DELETE deleteProject

/api2/v1/projects/{projectUid}

Delete project

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Content-type`	N/A
`Purge`	N/A
`Response Type`	N/A

PUT editCustomFieldOnProject

/api2/v1/projects/{projectUid}/customFields/{fieldInstanceUid}

Edit custom field of project

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Fieldinstanceuid`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Value`	N/A

PUT editCustomFieldsOnProject

/api2/v1/projects/{projectUid}/customFields

Edit custom fields of the project (batch)

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

PUT editImportSettingsOfProject

/api2/v1/projects/{projectUid}/importSettings

Edit project import settings

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

Options (11)

Option Name	Description
`Inputcharset`	N/A
`Outputcharset`	N/A
`Zipcharset`	N/A
`Fileformat`	default: auto-detect
`Autodetectmultilingualfiles`	Try to use multilingual variants for auto-detected CSV and Excel files. Default: true
`Targetlength`	Default: false
`Targetlengthmax`	default: 1000
`Targetlengthpercent`	Default: false
`Targetlengthpercentvalue`	default: 130
`Segmentationruleid`	N/A
`Targetsegmentationruleid`	N/A

PUT editProjectAccessSettingsV2

/api2/v2/projects/{projectUid}/accessSettings

Edit access and security settings

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

Options (18)

Option Name	Description
`Downloadenabled`	Default: false
`Webeditorenabledforlinguists`	Default: false
`Showuserdatatolinguists`	Default: false
`Emailnotifications`	Default: false
`Strictworkflowfinish`	Default: false
`Usevendors`	Default: false
`Linguistsmayeditlockedsegments`	Default: false
`Usersmaysetautopropagation`	Default: true
`Allowloadingexternalcontentineditors`	Default: true
`Allowloadingiframes`	Default: false
`Linguistsmayeditsource`	Default: true
`Linguistsmayedittagcontent`	Default: true
`Linguistsmaydownloadlqareport`	Default: true
`Usernamesdisplayedinlqareport`	Default: true
`Usermaysetinstantqa`	Default: true
`Triggerwebhooks`	Default: true
`Notifyjobownerstatuschanged`	Default: false
`Alloweddomains`	N/A

PUT editProjectV2

/api2/v2/projects/{projectUid}

Edit project

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

Options (8)

Option Name	Description
`Name`	N/A
`Status`	N/A
`Purchaseorder`	N/A
`Datedue`	N/A
`Note`	N/A
`Filehandover`	Default: false
`Propagatetranslationstolowerwfduringupdatesource`	Default: false
`Archived`	Default: false

GET enabledQualityChecks

/api2/v1/projects/{projectUid}/qaSettingsChecks

Returns enabled quality assurance settings.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

GET getAnalyseSettingsForProject

/api2/v1/projects/{projectUid}/analyseSettings

Get analyse settings

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

GET getCustomFieldOfProject

/api2/v1/projects/{projectUid}/customFields/{fieldInstanceUid}

Get custom field of project

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Fieldinstanceuid`	N/A
`Response Type`	N/A

GET getCustomFieldsPageOfProject

/api2/v1/projects/{projectUid}/customFields

Get custom fields of project (page)

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 50, default 20
`Createdby`	Filter by webhook creators UIDs
`Modifiedby`	Filter by webhook updaters UIDs
`Sortfield`	Sort by this field
`Sorttrend`	Sort direction
`Response Type`	N/A

GET getFileNamingSettings

/api2/v1/projects/{projectUid}/fileNamingSettings

Get file naming settings for project

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

GET getFinancialSettings

/api2/v1/projects/{projectUid}/financialSettings

Get financial settings

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

GET getImportSettingsForProject

/api2/v1/projects/{projectUid}/importSettings

Get projects's default import settings

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

GET getMtSettingsForProject

/api2/v1/projects/{projectUid}/mtSettings

Get project machine translate settings

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

GET getProject

/api2/v1/projects/{projectUid}

This API call retrieves information specific to a project.

The level of detail in the response varies based on the user's role. Admins, Project Managers, Vendors, Buyers, and
Linguists receive different responses, detailed below.

Details about predefined system metadata, such as client, domain, subdomain, cost center, business unit, or status.

Note that Custom Fields, if added to projects, are not included here and require
retrieval via a dedicated Custom Fields API call. Metadata exposed to Linguists or Vendors might differ from what's
visible to Admins or Project Managers.

Workflow Step information, crucial for

user or vendor assignments through APIs. When projects are created, each workflow step's global ID instantiates into a
project-specific workflow step ID necessary for user assignments. Attempting to assign the global workflow step ID
(found under Settings or via Workflow Step APIs) results in an error, as only the project-specific step can be assigned.

Progress information indicating the total number of jobs across all workflow steps in the project, alongside the

proportion of completed and overdue jobs.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

GET getProjectAccessSettingsV2

/api2/v2/projects/{projectUid}/accessSettings

Get access and security settings

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

GET getProjectAssignments

/api2/v1/projects/{projectUid}/providers

List project providers

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Content-type`	N/A
`Providername`	N/A
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 50, default 50
`Response Type`	N/A

GET getProjectPreTranslateSettingsV4

/api2/v4/projects/{projectUid}/preTranslateSettings

Get project pre-translate settings

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

GET getProjectSettings

/api2/v1/projects/{projectUid}/lqaSettings

Get LQA settings

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Content-type`	N/A
`Workflowlevel`	N/A
`Response Type`	N/A

GET getProjectTermBases

/api2/v1/projects/{projectUid}/termBases

Get term bases

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

GET getProjectTransMemoriesV3

/api2/v3/projects/{projectUid}/transMemories

Get translation memories

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Targetlang`	Filter project translation memories by target language
`Wfstepuid`	Filter project translation memories by workflow step
`Response Type`	N/A

GET getProjectWorkflowStepsV2

/api2/v2/projects/{projectUid}/workflowSteps

Get workflow steps

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Withassignedjobs`	Return only steps containing jobs assigned to the calling linguist.
`Response Type`	N/A

GET getQuotesForProject

/api2/v1/projects/{projectUid}/quotes

List quotes

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Content-type`	N/A
`Pagenumber`	N/A
`Pagesize`	Page size, accepts values between 1 and 50, default 50
`Response Type`	N/A

GET listByProjectV3

/api2/v3/projects/{projectUid}/analyses

List analyses by project

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Content-type`	N/A
`Name`	Name to search by
`Uid`	Uid to search by
`Pagenumber`	N/A
`Pagesize`	Page size, accepts values between 1 and 50, default 50
`Sort`	Sorting field
`Order`	Sorting order
`Onlyownerorg`	N/A
`Response Type`	N/A

GET listProjects

/api2/v1/projects

API call to retrieve a paginated list of projects. Contains a subset of information contained in
Get project API call.

Utilize the query parameters below to refine the search criteria:

name - The full project name or a portion of it. For instance, using name=GUI or name=02 will find projects

named GUI02.

clientId - The client's ID within the system, not interchangeable with its UID.
clientName - The complete or partial name of the client. For example, using clientName=GUI or clientName=02

will find projects associated with the client GUI02.

businessUnitId - The business unit's ID within the system, not interchangeable with its UID.
businessUnitName - The complete or partial name of the business unit. For instance, using businessUnitName=GUI

or businessUnitName=02 will find projects linked to the business unit GUI02.

statuses - A list of project statuses. When adding multiple statuses, include each as a dedicated query

parameter, e.g., statuses=ASSIGNED&statuses=COMPLETED.

domainId - The domain's ID within the system, not interchangeable with its UID.
domainName - The complete or partial name of the domain. Using domainName=GUI or domainName=02 will find

projects associated with the domain GUI02.

subDomainId - The subdomain's ID within the system, not interchangeable with its UID.
subDomainName - The complete or partial name of the subdomain. For example, using subDomainName=GUI or

subDomainName=02 will find projects linked to the subdomain GUI02.

costCenterId - The cost center's ID within the system, not interchangeable with its UID.
costCenterName - The complete or partial name of the cost center. For instance, using costCenterName=GUI or

costCenterName=02 will find projects associated with the cost center GUI02.

dueInHours - Filter for jobs with due dates less than or equal to the specified number of hours.
createdInLastHours - Filter for jobs created within the specified number of hours.
ownerId - The user ID who owns the project within the system, not interchangeable with its UID.
jobStatuses - A list of statuses for jobs within the projects. Include each status as a dedicated query parameter,

e.g., jobStatuses=ASSIGNED&jobStatuses=COMPLETED.

jobStatusGroup - The name of the status group used to filter projects containing at least one job with the

specified status, similar to the status filter in the Projects list for a Linguist user.

buyerId - The Buyer's ID.
pageNumber - Indicates the desired page number (zero-based) to retrieve. The total number of pages is returned in

the totalPages field within each response.

pageSize - Indicates the page size, affecting the totalPages retrieved in each response and potentially

influencing the number of iterations needed to obtain all projects.

nameOrInternalId - Specify either the project name or Internal ID (the sequence number in the project list

displayed in the UI).

includeArchived - A boolean parameter to include archived projects in the search.
archivedOnly - A boolean search indicating whether only archived projects should be searched.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Content-type`	N/A
`Name`	N/A
`Clientid`	N/A
`Clientname`	N/A
`Businessunitid`	N/A
`Businessunitname`	N/A
`Statuses`	N/A
`Targetlangs`	N/A
`Domainid`	N/A
`Domainname`	N/A
`Subdomainid`	N/A
`Subdomainname`	N/A
`Costcenterid`	N/A
`Costcentername`	N/A
`Dueinhours`	-1 for projects that are overdue
`Createdinlasthours`	N/A
`Sourcelangs`	N/A
`Ownerid`	N/A
`Jobstatuses`	Allowed for linguists only
`Jobstatusgroup`	Allowed for linguists only
`Buyerid`	N/A
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 50, default 50
`Nameorinternalid`	Name or internal ID of project
`Includearchived`	List also archived projects
`Archivedonly`	List only archived projects, regardless of includeArchived
`Response Type`	N/A

POST listProviders_3

/api2/v2/projects/{projectUid}/providers/suggest

Get suggested providers

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

PATCH patchProject

/api2/v1/projects/{projectUid}

Edit project

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

Options (6)

Option Name	Description
`Name`	N/A
`Status`	N/A
`Purchaseorder`	N/A
`Datedue`	N/A
`Note`	N/A
`Archived`	N/A

GET relevantTermBases

/api2/v1/projects/{projectUid}/termBases/relevant

List project relevant term bases

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Content-type`	N/A
`Name`	N/A
`Domainname`	N/A
`Clientname`	N/A
`Subdomainname`	N/A
`Targetlangs`	N/A
`Strictlangmatching`	N/A
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 50, default 50
`Response Type`	N/A

GET relevantTransMemoriesForProject

/api2/v1/projects/{projectUid}/transMemories/relevant

List project relevant translation memories

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Name`	N/A
`Domainname`	N/A
`Clientname`	N/A
`Subdomainname`	N/A
`Targetlangs`	N/A
`Strictlangmatching`	N/A
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 50, default 50
`Response Type`	N/A

POST searchTmSegment

/api2/v1/projects/{projectUid}/transMemories/searchSegmentInProject

Returns at most maxSegments

records with score >= scoreThreshold and at most maxSubsegments records which are subsegment,
i.e. the source text is substring of the query text.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

Options (9)

Option Name	Description
`Segment`	N/A
`Workflowlevel`	N/A
`Scorethreshold`	N/A
`Previoussegment`	N/A
`Nextsegment`	N/A
`Contextkey`	N/A
`Maxsegments`	Default: 5
`Maxsubsegments`	Default: 5
`Targetlangs`	N/A

PUT setFinancialSettings

/api2/v1/projects/{projectUid}/financialSettings

Edit financial settings

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

PUT setMtSettingsForProject

/api2/v1/projects/{projectUid}/mtSettings

This will erase all mtSettings per language for project.

To remove all machine translate settings from project call without a machineTranslateSettings parameter.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

PUT setMtSettingsPerLanguageForProject

/api2/v1/projects/{projectUid}/mtSettingsPerLanguage

This will erase mtSettings for project

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

PUT setProjectQASettingsV2

/api2/v2/projects/{projectUid}/qaSettings

Edit quality assurance settings

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Checks`	N/A

POST setProjectStatus

/api2/v1/projects/{projectUid}/setStatus

Edit project status

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Status`	N/A

PUT setProjectTermBases

/api2/v1/projects/{projectUid}/termBases

Edit term bases

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Targetlang`	N/A

PUT setProjectTransMemoriesV3

/api2/v3/projects/{projectUid}/transMemories

If user wants to edit “All target languages” or "All workflow steps”,

but there are already varied TM settings for individual languages or steps,
then the user risks to overwrite these individual choices.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

PUT updateFileNamingSettings

/api2/v1/projects/{projectUid}/fileNamingSettings

Update file naming settings for project

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Renamecompleted`	N/A
`Completedfilepattern`	N/A
`Targetfolderpath`	N/A

PUT updateProjectPreTranslateSettingsV4

/api2/v4/projects/{projectUid}/preTranslateSettings

Update project pre-translate settings

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

Options (5)

Option Name	Description
`Pretranslateonjobcreation`	Pre-translate & set job to completed: Pre-translate on job creation. Default: false
`Setjobstatuscompleted`	Pre-translate & set job to completed: Set job to completed once pre-translated. Default: false
`Setjobstatuscompletedwhenconfirmed`	Pre-translate & set job to completed when all segments confirmed: Set job to completed once pre-translated and all segments are confirmed. Default: false
`Setprojectstatuscompleted`	Pre-translate & set job to completed: Set project to completed once all jobs pre-translated. Default: false
`Overwriteexistingtranslations`	Overwrite existing translations in target segments. Default: false

Provider

POST listProviders_4

/api2/v2/projects/{projectUid}/jobs/{jobUid}/providers/suggest

Get suggested providers

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Jobuid`	N/A
`Response Type`	N/A

Quality Assurance (26)

POST addIgnoredWarnings

/api2/v1/projects/{projectUid}/jobs/{jobUid}/qualityAssurances/ignoredWarnings

Add ignored warnings

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Jobuid`	N/A
`Response Type`	N/A

POST addIgnoredWarningsV2

/api2/v2/projects/{projectUid}/jobs/qualityAssurances/ignoredWarnings

Add ignored warnings

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

POST createLqaProfile

/api2/v1/lqa/profiles

Create LQA profile

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Name`	N/A

DELETE deleteIgnoredWarnings

/api2/v1/projects/{projectUid}/jobs/{jobUid}/qualityAssurances/ignoredWarnings

Delete ignored warnings

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Jobuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

DELETE deleteIgnoredWarningsV2

/api2/v2/projects/{projectUid}/jobs/qualityAssurances/ignoredWarnings

Delete ignored warnings

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

DELETE deleteLqaProfile

/api2/v1/lqa/profiles/{profileUid}

Delete LQA profile

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Profileuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

POST duplicateProfile

/api2/v1/lqa/profiles/{profileUid}/duplicate

Duplicate LQA profile

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Profileuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

GET enabledQualityChecksForJob

/api2/v2/projects/{projectUid}/jobs/{jobUid}/qualityAssurances/settings

Returns enabled quality assurance checks and settings for job.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Jobuid`	N/A
`Response Type`	N/A

GET enabledQualityChecksForProject

/api2/v2/projects/{projectUid}/jobs/qualityAssurances/settings

Returns enabled quality assurance checks and settings.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

GET getLqaProfile

/api2/v1/lqa/profiles/{profileUid}

Get LQA profile details

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Profileuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

GET getLqaProfileAuthors

/api2/v1/lqa/profiles/authors

Get list of LQA profile authors

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Content-type`	N/A
`Response Type`	N/A

GET getLqaProfileAuthorsV2

/api2/v2/lqa/profiles/authors

Get list of LQA profile authors

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 50, default 20
`Response Type`	N/A

GET getLqaProfileDefaultValues

/api2/v1/lqa/profiles/defaultValues

Get LQA profile default values

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Content-type`	N/A
`Response Type`	N/A

GET getLqaProfiles

/api2/v1/lqa/profiles

GET list LQA profiles

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Content-type`	N/A
`Name`	Name of LQA profiles, it is used for filter the list by name
`Createdby`	It is used for filter the list by who created the profile
`Datecreated`	It is used for filter the list by date created
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 50, default 20
`Sort`	N/A
`Order`	N/A
`Response Type`	N/A

GET getQaSettingsForJobPartV4

/api2/v4/projects/{projectUid}/jobs/{jobUid}/qualityAssurances/settings

Returns enabled quality assurance checks and settings for job.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Jobuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

GET getQaSettingsForProjectV4

/api2/v4/projects/{projectUid}/jobs/qualityAssurances/settings

Returns enabled quality assurance checks and settings.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

POST makeDefault

/api2/v1/lqa/profiles/{profileUid}/default

Make LQA profile default

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Profileuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

POST runQaAndSaveV4

/api2/v4/projects/{projectUid}/jobs/qualityAssurances/segments/{segmentId}/runWithUpdate

By default runs only fast running checks.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Segmentid`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

POST runQaForJobPartV3

/api2/v3/projects/{projectUid}/jobs/{jobUid}/qualityAssurances/run

Call "Get QA settings" endpoint to get the list of enabled QA checks

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Jobuid`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Maxqawarningscount`	Maximum number of QA warnings in result, default: 100. For efficiency reasons QA warnings are processed with minimum segments chunk size 10, therefore slightly more warnings are returned.
`Warningtypes`	N/A

POST runQaForJobPartV4

/api2/v4/projects/{projectUid}/jobs/{jobUid}/qualityAssurances/run

Call "Get QA settings" endpoint to get the list of enabled QA checks

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Jobuid`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Maxqawarningscount`	Maximum number of QA warnings in result, default: 100. For efficiency reasons QA warnings are processed with minimum segments chunk size 10, therefore slightly more warnings are returned.
`Warningtypes`	N/A

POST runQaForJobPartsV3

/api2/v3/projects/{projectUid}/jobs/qualityAssurances/run

Call "Get QA settings" endpoint to get the list of enabled QA checks

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Maxqawarningscount`	Maximum number of QA warnings in result, default: 100. For efficiency reasons QA warnings are processed with minimum segments chunk size 10, therefore slightly more warnings are returned.

POST runQaForJobPartsV4

/api2/v4/projects/{projectUid}/jobs/qualityAssurances/run

Call "Get QA settings" endpoint to get the list of enabled QA checks

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Maxqawarningscount`	Maximum number of QA warnings in result, default: 100. For efficiency reasons QA warnings are processed with minimum segments chunk size 10, therefore slightly more warnings are returned.

POST runQaForSegmentsV3

/api2/v3/projects/{projectUid}/jobs/qualityAssurances/segments/run

By default runs only fast running checks. Source and target language of jobs have to match.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Warningtypes`	When empty only fast checks run
`Maxqawarningscount`	Maximum number of QA warnings in result, default: 100. For efficiency reasons QA warnings are processed with minimum segments chunk size 10, therefore slightly more warnings are returned.

POST runQaForSegmentsV4

/api2/v4/projects/{projectUid}/jobs/qualityAssurances/segments/run

By default runs only fast running checks. Source and target language of jobs have to match.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Warningtypes`	When empty only fast checks run
`Maxqawarningscount`	Maximum number of QA warnings in result, default: 100. For efficiency reasons QA warnings are processed with minimum segments chunk size 10, therefore slightly more warnings are returned.

POST updateIgnoredChecks

/api2/v1/projects/{projectUid}/jobs/{jobUid}/qualityAssurances/ignoreChecks

Edit ignored checks

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Jobuid`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Warningtypes`	N/A

PUT updateLqaProfile

/api2/v1/lqa/profiles/{profileUid}

Update LQA profile

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Profileuid`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Name`	N/A

Quote (4)

POST createQuoteV2

/api2/v2/quotes

Either WorkflowSettings or Units must be sent for billingUnit "Hour".

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Name`	N/A
`Additionalsteps`	N/A

DELETE deleteQuote

/api2/v1/quotes/{quoteUid}

Delete quote

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Quoteuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

POST emailQuotes

/api2/v1/quotes/email

Email quotes

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Subject`	N/A
`Body`	N/A
`Cc`	N/A
`Bcc`	N/A

GET get_2

/api2/v1/quotes/{quoteUid}

Get quote

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Quoteuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

SCIM (10)

POST createUserSCIM

/api2/v1/scim/Users

Supported schema: "urn:ietf:params:scim:schemas:core:2.0:User"

Create active user:

JSON

{
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
    ],
    "active": true,
    "userName": "john.doe",
    "emails": [
        {
            "primary": true,
            "value": "john.doe@example.com",
            "type": "work"
        }
    ],
    "name": {
        "givenName": "John",
        "familyName": "Doe"
    }
}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Authorization`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Id`	N/A
`Username`	N/A
`Active`	Default: true

DELETE deleteUserScim

/api2/v1/scim/Users/{userId}

Delete user using SCIM

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Userid`	N/A
`Authorization`	N/A
`Response Type`	N/A

PUT editUser

/api2/v1/scim/Users/{userId}

Edit user using SCIM

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Userid`	N/A
`Authorization`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Id`	N/A
`Username`	N/A
`Active`	Default: true

GET getResourceTypes

/api2/v1/scim/ResourceTypes

List the types of SCIM Resources available

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

GET getSchemaByUrn

/api2/v1/scim/Schemas/{schemaUrn}

Get supported SCIM Schema by urn

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Schemaurn`	N/A
`Response Type`	N/A

GET getSchemas

/api2/v1/scim/Schemas

Get supported SCIM Schemas

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

GET getScimUser

/api2/v1/scim/Users/{userId}

Get user

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Userid`	N/A
`Authorization`	N/A
`Response Type`	N/A

GET getServiceProviderConfigDto

/api2/v1/scim/ServiceProviderConfig

Retrieve the Service Provider's Configuration

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

PATCH patchUser

/api2/v1/scim/Users/{userId}

Patch user using SCIM

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Userid`	N/A
`Authorization`	N/A
`Response Type`	N/A

GET searchUsers

/api2/v1/scim/Users

This operation supports SCIM Filter,
SCIM attributes and
SCIM sort

Supported attributes:

id
active
userName
name.givenName
name.familyName
emails.value
meta.created

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Authorization`	N/A
`Filter`	See method description
`Attributes`	See method description
`Sortby`	See method description
`Sortorder`	See method description
`Startindex`	The 1-based index of the first search result. Default 1
`Count`	Non-negative Integer. Specifies the desired maximum number of search results per page; e.g., 10.
`Response Type`	N/A

Segmentation Rules (5)

POST createSegmentationRule

/api2/v1/segmentationRules

Creates new Segmentation Rule with file and segRule JSON Object as header parameter. The same object is used for GET action.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Segrule`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

DELETE deletesSegmentationRule

/api2/v1/segmentationRules/{segRuleId}

Delete segmentation rule

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Segruleid`	N/A
`Content-type`	N/A
`Response Type`	N/A

GET getListOfSegmentationRules

/api2/v1/segmentationRules

List segmentation rules

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Locales`	N/A
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 50, default 50
`Response Type`	N/A

GET getSegmentationRule

/api2/v1/segmentationRules/{segRuleId}

Get segmentation rule

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Segruleid`	N/A
`Response Type`	N/A

PUT updatesSegmentationRule

/api2/v1/segmentationRules/{segRuleId}

Edit segmentation rule

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Segruleid`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Name`	N/A
`Primary`	Default: false

Spell Check (4)

POST addWord

/api2/v1/spellCheck/words

Add word to dictionary

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Lang`	N/A
`Word`	N/A

POST check

/api2/v1/spellCheck/check

Spell check using the settings of the user's organization

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Lang`	N/A
`Texts`	N/A
`Referencetexts`	N/A
`Zerolengthseparator`	N/A

POST checkByJob

/api2/v1/spellCheck/check/{jobUid}

Spell check using the settings from the project of the job

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobuid`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Lang`	N/A
`Texts`	N/A
`Referencetexts`	N/A
`Zerolengthseparator`	N/A

POST suggest

/api2/v1/spellCheck/suggest

Spell check suggest using the users's spell check dictionary

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Lang`	N/A
`Words`	N/A
`Referencetexts`	N/A

SubDomain (5)

POST createSubDomain

/api2/v1/subDomains

Create subdomain

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Name`	N/A

DELETE deleteSubDomain

/api2/v1/subDomains/{subDomainUid}

Delete subdomain

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Subdomainuid`	N/A
`Response Type`	N/A

GET getSubDomain

/api2/v1/subDomains/{subDomainUid}

Get subdomain

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Subdomainuid`	N/A
`Response Type`	N/A

GET listSubDomains

/api2/v1/subDomains

List subdomains

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Name`	N/A
`Createdby`	Uid of user
`Sort`	N/A
`Order`	N/A
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 50, default 50
`Response Type`	N/A

PUT updateSubDomain

/api2/v1/subDomains/{subDomainUid}

Edit subdomain

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Subdomainuid`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Name`	N/A

Supported Languages

GET listOfLanguages

/api2/v1/languages

List supported languages

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Active`	N/A
`Response Type`	N/A

Term Base (27)

POST browseTerms

/api2/v1/termBases/{termBaseUid}/browse

Browse term base

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Termbaseuid`	N/A
`Response Type`	N/A

Options (5)

Option Name	Description
`Querylang`	N/A
`Query`	N/A
`Status`	N/A
`Pagenumber`	N/A
`Pagesize`	N/A

DELETE clearTermBase

/api2/v1/termBases/{termBaseUid}/terms

Deletes all terms

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Termbaseuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

POST createConcept

/api2/v1/termBases/{termBaseUid}/concepts

Create concept

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Termbaseuid`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Definition`	N/A
`Url`	N/A
`Conceptnote`	N/A

POST createTerm

/api2/v1/termBases/{termBaseUid}/terms

Set conceptId to assign the term to an existing concept, otherwise a new concept will be created.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Termbaseuid`	N/A
`Response Type`	N/A

Options (15)

Option Name	Description
`Text`	N/A
`Lang`	N/A
`Casesensitive`	Default: false
`Exactmatch`	Default: false
`Forbidden`	Default: false
`Preferred`	Default: false
`Status`	N/A
`Conceptid`	N/A
`Usage`	N/A
`Note`	N/A
`Shorttranslation`	N/A
`Termtype`	N/A
`Partofspeech`	N/A
`Gender`	N/A
`Number`	N/A

POST createTermBase

/api2/v1/termBases

Create term base

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Name`	N/A
`Langs`	N/A
`Note`	N/A

POST createTermByJob

/api2/v1/projects/{projectUid}/jobs/{jobUid}/termBases/createByJob

Create new term in the write term base assigned to the job

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobuid`	N/A
`Projectuid`	N/A
`Response Type`	N/A

DELETE deleteConcept

/api2/v1/termBases/{termBaseUid}/concepts/{conceptId}

Delete concept

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Termbaseuid`	N/A
`Conceptid`	N/A
`Content-type`	N/A
`Response Type`	N/A

DELETE deleteConcepts

/api2/v1/termBases/{termBaseUid}/concepts

Delete concepts

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Termbaseuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

DELETE deleteTerm

/api2/v1/termBases/{termBaseUid}/terms/{termId}

Delete term

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Termbaseuid`	N/A
`Termid`	N/A
`Content-type`	N/A
`Response Type`	N/A

DELETE deleteTermBase

/api2/v1/termBases/{termBaseUid}

Delete term base

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Termbaseuid`	N/A
`Content-type`	N/A
`Purge`	purge=false - the Termbase is can later be restored, "purge=true - the Termbase is completely deleted and cannot be restored
`Response Type`	N/A

GET exportTermBase

/api2/v1/termBases/{termBaseUid}/export

Export term base

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Termbaseuid`	N/A
`Content-type`	N/A
`Format`	N/A
`Charset`	N/A
`Termstatus`	N/A
`Response Type`	N/A

GET getConcept

/api2/v1/termBases/{termBaseUid}/concepts/{conceptUid}

Get concept

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Termbaseuid`	N/A
`Conceptuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

GET getLastBackgroundTask

/api2/v1/termBases/{termBaseUid}/lastBackgroundTask

Last import status

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Termbaseuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

GET getTerm

/api2/v1/termBases/{termBaseUid}/terms/{termId}

Get term

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Termbaseuid`	N/A
`Termid`	N/A
`Content-type`	N/A
`Response Type`	N/A

GET getTermBase

/api2/v1/termBases/{termBaseUid}

Get term base

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Termbaseuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

GET getTermBaseMetadata

/api2/v1/termBases/{termBaseUid}/metadata

Get term base metadata

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Termbaseuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

POST importTermBase

/api2/v1/termBases/{termBaseUid}/upload

Terms can be imported from XLS/XLSX and TBX file formats into a term base.
See Phrase Help Center

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Content-disposition`	must match pattern ((inline\|attachment); )?filename\*=UTF-8''(.+)
`Termbaseuid`	N/A
`Charset`	N/A
`Strictlangmatching`	N/A
`Updateterms`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

POST importTermBaseV2

/api2/v2/termBases/{termBaseUid}/upload

Terms can be imported from XLS/XLSX and TBX file formats into a term base.
See Phrase Help Center

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Content-disposition`	must match pattern ((inline\|attachment); )?filename\*=UTF-8''(.+)
`Termbaseuid`	N/A
`Charset`	N/A
`Strictlangmatching`	N/A
`Updateterms`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

GET listConcepts

/api2/v1/termBases/{termBaseUid}/concepts

List concepts

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Termbaseuid`	N/A
`Content-type`	N/A
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 50, default 50
`Response Type`	N/A

GET listTermBases

/api2/v1/termBases

List term bases

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Content-type`	N/A
`Name`	N/A
`Lang`	Language of the term base
`Clientid`	N/A
`Domainid`	N/A
`Subdomainid`	N/A
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 50, default 50
`Response Type`	N/A

GET listTermsOfConcept

/api2/v1/termBases/{termBaseUid}/concepts/{conceptId}/terms

Get terms of concept

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Termbaseuid`	N/A
`Conceptid`	N/A
`Content-type`	N/A
`Response Type`	N/A

POST searchTerms

/api2/v1/termBases/{termBaseUid}/search

Search term base

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Termbaseuid`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Targetlangs`	N/A
`Sourcelang`	N/A
`Query`	N/A
`Status`	N/A

POST searchTermsByJobV2

/api2/v2/projects/{projectUid}/jobs/{jobUid}/termBases/searchByJob

Search all read term bases assigned to the job

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobuid`	N/A
`Projectuid`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Query`	N/A
`Count`	Default: 15
`Offset`	Default: 0
`Reverse`	Default: false

POST searchTermsInTextByJobV2

/api2/v2/projects/{projectUid}/jobs/{jobUid}/termBases/searchInTextByJob

Search in text in all read term bases assigned to the job

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Jobuid`	N/A
`Projectuid`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Text`	N/A
`Reverse`	Default: false
`Zerolengthseparator`	N/A

PUT updateConcept

/api2/v1/termBases/{termBaseUid}/concepts/{conceptUid}

Update concept

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Termbaseuid`	N/A
`Conceptuid`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Definition`	N/A
`Url`	N/A
`Conceptnote`	N/A

PUT updateTerm

/api2/v1/termBases/{termBaseUid}/terms/{termId}

Edit term

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Termbaseuid`	N/A
`Termid`	N/A
`Response Type`	N/A

Options (14)

Option Name	Description
`Text`	N/A
`Lang`	N/A
`Casesensitive`	Default: false
`Exactmatch`	Default: false
`Forbidden`	Default: false
`Preferred`	Default: false
`Status`	N/A
`Usage`	N/A
`Note`	N/A
`Shorttranslation`	N/A
`Termtype`	N/A
`Partofspeech`	N/A
`Gender`	N/A
`Number`	N/A

PUT updateTermBase

/api2/v1/termBases/{termBaseUid}

It is possible to add new languages only

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Termbaseuid`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Name`	N/A
`Langs`	N/A
`Note`	N/A

Translation Memory (25)

POST addTargetLangToTransMemory

/api2/v1/transMemories/{transMemoryUid}/targetLanguages

Add target language to translation memory

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Transmemoryuid`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Language`	N/A

DELETE bulkDeleteTransMemories

/api2/v1/transMemories/bulk

Delete translation memories (batch)

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Content-type`	N/A
`Response Type`	N/A

DELETE clearTransMemory

/api2/v1/transMemories/{transMemoryUid}/segments

Delete all segments

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Transmemoryuid`	N/A
`Response Type`	N/A

DELETE clearTransMemoryV2

/api2/v2/transMemories/{transMemoryUid}/segments

This call is asynchronous, use this API to check the result

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Transmemoryuid`	N/A
`Response Type`	N/A

POST createTransMemory

/api2/v1/transMemories

Create translation memory

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Name`	N/A
`Sourcelang`	N/A
`Targetlangs`	N/A
`Note`	N/A

DELETE deleteSourceAndTranslations

/api2/v1/transMemories/{transMemoryUid}/segments/{segmentId}

Not recommended for bulk removal of segments

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Transmemoryuid`	N/A
`Segmentid`	N/A
`Response Type`	N/A

DELETE deleteTransMemory

/api2/v1/transMemories/{transMemoryUid}

Delete translation memory

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Transmemoryuid`	N/A
`Purge`	N/A
`Response Type`	N/A

DELETE deleteTranslation

/api2/v1/transMemories/{transMemoryUid}/segments/{segmentId}/lang/{lang}

Not recommended for bulk removal of segments

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Transmemoryuid`	N/A
`Segmentid`	N/A
`Lang`	N/A
`Response Type`	N/A

GET downloadCleanedTM

/api2/v1/transMemories/downloadCleaned/{asyncRequestId}

Download cleaned TM

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Asyncrequestid`	Request ID
`Response Type`	N/A

GET downloadSearchResult

/api2/v1/transMemories/downloadExport/{asyncRequestId}

Download export

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Asyncrequestid`	Request ID
`Format`	N/A
`Fields`	Fields to include in exported XLSX
`Response Type`	N/A

PUT editTransMemory

/api2/v1/transMemories/{transMemoryUid}

Edit translation memory

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Transmemoryuid`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Name`	N/A
`Targetlangs`	New target languages to add. No languages can be removed
`Note`	N/A

POST exportByQueryAsync

/api2/v1/transMemories/{transMemoryUid}/exportByQueryAsync

Use this API to download result

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Transmemoryuid`	N/A
`Response Type`	N/A

Options (9)

Option Name	Description
`Exporttargetlangs`	N/A
`Queries`	N/A
`Querylangs`	N/A
`Createdatmin`	N/A
`Createdatmax`	N/A
`Modifiedatmin`	N/A
`Modifiedatmax`	N/A
`Filename`	N/A
`Callbackurl`	N/A

POST exportCleanedTMs

/api2/v1/transMemories/extractCleaned

Returns a ZIP file containing the cleaned translation memories in the specified outputFormat.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Uids`	N/A
`Outputformat`	N/A
`Preserveratio`	N/A
`Targetlangs`	N/A

POST exportV2

/api2/v2/transMemories/{transMemoryUid}/export

Use this API to download result

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Transmemoryuid`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Exporttargetlangs`	N/A
`Callbackurl`	N/A

GET getBackgroundTasksForTransMems

/api2/v1/transMemories/{transMemoryUid}/lastBackgroundTask

Get last task information

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Transmemoryuid`	N/A
`Response Type`	N/A

GET getMetadata

/api2/v1/transMemories/{transMemoryUid}/metadata

Get translation memory metadata

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Transmemoryuid`	N/A
`Bylanguage`	N/A
`Response Type`	N/A

GET getRelatedProjects

/api2/v1/transMemories/{transMemoryUid}/relatedProjects

List related projects

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Transmemoryuid`	N/A
`Name`	Project name to filter by
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 50, default 50
`Sort`	N/A
`Order`	N/A
`Response Type`	N/A

GET getTransMemory

/api2/v1/transMemories/{transMemoryUid}

Get translation memory

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Transmemoryuid`	N/A
`Response Type`	N/A

POST importTransMemoryV2

/api2/v2/transMemories/{transMemoryUid}/import

Import TMX

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Transmemoryuid`	N/A
`Content-disposition`	must match pattern ((inline\|attachment); )?filename\*=UTF-8''(.+)
`Content-length`	N/A
`Strictlangmatching`	N/A
`Stripnativecodes`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

POST insertToTransMemory

/api2/v1/transMemories/{transMemoryUid}/segments

Insert segment

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Transmemoryuid`	N/A
`Response Type`	N/A

Options (5)

Option Name	Description
`Targetlang`	N/A
`Sourcesegment`	N/A
`Targetsegment`	N/A
`Previoussourcesegment`	N/A
`Nextsourcesegment`	N/A

GET listTransMemories

/api2/v1/transMemories

List translation memories

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Name`	N/A
`Sourcelang`	N/A
`Targetlang`	N/A
`Clientid`	N/A
`Domainid`	N/A
`Subdomainid`	N/A
`Businessunitid`	N/A
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 50, default 50
`Response Type`	N/A

POST search

/api2/v1/transMemories/{transMemoryUid}/search

Search translation memory (sync)

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Transmemoryuid`	N/A
`Response Type`	N/A

Options (7)

Option Name	Description
`Query`	N/A
`Sourcelang`	N/A
`Targetlangs`	N/A
`Previoussegment`	N/A
`Nextsegment`	N/A
`Trimquery`	Remove leading and trailing whitespace from query. Default: true
`Phrasequery`	Return both wildcard and exact search results. Default: true

POST searchSegmentByJob

/api2/v1/projects/{projectUid}/jobs/{jobUid}/transMemories/searchSegment

Returns at most maxSegments

records with score >= scoreThreshold and at most maxSubsegments records which are subsegment,
i.e. the source text is substring of the query text.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Jobuid`	N/A
`Response Type`	N/A

Options (8)

Option Name	Description
`Segment`	N/A
`Workflowlevel`	N/A
`Scorethreshold`	N/A
`Previoussegment`	N/A
`Nextsegment`	N/A
`Contextkey`	N/A
`Maxsegments`	Default: 5
`Maxsubsegments`	Default: 5

PUT updateTranslation

/api2/v1/transMemories/{transMemoryUid}/segments/{segmentId}

Edit segment

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Transmemoryuid`	N/A
`Segmentid`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Lang`	N/A
`Text`	N/A

POST wildcardSearch

/api2/v1/transMemories/{transMemoryUid}/wildCardSearch

Wildcard search

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Transmemoryuid`	N/A
`Response Type`	N/A

Options (6)

Option Name	Description
`Query`	N/A
`Sourcelang`	N/A
`Targetlangs`	N/A
`Count`	N/A
`Offset`	N/A
`Sourcelangs`	N/A

Translation (3)

POST humanTranslate

/api2/v1/projects/{projectUid}/jobs/humanTranslate

Human translate (Gengo or Unbabel)

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

Options (5)

Option Name	Description
`Comment`	N/A
`Glossaryid`	N/A
`Usepreferredtranslators`	N/A
`Level`	N/A
`Callbackurl`	N/A

POST machineTranslationJob

/api2/v1/projects/{projectUid}/jobs/{jobUid}/translations/translateWithMachineTranslation

Configured machine translate settings is used

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Jobuid`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Sourcetexts`	N/A

POST preTranslateV3

/api2/v3/projects/{projectUid}/jobs/preTranslate

Pre-translate job

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Projectuid`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Segmentfilters`	N/A
`Useprojectpretranslatesettings`	If pre-translate settings from project should be used. If true, preTranslateSettings values are ignored. Default: false
`Callbackurl`	N/A

User (15)

POST cancelDeletion

/api2/v1/users/{userUid}/undelete

Restore user

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Useruid`	N/A
`Content-type`	N/A
`Response Type`	N/A

POST createUserV3

/api2/v3/users

Create user

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Sendinvitation`	N/A
`Response Type`	N/A

Options (10)

Option Name	Description
`Username`	N/A
`Firstname`	N/A
`Lastname`	N/A
`Email`	N/A
`Password`	N/A
`Role`	N/A
`Timezone`	N/A
`Receivenewsletter`	Default: true
`Note`	N/A
`Active`	Default: true

DELETE deleteUser

/api2/v1/users/{userUid}

Delete user

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Useruid`	N/A
`Content-type`	N/A
`Response Type`	N/A

POST disableTwoFactorAuthV3

/api2/v3/users/{userUid}/disableTwoFactorAuth

Disable two-factor authentication

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Useruid`	N/A
`Response Type`	N/A

GET getListOfUsersFiltered

/api2/v1/users

List users

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Content-type`	N/A
`Firstname`	Filter for first name, that starts with value
`Lastname`	Filter for last name, that starts with value
`Name`	Filter for last name or first name, that starts with value
`Username`	N/A
`Email`	N/A
`Nameoremail`	Filter for last name, first name or email starting with the value
`Role`	N/A
`Includedeleted`	N/A
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 50, default 50
`Sort`	N/A
`Order`	N/A
`Response Type`	N/A

GET getUserV3

/api2/v3/users/{userUid}

Get user

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Useruid`	N/A
`Response Type`	N/A

GET listAssignedProjects

/api2/v1/users/{userUid}/projects

List projects in which the user is assigned to at least one job matching the criteria

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Useruid`	N/A
`Content-type`	N/A
`Status`	Status of the assigned jobs
`Targetlang`	Target language of the assigned jobs
`Workflowstepid`	N/A
`Dueinhours`	Number of hours in which the assigned jobs are due. Use -1 for jobs that are overdue.
`Filename`	N/A
`Projectname`	N/A
`Pagenumber`	N/A
`Pagesize`	N/A
`Response Type`	N/A

GET listJobs

/api2/v1/users/{userUid}/jobs

List assigned jobs

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Useruid`	N/A
`Content-type`	N/A
`Status`	N/A
`Projectuid`	N/A
`Targetlang`	N/A
`Workflowstepid`	N/A
`Dueinhours`	-1 for jobs that are overdue
`Filename`	N/A
`Pagenumber`	N/A
`Pagesize`	N/A
`Response Type`	N/A

GET listTargetLangs

/api2/v1/users/{userUid}/targetLangs

List assigned target languages

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Useruid`	N/A
`Content-type`	N/A
`Status`	N/A
`Projectuid`	N/A
`Workflowstepid`	N/A
`Dueinhours`	-1 for jobs that are overdue
`Filename`	N/A
`Pagenumber`	N/A
`Pagesize`	N/A
`Response Type`	N/A

GET listWorkflowSteps

/api2/v1/users/{userUid}/workflowSteps

List assigned workflow steps

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Useruid`	N/A
`Content-type`	N/A
`Status`	N/A
`Projectuid`	N/A
`Targetlang`	N/A
`Dueinhours`	-1 for jobs that are overdue
`Filename`	N/A
`Pagenumber`	N/A
`Pagesize`	N/A
`Response Type`	N/A

GET loginActivity

/api2/v1/users/{userUid}/loginStatistics

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Useruid`	N/A
`Content-type`	N/A
`Response Type`	N/A

POST sendLoginInfo

/api2/v1/users/{userUid}/emailLoginInformation

Send login information

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Useruid`	N/A
`Content-type`	N/A
`Response Type`	N/A

POST updatePassword

/api2/v1/users/{userUid}/updatePassword

Password length must be between 8 and 255
Password must not be same as the username

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Useruid`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Password`	N/A

PUT updateUserV3

/api2/v3/users/{userUid}

Edit user

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Useruid`	N/A
`Response Type`	N/A

Options (9)

Option Name	Description
`Username`	N/A
`Firstname`	N/A
`Lastname`	N/A
`Email`	N/A
`Role`	N/A
`Timezone`	N/A
`Receivenewsletter`	Default: true
`Note`	N/A
`Active`	Default: true

GET user-lastLogins

/api2/v1/users/lastLogins

List last login dates

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Content-type`	N/A
`Username`	N/A
`Role`	N/A
`Sort`	N/A
`Order`	N/A
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 100, default 100
`Response Type`	N/A

Vendor (3)

POST createVendor

/api2/v1/vendors

Create vendor

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Vendortoken`	N/A
`Sourcelocales`	N/A
`Targetlocales`	N/A

GET getVendor

/api2/v1/vendors/{vendorUid}

Get vendor

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Vendoruid`	N/A
`Response Type`	N/A

GET listVendors

/api2/v1/vendors

List vendors

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 50, default 50
`Name`	Name or the vendor, for filtering
`Response Type`	N/A

Webhook (10)

POST createWebHookV2

/api2/v2/webhooks

Create webhook

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (6)

Option Name	Description
`Name`	N/A
`Url`	N/A
`Events`	N/A
`Secrettoken`	N/A
`Hidden`	Default: false
`Status`	Default: ENABLED

DELETE deleteWebHookV2

/api2/v2/webhooks/{webHookUid}

Delete webhook

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Webhookuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

GET getWebHookListV2

/api2/v2/webhooks

Lists webhooks

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Content-type`	N/A
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 50, default 50
`Name`	Filter by webhook name
`Status`	Filter by enabled/disabled status
`Url`	Filter by webhook URL
`Events`	Filter by webhook events, any match is included
`Createdby`	Filter by webhook creators UIDs
`Modifiedby`	Filter by webhook updaters UIDs
`Sortfield`	Sort by this field
`Sorttrend`	Sort direction
`Response Type`	N/A

GET getWebHookV2

/api2/v2/webhooks/{webHookUid}

Get webhook

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Webhookuid`	N/A
`Content-type`	N/A
`Response Type`	N/A

GET getWebhookCallsList

/api2/v1/webhooksCalls

Lists webhook calls

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 50, default 50
`Events`	List of Webhook events to filter by
`Status`	Status of Webhook calls to filter by
`Webhookuid`	UID of Webhook to filter by
`Parentuid`	UID of parent webhook call to filter by
`Response Type`	N/A

GET getWebhookPreviews

/api2/v2/webhooks/previews

Get webhook body previews

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Content-type`	N/A
`Events`	Filter by webhook events
`Response Type`	N/A

POST replayLast

/api2/v1/webhooksCalls/replay/latest

Replays specified number of last Webhook calls from oldest to the newest one

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Numberofcalls`	Number of calls to be replayed
`Events`	List of Webhook events to filter by
`Status`	Status of Webhook calls to filter by
`Response Type`	N/A

POST replayWebhookCalls

/api2/v1/webhooksCalls/replay

Replays given list of Webhook Calls in specified order in the request

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

POST sendTestWebhook

/api2/v2/webhooks/{webhookUid}/test

Send test webhook

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Webhookuid`	UID of the webhook
`Event`	Event of test webhook
`Content-type`	N/A
`Response Type`	N/A

PUT updateWebHookV2

/api2/v2/webhooks/{webHookUid}

Edit webhook

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Webhookuid`	N/A
`Response Type`	N/A

Options (6)

Option Name	Description
`Name`	N/A
`Url`	N/A
`Events`	N/A
`Secrettoken`	N/A
`Hidden`	Default: false
`Status`	Default: ENABLED

Workflow Step (3)

POST createWFStep

/api2/v1/workflowSteps

Create workflow step

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Name`	Name of the lqa workflow step
`Order`	Order value
`Lqaenabled`	Default: false
`Abbr`	Abbreviation

PUT editWFStep

/api2/v1/workflowSteps/{workflowStepUid}

Edit workflow step

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Workflowstepuid`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Name`	Name of the lqa workflow step
`Order`	Order value
`Lqaenabled`	Default: false
`Abbr`	Abbreviation

GET listWFSteps

/api2/v1/workflowSteps

List workflow steps

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Pagenumber`	Page number, starting with 0, default 0
`Pagesize`	Page size, accepts values between 1 and 50, default 50
`Sort`	N/A
`Order`	N/A
`Name`	Name of the workflow step
`Abbr`	Abbreviation of workflow step
`Response Type`	N/A

Workflow changes

POST downloadWorkflowChanges

/api2/v2/jobs/workflowChanges

Download workflow changes report

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

XML Assistant

GET listXmlAssistantProfiles

/api2/v1/xmlAssistantProfiles

Get XML assistant profiles for organization

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Name`	N/A
`Description`	N/A
`Createdby`	N/A
`Updatedby`	N/A
`Createdat`	N/A
`Updatedat`	N/A
`Search`	N/A
`Pagenumber`	N/A
`Pagesize`	N/A
`Sort`	N/A
`Order`	N/A
`Response Type`	N/A