API Documentation
- PUTStart multiple LQA Assessments
- POSTGet multiple LQA Assessments
- DELDiscard multiple ongoing LQA Assessments
- GETDownload LQA Assessment XLSX reports
- POSTSend email(s) with LQA reports
- GETGet sharable link of LQA reports
- GETGet recipients of email with LQA reports
- POSTGet LQA Assessment results
- PUTFinish multiple LQA Assessments
- DELDiscard multiple finished LQA Assessment results
- GETGet LQA Assessment
- POSTStart LQA Assessment
- DELDiscard ongoing LQA Assessment
- PUTFinish LQA Assessment
- POSTRun Auto LQA
- PUT
curl --request POST \
--url https://cloud.memsource.com/web/api2/v1/lqa/assessments \
--header 'Content-Type: application/json' \
--data '
{
"jobParts": [
{
"uid": "<string>"
}
]
}
'{
"assessmentDetails": [
{
"jobPartUid": "<string>",
"assessmentJobPartUid": "<string>",
"requestedJobPartUid": "<string>",
"workflowStep": {
"id": "<string>",
"uid": "<string>",
"name": "<string>",
"abbr": "<string>",
"order": 123,
"lqaEnabled": true
},
"reportCanBeDownloaded": true,
"lqaEnabled": true,
"availability": "NOT_AVAILABLE",
"lqaProfile": {
"uid": "string",
"name": "<string>",
"errorCategories": {
"accuracy": {
"accuracy": {
"enabled": true,
"weight": 1,
"code": 123
},
"addition": {
"enabled": true,
"weight": 1,
"code": 123
},
"omission": {
"enabled": true,
"weight": 1,
"code": 123
},
"mistranslation": {
"enabled": true,
"weight": 1,
"code": 123
},
"underTranslation": {
"enabled": true,
"weight": 1,
"code": 123
},
"untranslated": {
"enabled": true,
"weight": 1,
"code": 123
},
"improperTmMatch": {
"enabled": true,
"weight": 1,
"code": 123
},
"overTranslation": {
"enabled": true,
"weight": 1,
"code": 123
}
},
"fluency": {
"fluency": {
"enabled": true,
"weight": 1,
"code": 123
},
"punctuation": {
"enabled": true,
"weight": 1,
"code": 123
},
"spelling": {
"enabled": true,
"weight": 1,
"code": 123
},
"grammar": {
"enabled": true,
"weight": 1,
"code": 123
},
"grammaticalRegister": {
"enabled": true,
"weight": 1,
"code": 123
},
"inconsistency": {
"enabled": true,
"weight": 1,
"code": 123
},
"crossReference": {
"enabled": true,
"weight": 1,
"code": 123
},
"characterEncoding": {
"enabled": true,
"weight": 1,
"code": 123
}
},
"terminology": {
"terminology": {
"enabled": true,
"weight": 1,
"code": 123
},
"inconsistentWithTb": {
"enabled": true,
"weight": 1,
"code": 123
},
"inconsistentUseOfTerminology": {
"enabled": true,
"weight": 1,
"code": 123
}
},
"style": {
"style": {
"enabled": true,
"weight": 1,
"code": 123
},
"awkward": {
"enabled": true,
"weight": 1,
"code": 123
},
"companyStyle": {
"enabled": true,
"weight": 1,
"code": 123
},
"inconsistentStyle": {
"enabled": true,
"weight": 1,
"code": 123
},
"thirdPartyStyle": {
"enabled": true,
"weight": 1,
"code": 123
},
"unidiomatic": {
"enabled": true,
"weight": 1,
"code": 123
}
},
"localeConvention": {
"localeConvention": {
"enabled": true,
"weight": 1,
"code": 123
},
"addressFormat": {
"enabled": true,
"weight": 1,
"code": 123
},
"dateFormat": {
"enabled": true,
"weight": 1,
"code": 123
},
"currencyFormat": {
"enabled": true,
"weight": 1,
"code": 123
},
"measurementFormat": {
"enabled": true,
"weight": 1,
"code": 123
},
"shortcutKey": {
"enabled": true,
"weight": 1,
"code": 123
},
"telephoneFormat": {
"enabled": true,
"weight": 1,
"code": 123
}
},
"verity": {
"verity": {
"enabled": true,
"weight": 1,
"code": 123
},
"cultureSpecificReference": {
"enabled": true,
"weight": 1,
"code": 123
}
},
"design": {
"design": {
"enabled": true,
"weight": 1,
"code": 123
},
"length": {
"enabled": true,
"weight": 1,
"code": 123
},
"localFormatting": {
"enabled": true,
"weight": 1,
"code": 123
},
"markup": {
"enabled": true,
"weight": 1,
"code": 123
},
"missingText": {
"enabled": true,
"weight": 1,
"code": 123
},
"truncation": {
"enabled": true,
"weight": 1,
"code": 123
}
},
"other": {
"other": {
"enabled": true,
"weight": 1,
"code": 123
}
}
},
"penaltyPoints": {
"neutral": {
"code": 123,
"value": 123
},
"minor": {
"code": 123,
"value": 123
},
"major": {
"code": 123,
"value": 123
},
"critical": {
"code": 123,
"value": 123
}
},
"passFailThreshold": {
"minScorePercentage": 99
},
"isDefault": true,
"dateCreated": "2023-11-07T05:31:56Z",
"organization": {
"uid": "<string>"
}
},
"startedDate": "2023-11-07T05:31:56Z",
"finishedDate": "2023-11-07T05:31:56Z",
"editedDate": "2023-11-07T05:31:56Z",
"assessmentResult": {
"jobPart": {
"uid": "<string>"
},
"status": "PASS",
"score": 123,
"issueCounts": {
"critical": 123,
"criticalRepeated": 123,
"major": 123,
"majorRepeated": 123,
"minor": 123,
"minorRepeated": 123,
"neutral": 123,
"neutralRepeated": 123
}
},
"overallFeedback": "<string>",
"translationProvider": {
"uid": "<string>"
},
"reviewProvider": {
"uid": "<string>",
"organizationUid": "<string>"
},
"origin": "HUMAN",
"mode": "ISSUES",
"status": "NOT_STARTED"
}
]
}Get multiple LQA Assessments
Returns Assessment results for given jobs. If any given job is not from LQA workflow step, result from successive workflow steps may be returned
curl --request POST \
--url https://cloud.memsource.com/web/api2/v1/lqa/assessments \
--header 'Content-Type: application/json' \
--data '
{
"jobParts": [
{
"uid": "<string>"
}
]
}
'{
"assessmentDetails": [
{
"jobPartUid": "<string>",
"assessmentJobPartUid": "<string>",
"requestedJobPartUid": "<string>",
"workflowStep": {
"id": "<string>",
"uid": "<string>",
"name": "<string>",
"abbr": "<string>",
"order": 123,
"lqaEnabled": true
},
"reportCanBeDownloaded": true,
"lqaEnabled": true,
"availability": "NOT_AVAILABLE",
"lqaProfile": {
"uid": "string",
"name": "<string>",
"errorCategories": {
"accuracy": {
"accuracy": {
"enabled": true,
"weight": 1,
"code": 123
},
"addition": {
"enabled": true,
"weight": 1,
"code": 123
},
"omission": {
"enabled": true,
"weight": 1,
"code": 123
},
"mistranslation": {
"enabled": true,
"weight": 1,
"code": 123
},
"underTranslation": {
"enabled": true,
"weight": 1,
"code": 123
},
"untranslated": {
"enabled": true,
"weight": 1,
"code": 123
},
"improperTmMatch": {
"enabled": true,
"weight": 1,
"code": 123
},
"overTranslation": {
"enabled": true,
"weight": 1,
"code": 123
}
},
"fluency": {
"fluency": {
"enabled": true,
"weight": 1,
"code": 123
},
"punctuation": {
"enabled": true,
"weight": 1,
"code": 123
},
"spelling": {
"enabled": true,
"weight": 1,
"code": 123
},
"grammar": {
"enabled": true,
"weight": 1,
"code": 123
},
"grammaticalRegister": {
"enabled": true,
"weight": 1,
"code": 123
},
"inconsistency": {
"enabled": true,
"weight": 1,
"code": 123
},
"crossReference": {
"enabled": true,
"weight": 1,
"code": 123
},
"characterEncoding": {
"enabled": true,
"weight": 1,
"code": 123
}
},
"terminology": {
"terminology": {
"enabled": true,
"weight": 1,
"code": 123
},
"inconsistentWithTb": {
"enabled": true,
"weight": 1,
"code": 123
},
"inconsistentUseOfTerminology": {
"enabled": true,
"weight": 1,
"code": 123
}
},
"style": {
"style": {
"enabled": true,
"weight": 1,
"code": 123
},
"awkward": {
"enabled": true,
"weight": 1,
"code": 123
},
"companyStyle": {
"enabled": true,
"weight": 1,
"code": 123
},
"inconsistentStyle": {
"enabled": true,
"weight": 1,
"code": 123
},
"thirdPartyStyle": {
"enabled": true,
"weight": 1,
"code": 123
},
"unidiomatic": {
"enabled": true,
"weight": 1,
"code": 123
}
},
"localeConvention": {
"localeConvention": {
"enabled": true,
"weight": 1,
"code": 123
},
"addressFormat": {
"enabled": true,
"weight": 1,
"code": 123
},
"dateFormat": {
"enabled": true,
"weight": 1,
"code": 123
},
"currencyFormat": {
"enabled": true,
"weight": 1,
"code": 123
},
"measurementFormat": {
"enabled": true,
"weight": 1,
"code": 123
},
"shortcutKey": {
"enabled": true,
"weight": 1,
"code": 123
},
"telephoneFormat": {
"enabled": true,
"weight": 1,
"code": 123
}
},
"verity": {
"verity": {
"enabled": true,
"weight": 1,
"code": 123
},
"cultureSpecificReference": {
"enabled": true,
"weight": 1,
"code": 123
}
},
"design": {
"design": {
"enabled": true,
"weight": 1,
"code": 123
},
"length": {
"enabled": true,
"weight": 1,
"code": 123
},
"localFormatting": {
"enabled": true,
"weight": 1,
"code": 123
},
"markup": {
"enabled": true,
"weight": 1,
"code": 123
},
"missingText": {
"enabled": true,
"weight": 1,
"code": 123
},
"truncation": {
"enabled": true,
"weight": 1,
"code": 123
}
},
"other": {
"other": {
"enabled": true,
"weight": 1,
"code": 123
}
}
},
"penaltyPoints": {
"neutral": {
"code": 123,
"value": 123
},
"minor": {
"code": 123,
"value": 123
},
"major": {
"code": 123,
"value": 123
},
"critical": {
"code": 123,
"value": 123
}
},
"passFailThreshold": {
"minScorePercentage": 99
},
"isDefault": true,
"dateCreated": "2023-11-07T05:31:56Z",
"organization": {
"uid": "<string>"
}
},
"startedDate": "2023-11-07T05:31:56Z",
"finishedDate": "2023-11-07T05:31:56Z",
"editedDate": "2023-11-07T05:31:56Z",
"assessmentResult": {
"jobPart": {
"uid": "<string>"
},
"status": "PASS",
"score": 123,
"issueCounts": {
"critical": 123,
"criticalRepeated": 123,
"major": 123,
"majorRepeated": 123,
"minor": 123,
"minorRepeated": 123,
"neutral": 123,
"neutralRepeated": 123
}
},
"overallFeedback": "<string>",
"translationProvider": {
"uid": "<string>"
},
"reviewProvider": {
"uid": "<string>",
"organizationUid": "<string>"
},
"origin": "HUMAN",
"mode": "ISSUES",
"status": "NOT_STARTED"
}
]
}Body
Response
successful operation
Show child attributes
Show child attributes
UID of the corresponding job
UID of job corresponding to the assessment. Null when assessment not found
The originally requested job UID
If Assessment report/scorecard is ready and can be downloaded, user's rights are considered
If LQA is enabled and configured for this job
NOT_AVAILABLE, DISABLED_IN_ALL_WORKFLOW_STEPS, DISABLED_IN_CURRENT_WORKFLOW_STEP, ENABLED Show child attributes
Show child attributes
UID of the profile
"string"
Name of the profile
Error categories and their importance weight. If not provided, defaults will be created.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Show child attributes
Show child attributes
Show child attributes
Show child attributes
If this error category is enabled, default false
Weight of this error category (0.1 - 99.9)
1
Code of the error category
Penalty points for each severity level. By default neutral is 0, minor is 1, major is 5, critical is 10.
Show child attributes
Show child attributes
If profile is set as default for organization
When assessment was started (or empty)
When assessment was finished (or empty)
When assessment was edited after previous finish (or empty)
Show child attributes
Show child attributes
Result based on score and configured threshold
PASS, FAIL LQA score in percentage
Show child attributes
Show child attributes
Overall feedback from the LQA reviewer
HUMAN, AI ISSUES, ISSUES_AND_SCORE NOT_STARTED, STARTED, FINISHED, FINISHED_WITH_EDITING, EDITED Was this page helpful?