...
(PUT) projects/{projectid}/documents/{documentid}/QA
PARAMETERS
token | The token obtained on connectionRequiredprojectidThe project idRequireddocumentidThe connection | Required |
| projectid | The project id | Required |
| documentid | The id of the document to check | Required |
options | JSON containing options to execute the QA check | Optional |
JSON format of "options" parameter
| profileId | The id of the the QA profile to use. See REF _Ref417317063 \r \h 12.12 QA profiles to get the list of existing profiles. | Required |
| localeSource | The source language of the document. Use the language code. See chapter REF _Ref358977631 \r \h 12.1 Languages for a list of all supported ISO-2 language codes. | Required |
| localeTarget | The target language of the document. Use the language code. See chapter REF _Ref358977631 \r \h 12.1 Languages for a list of all supported ISO-2 language codes. | Required |
| changeStatus | Default: trueIftrue If true then QA rules will be able to change status of invalid (or valid) translations. | Optional |
| changeBookmarks | Default: trueIftrue If true then QA rules will be able to change bookmark of invalid (or valid) translations. | Optional |
| skipGreenStatus | Default: trueIftrue If true then segments with green status will be skipped during the check. | Optional |
| skipLocked | Default: trueIftrue 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:
| Code Block | ||
|---|---|---|
| ||
<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".
...