Skip to main content

Run QA check

To run a QA check on a given document.

URL

(PUT) projects/{projectid}/documents/{documentid}/QA  

PARAMETERS

token

The token obtained on connection

Required

projectidThe project idRequired
documentidThe id of the document to checkRequired

options

JSON containing options to execute the QA check

Optional

 

JSON format of "options" parameter

 

profileIdThe id of the the QA profile to use. See QA profiles to get the list of existing profiles.Required
localeSourceThe source language of the document. Use the language code. See Languages for a list of all supported ISO-2 language codes.Required
localeTargetThe target language of the document. Use the language code. See Languages for a list of all supported ISO-2 language codes.Required
changeStatus

Default: true

If true then QA rules will be able to change status of invalid (or valid) translations.

Optional
changeBookmarks

Default: true

If true then QA rules will be able to change bookmark of invalid (or valid) translations.

Optional
skipGreenStatus

Default: true

If true then segments with green status will be skipped during the check.

Optional
skipLocked

Default: true

If true then locked segments will be skipped during the check.

Optional

 

RESULTS

The method executes asynchronously. It returns the id of the asynchronous operation or 0 if the operation has completed immediately:

XML
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">2147483647</int>

If not 0 then your software should poll the status of the operation every 5 seconds. See Asynchronous operations, operation "asyncoperations/{operationid}/status".

 

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.