SpellCheckResult

Note:

This structure changed in 7.2.

  • The SpellCheckResult field is new.
FieldTypeDescription

documentIdentifier

String

Object identifier containing the spelling error

id

String

Spelling error identifier as means of differentiation from other spelling errors

specificRuleId

String

Rule identifier of the spelling error returned by LanguageTool

errorType

String

Error type for the spelling error returned by LanguageTool

description

String

Brief description for the spelling error returned by LanguageTool

warningMessage

String

Warning returned by CCMS Web Server for rationale proposed correction to spelling error cannot be applied to the object

misspelledWord

String

The misspelled word itself

contextBefore

String

Text fragment immediately before the identified misspelled word

contextAfter

String

Text fragment immediately following the identified misspelled word

startPosition

Int

Location where the misspelled word begins in the containing element

endPosition

Int

Location where the misspelled word ends in the containing element

oxyStartPosition

Int

Location where the misspelled word begins in the containing element, according to the Oxygen Editor

xpath

String

The exact xPath where the misspelled word is located in the object

replacements

String […]

List of replacement words suggested by LanguageTool