Page tree
Skip to end of metadata
Go to start of metadata

Provides access to the qualities of a task for the filter panel

URL:

/editor/quality

Available Methods:

GET

Parameters:currentstate [string]: encoded value of the selected nodes and the current filter mode

Specialities:

Only possible with a task in edit mode. Returns a JSON tree of qualities

Resource Layout of a single filter quality node

Name

Type

Info

qid

int

id of the quality (may be null for programmatical items)

qtype

string

type of the quality

qcategorystringcategory of the quality (NULL for rubrics)
qcountint

number of segments with this quality

qtotalintnumber of segments for the whole branch from here (only nodes with children)
textstring

translated display text of the quality

leafbooleanif the node has children

checked

booleanif the node is selected
childrenarraytree children of the node

Provides access to the qualities of a segment for the false-positives and manual QA (whole segment) panel

URL:

/editor/quality/segment

Available Methods:

GET

Parameters:segmentId [int]

Specialities:

Only possible with a task in edit mode

Resource Layout of a segment's quality

Name

Type

Info

id

int

id of the quality

segmentId

string

id of the segment the quality belongs to

fieldstringfield the quality refers to
typeint

type of the quality

categoryintcategory of the quality
categoryIndexstring

Special for qm & mqm qualities: index of the defining model

falsePositiveint0|1

typeText

booleantranslated name of the type
textarraytranslated display name of the quality
filterablebooleanif the quality appears in the filter
hasTagbooleanif the quality is represented by a tag in the segment text
tagNamestringidentidying node name of the tag
cssClassstringidentidying css classname of the tag

Provides access to the qualities of a task

URL:

/editor/quality/task

Available Methods:

GET

Parameters:taskGuid [string]

Specialities:

Returns a JSON tree of qualities

Resource Layout of a single task quality node

Name

Type

Info

qid

int

id of the quality (may be null for programmatical items)

qtype

string

type of the quality

qcategorystringcategory of the quality (NULL for rubrics)
qcountint

number of segments with this quality

qcountfpintnumber of segments where this quality is regarded as  false positive
qtotalintnumber of segments for the whole branch from here (only nodes with children)
textstring

translated display text of the quality

leafbooleanif the node has children
childrenarraytree children of the node


Provider vor the dynamic tooltip for the task overview quality column tooltip

URL:

/editor/quality/tasktooltip

Available Methods:

GET

Parameters:taskGuid [string]

Specialities:

Returns a HTML markup string with a summary of the task's qualities


Adds / removes a "Manual QM (whole segment)" quality

URL:

/editor/quality/segmentqm

Available Methods:

GET

Parameters:

segmentId [int] segment to add or remove a qm for

categoryIndex [int] category  index of the qm to add or remove

qmaction [string] "add"|"remove"

Specialities:

In case of "add":

Returns a single model for the new segments quality as described in "Resource Layout of a segment's quality"

In case of "add":

Returns a single object having only the "id" property of the removed quality


Changes the false positive value for a single quality

URL:

/editor/quality/falsepositive

Available Methods:

GET

Parameters:

qualityId [int]

falsePositive [int] 0|1

Specialities:

Returns a state if a quality tag was found in the segment's field text and was adjusted


QA-Statistics Download URL

URL:

/editor/quality/downloadstatistics?taskGuid=[GUID]&type=[TYPE]
[GUID] is the taskGuid of the task to get the statistics from.
[TYPE] is the fieldname of the datafield to get the statistics from (optional)

Available Methods:

GET

Specialities:

returns a XML file with all qualities for the task

  • No labels