Inhalt
The available Swagger UI for the Congree REST API is located in the following URL: http://<WebAPIHost>/congree/swagger
Congree REST API endpoints are located at http://<WebAPIHost>/congree/api
Account
| /congree/api/Account/v1/SignOut | Releases locked license |
...
| Processing Instruction | Explanation | |
|---|---|---|
<?cngr-ctx -b 6?>ctx = context (a paragraph ID)<?cngr-lc-b 13?> | ||
lc = Language Check (a highlight/error ID) | ||
<?cngr-ctx-e 6?>e = end of the range | <?cngr-lc-b 13?>||
b = beginning of the range |
...
- Id: highlight/error ID to find the correct range of a Congree notification)
- ContextId: ContextId corresponds to a “<?cngr-ctx-b X?> … <?cngr-ctx-e X?>” “ … ” region. These PIs are emitted when IncludeContextMapping is true or both IncludeReporting is true and RuleSet has reporting configuration set.
- Type: Spelling, Grammar, Style, Terminology, Abbreviation or Valid terms
- Descriptions:
- Code: identifier for a specific Congree notification
- Description:
- Header: short summary to identify the notification
- Instruction: short text telling the author what to correct
- Explanation: short text telling the author why to correct
- Explanation: negative example
- Type: can be Text or Explanation
- Text
- ExplanationRewrite: positive example
- Type: can be Text or Explanation
- Text
...
TermCandidates
- Id: Id of corresponding “<?cngr-lc-b X?>…<?cngr-lc-e X?>” “…” region
- Text: the candidates as displayed to the author
- Context: the sentence(s) in which a term candidate has been found
- IsExist: information if this term has already been proposed by someone else in the past
...
| /congree/api/Linguistic/v1/StartCheckTask?ruleSet={rulesetName} | Checks the document in asynchronous mode |
The request is the same as for /congree/api/Linguistic/v1/Check?ruleSet=rulesetName but the result is a task id.
...