Pre-translate job

curl --request POST \
  --url https://cloud.memsource.com/web/api2/v3/projects/{projectUid}/jobs/preTranslate \
  --header 'Content-Type: application/json' \
  --data '
{
  "jobs": [
    {
      "uid": "<string>"
    }
  ],
  "segmentFilters": [
    "LOCKED"
  ],
  "useProjectPreTranslateSettings": true,
  "callbackUrl": "<string>",
  "preTranslateSettings": {
    "autoPropagateRepetitions": true,
    "confirmRepetitions": true,
    "setJobStatusCompleted": true,
    "setJobStatusCompletedWhenConfirmed": true,
    "setProjectStatusCompleted": true,
    "overwriteExistingTranslations": true,
    "translationMemorySettings": {
      "useTranslationMemory": true,
      "translationMemoryThreshold": 0.505,
      "confirm100PercentMatches": true,
      "confirm101PercentMatches": true,
      "lock100PercentMatches": true,
      "lock101PercentMatches": true
    },
    "machineTranslationSettings": {
      "useMachineTranslation": true,
      "machineTranslationBehavior": "APPLY_MT_ABOVE_THRESHOLD",
      "lock100PercentMatches": true,
      "confirmMatches": true,
      "confirmMatchesThreshold": 0.5,
      "useAltTransOnly": true,
      "mtSuggestOnlyTmBelow": true,
      "mtSuggestOnlyTmBelowThreshold": 0.505
    },
    "nonTranslatableSettings": {
      "preTranslateNonTranslatables": true,
      "confirm100PercentMatches": true,
      "lock100PercentMatches": true
    }
  }
}
'

{
  "asyncRequest": {
    "id": "<string>",
    "createdBy": {
      "firstName": "<string>",
      "lastName": "<string>",
      "userName": "<string>",
      "email": "<string>",
      "role": "SYS_ADMIN",
      "id": "<string>",
      "uid": "<string>"
    },
    "dateCreated": "2023-11-07T05:31:56Z",
    "action": "PRE_ANALYSE",
    "asyncResponse": {
      "dateCreated": "2023-11-07T05:31:56Z",
      "errorCode": "<string>",
      "errorDesc": "<string>",
      "errorDetails": [
        {
          "code": "<string>",
          "args": {},
          "message": "<string>"
        }
      ],
      "warnings": [
        {
          "code": "<string>",
          "args": {},
          "message": "<string>"
        }
      ]
    },
    "parent": "<unknown>",
    "project": {
      "uid": "<string>",
      "name": "<string>"
    }
  },
  "reference": {
    "uid": "<string>",
    "type": "JOB"
  }
}

POST

api2

projects

{projectUid}

jobs

preTranslate

Pre-translate job

curl --request POST \
  --url https://cloud.memsource.com/web/api2/v3/projects/{projectUid}/jobs/preTranslate \
  --header 'Content-Type: application/json' \
  --data '
{
  "jobs": [
    {
      "uid": "<string>"
    }
  ],
  "segmentFilters": [
    "LOCKED"
  ],
  "useProjectPreTranslateSettings": true,
  "callbackUrl": "<string>",
  "preTranslateSettings": {
    "autoPropagateRepetitions": true,
    "confirmRepetitions": true,
    "setJobStatusCompleted": true,
    "setJobStatusCompletedWhenConfirmed": true,
    "setProjectStatusCompleted": true,
    "overwriteExistingTranslations": true,
    "translationMemorySettings": {
      "useTranslationMemory": true,
      "translationMemoryThreshold": 0.505,
      "confirm100PercentMatches": true,
      "confirm101PercentMatches": true,
      "lock100PercentMatches": true,
      "lock101PercentMatches": true
    },
    "machineTranslationSettings": {
      "useMachineTranslation": true,
      "machineTranslationBehavior": "APPLY_MT_ABOVE_THRESHOLD",
      "lock100PercentMatches": true,
      "confirmMatches": true,
      "confirmMatchesThreshold": 0.5,
      "useAltTransOnly": true,
      "mtSuggestOnlyTmBelow": true,
      "mtSuggestOnlyTmBelowThreshold": 0.505
    },
    "nonTranslatableSettings": {
      "preTranslateNonTranslatables": true,
      "confirm100PercentMatches": true,
      "lock100PercentMatches": true
    }
  }
}
'

{
  "asyncRequest": {
    "id": "<string>",
    "createdBy": {
      "firstName": "<string>",
      "lastName": "<string>",
      "userName": "<string>",
      "email": "<string>",
      "role": "SYS_ADMIN",
      "id": "<string>",
      "uid": "<string>"
    },
    "dateCreated": "2023-11-07T05:31:56Z",
    "action": "PRE_ANALYSE",
    "asyncResponse": {
      "dateCreated": "2023-11-07T05:31:56Z",
      "errorCode": "<string>",
      "errorDesc": "<string>",
      "errorDetails": [
        {
          "code": "<string>",
          "args": {},
          "message": "<string>"
        }
      ],
      "warnings": [
        {
          "code": "<string>",
          "args": {},
          "message": "<string>"
        }
      ]
    },
    "parent": "<unknown>",
    "project": {
      "uid": "<string>",
      "name": "<string>"
    }
  },
  "reference": {
    "uid": "<string>",
    "type": "JOB"
  }
}

Path Parameters

projectUid

string

required

Body

application/json

jobs

object[]

required

Jobs to be pre-translated

Required array length: 1 - 100 elements

Show child attributes

jobs.uid

string

required

segmentFilters

enum<string>[]

Available options:

LOCKED,

NOT_LOCKED

useProjectPreTranslateSettings

boolean

If pre-translate settings from project should be used. If true, preTranslateSettings values are ignored. Default: false

callbackUrl

string

preTranslateSettings

object

Pre-translate settings

Show child attributes

preTranslateSettings.autoPropagateRepetitions

boolean

Propagate repetitions. Default: false

preTranslateSettings.confirmRepetitions

boolean

Set segment status to confirmed for: Repetitions. Default: false

preTranslateSettings.setJobStatusCompleted

boolean

Pre-translate & set job to completed: Set job to completed once pre-translated. Default: false

preTranslateSettings.setJobStatusCompletedWhenConfirmed

boolean

Pre-translate & set job to completed when all segments confirmed: Set job to completed once pre-translated and all segments are confirmed. Default: false

preTranslateSettings.setProjectStatusCompleted

boolean

Pre-translate & set job to completed: Set project to completed once all jobs pre-translated. Default: false

preTranslateSettings.overwriteExistingTranslations

boolean

Overwrite existing translations in target segments. Default: false

preTranslateSettings.translationMemorySettings

object

Translation memory related settings

Show child attributes

preTranslateSettings.translationMemorySettings.useTranslationMemory

boolean

Pre-translate from translation memory. Default: true

preTranslateSettings.translationMemorySettings.translationMemoryThreshold

number<double>

Pre-translation threshold percent. Default: 0.7

Required range: 0 < x < 1.01

preTranslateSettings.translationMemorySettings.confirm100PercentMatches

boolean

Set segment status to confirmed for: 100% translation memory matches. Default: false

preTranslateSettings.translationMemorySettings.confirm101PercentMatches

boolean

Set segment status to confirmed for: 101% translation memory matches. Default: false

preTranslateSettings.translationMemorySettings.lock100PercentMatches

boolean

Lock section: 100% translation memory matches. Default: false

preTranslateSettings.translationMemorySettings.lock101PercentMatches

boolean

Lock section: 101% translation memory matches. Default: false

preTranslateSettings.machineTranslationSettings

object

Machine translation related settings

Show child attributes

preTranslateSettings.machineTranslationSettings.useMachineTranslation

boolean

Pre-translate from machine translation. Default: true

preTranslateSettings.machineTranslationSettings.machineTranslationBehavior

enum<string>

Machine translation behavior. Default: APPLY_MT_ABOVE_THRESHOLD

Available options:

APPLY_MT_ABOVE_THRESHOLD,

COMPARE_AND_BEST_MATCH

preTranslateSettings.machineTranslationSettings.lock100PercentMatches

boolean

Lock section: 100% machine translation suggestions. Default: false

preTranslateSettings.machineTranslationSettings.confirmMatches

boolean

Set segment status to confirmed for: machine translation suggestions above confirmMatchesThreshold. Default: false

preTranslateSettings.machineTranslationSettings.confirmMatchesThreshold

number<double>

Machine translation suggestions percent. Default: 1.0

Required range: 0 < x < 1

preTranslateSettings.machineTranslationSettings.useAltTransOnly

boolean

Do not put machine translations to target and use alt-trans fields (alt-trans in mxlf). Default: false

preTranslateSettings.machineTranslationSettings.mtSuggestOnlyTmBelow

boolean

Suggest MT only for segments with a TM match below. Default: true

preTranslateSettings.machineTranslationSettings.mtSuggestOnlyTmBelowThreshold

number<double>

Suggest MT only for segments with a TM match below threshold. Default: 1.0

Required range: 0 < x < 1.01

preTranslateSettings.nonTranslatableSettings

object

Non-translatables related settings

Show child attributes

preTranslateSettings.nonTranslatableSettings.preTranslateNonTranslatables

boolean

Pre-translate non-translatables. Default: true

preTranslateSettings.nonTranslatableSettings.confirm100PercentMatches

boolean

Set segment status to confirmed for: 100% non-translatables. Default: false

preTranslateSettings.nonTranslatableSettings.lock100PercentMatches

boolean

Lock section: 100% non-translatables. Default: false

Response

Accepted

asyncRequest

object

Show child attributes

asyncRequest.id

string

asyncRequest.createdBy

object

Show child attributes

asyncRequest.createdBy.firstName

string

asyncRequest.createdBy.lastName

string

asyncRequest.createdBy.userName

string

asyncRequest.createdBy.email

string

asyncRequest.createdBy.role

enum<string>

Available options:

SYS_ADMIN,

SYS_ADMIN_READ,

ADMIN,

PROJECT_MANAGER,

LINGUIST,

GUEST,

SUBMITTER,

PORTAL_MEMBER

asyncRequest.createdBy.id

string

asyncRequest.createdBy.uid

string

asyncRequest.dateCreated

string<date-time>

asyncRequest.action

enum<string>

Available options:

PRE_ANALYSE,

POST_ANALYSE,

CONTINUOUS_PRE_ANALYSE,

CONTINUOUS_POST_ANALYSE,

COMPARE_ANALYSE,

PARENT_ANALYSE,

PRE_TRANSLATE,

ASYNC_TRANSLATE,

IMPORT_JOB,

IMPORT_FILE,

ALIGN,

EXPORT_TMX_BY_QUERY,

EXPORT_TMX,

IMPORT_TMX,

IMPORT_MXLF_INTO_TM,

IMPORT_TBX,

INSERT_INTO_TM,

DELETE_TM,

CLEAR_TM,

QA,

QA_V3,

UPDATE_CONTINUOUS_JOB,

UPDATE_SOURCE,

UPDATE_TARGET,

EXTRACT_CLEANED_TMS,

GLOSSARY_PUT,

GLOSSARY_DELETE,

CREATE_PROJECT,

EXPORT_COMPLETE_FILE,

IMPORT_ANNOTATIONS,

FILE_FLOW_CONVERTER_IMPORT,

FILE_FLOW_MT_PRETRANSLATE,

FILE_FLOW_QUALITY_ESTIMATION,

AUTO_LQA

asyncRequest.asyncResponse

object

Show child attributes

asyncRequest.asyncResponse.dateCreated

string<date-time>

asyncRequest.asyncResponse.errorCode

string

asyncRequest.asyncResponse.errorDesc

string

asyncRequest.asyncResponse.errorDetails

object[]

Show child attributes

asyncRequest.asyncResponse.errorDetails.code

string

Code, e.g. NOT_FOUND.

asyncRequest.asyncResponse.errorDetails.args

object

Related arguments, e.g. number => "hello world"

Show child attributes

asyncRequest.asyncResponse.errorDetails.args.{key}

object

asyncRequest.asyncResponse.errorDetails.message

string

Optional human-readable message.

asyncRequest.asyncResponse.warnings

object[]

Show child attributes

asyncRequest.asyncResponse.warnings.code

string

Code, e.g. NOT_FOUND.

asyncRequest.asyncResponse.warnings.args

object

Related arguments, e.g. number => "hello world"

Show child attributes

asyncRequest.asyncResponse.warnings.args.{key}

object

asyncRequest.asyncResponse.warnings.message

string

Optional human-readable message.

asyncRequest.parent

any

asyncRequest.project

object

Show child attributes

asyncRequest.project.uid

string

asyncRequest.project.name

string

reference

object

Reference object that is being processed by async request

Show child attributes

reference.uid

string

UID of the object

reference.type

enum<string>

Type of the object

Available options:

JOB

Pre-translate job Search job's translation memories

⌘I

Guides

API Documentation

Pre-translate job

Path Parameters

Body

Response