Skip to main content
POST
/
api2
/
v1
/
analyses
Create analysis
curl --request POST \
  --url https://cloud.memsource.com/web/api2/v1/analyses \
  --header 'Content-Type: application/json' \
  --data '{
  "jobs": [
    {
      "uid": "<string>"
    }
  ],
  "type": "PreAnalyse",
  "includeFuzzyRepetitions": true,
  "separateFuzzyRepetitions": true,
  "includeConfirmedSegments": true,
  "includeNumbers": true,
  "includeLockedSegments": true,
  "countSourceUnits": true,
  "includeTransMemory": true,
  "includeNonTranslatables": true,
  "includeMachineTranslationMatches": true,
  "transMemoryPostEditing": true,
  "nonTranslatablePostEditing": true,
  "machineTranslatePostEditing": true,
  "name": "<string>",
  "netRateScheme": {
    "id": "<string>"
  },
  "compareWorkflowLevel": 8,
  "useProjectAnalysisSettings": true,
  "linguist": {
    "id": "<string>"
  },
  "callbackUrl": "<string>"
}'
{
  "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>"
        }
      ],
      "acceptedSegmentsCount": 123
    },
    "parent": {},
    "project": {
      "name": "<string>",
      "uid": "<string>"
    }
  },
  "analyse": {}
}

Body

application/json
​
jobs
object[]
required

Job uids of jobs from the same project

Required array length: 1 - 100 elements
​
type
enum<string>

default: PreAnalyse

Available options:
PreAnalyse,
PostAnalyse,
Compare
​
includeFuzzyRepetitions
boolean

Default: true

​
separateFuzzyRepetitions
boolean

Default: false

​
includeConfirmedSegments
boolean

Default: true

​
includeNumbers
boolean

Default: true

​
includeLockedSegments
boolean

Default: true

​
countSourceUnits
boolean

Default: true

​
includeTransMemory
boolean

Default: true. Works only for type=PreAnalyse.

​
includeNonTranslatables
boolean

Default: false. Works only for type=PreAnalyse.

​
includeMachineTranslationMatches
boolean

Default: false. Works only for type=PreAnalyse.

​
transMemoryPostEditing
boolean

Default: false. Works only for type=PostAnalyse.

​
nonTranslatablePostEditing
boolean

Default: false. Works only for type=PostAnalyse.

​
machineTranslatePostEditing
boolean

Default: false. Works only for type=PostAnalyse.

​
name
string
Maximum length: 255
​
netRateScheme
object
​
compareWorkflowLevel
integer

Required for type=Compare

Required range: 1 <= x <= 15
​
useProjectAnalysisSettings
boolean

Default: false. Use default project settings. Will be overwritten with setting sent in the API call.

​
linguist
object
​
callbackUrl
string

Response

successful operation

​
asyncRequest
object
​
analyse
object
⌘I