Searching - QA issues

This page explains how to query segments by QA issues with the search API.

Introduction

To get started, simply add a qa node in the query’s languages node:

{ 
	"query": {
		"languages": [
    		{ 
              "locs": ["en"],
              "qa": { }               
              ...

An empty node like the above will filter segments that have 1 or more issues in the language.

The qa node has these options:

qa	When empty then the default filter applies: It will return all segments/texts that have 1 or more active issues. Dismissed issues (like false positives) are not considered active. `"languages": [ { "qa": { } ...`	Optional, object
qa.dismissed	Optional boolean. null or missing: no filter false: Search for segments that have at least one active issue in the language (i.e. that is not dismissed) true: Search for segments that have at least one dismissed issue in the language. Example `"languages": [ { "qa": { "dismissed": false } ...`	Optional, bool?
qa.severity	Optional list of severity levels to filter. null or missing or []: no filter 0: Language must have at least one issue of severity “Information” 1: Language must have at least one issue of severity “Warning” 2: Language must have at least one issue of severity “Error” Example	Optional, int[]?
qa.rules	Optional list of QA rule IDs to filter. null or missing or []: no filter 0: An issue not produced by a QA process 1 .. 1000: Reserved for QA rules built into Wordbee Translator >1000: Any numbers used by an API integrator. See e.g. https://wordbee.atlassian.net/wiki/spaces/API2/pages/1344274477 which allows to freely set rule IDs. Example	Optional, int[]?

The search results include on text level (node txt) the QA issue details in child node qa:

If there a no issues at all then qa will be null:

The properties of qa are:

s	Severity: 0 = Information, 1 = Warning, 2 = error	int
d	Description of issue.	string
r	QA rule ID. See above for the different numerical values.	int
x	Issue dismissed yes/no. If property is missing then consider dismissed being false.	int, Optional
c	Optional comments. If there are no comments then this property will not be output.	string, Optional