...
Congree REST API endpoints are located at http:///congree/api
AuthoringMemory
...
| Status | ||||
|---|---|---|---|---|
|
...
/congree/api/AuthoringMemory/v1/ImportXml?lang={CultureName}
...
The culture name in the format languagecode2-country/regioncode2. languagecode2 is a lowercase two-letter code derived from ISO 639-1. country/regioncode2 is derived from ISO 3166 and usually consists of two uppercase letters, or a BCP-47 language tag.
E.g. /congree/api/AuthoringMemory/v1/ImportXml?lang=de-DE
The content type should be multipart/form-data and it should contain file XML.
| Codeblock | ||||
|---|---|---|---|---|
| ||||
{
"DetectedParagraphsCount": 0,
"DetectedSentencesCount": 0,
"AddedSentencesCount": 0,
"FailedParagraphsCount": 0
} |
Requirements
The content has to be well-formed XML with resolved entity references.
Maximum size: 10 MB
...
| Status | ||||
|---|---|---|---|---|
|
...
This endpoint requires a JSON object as parameter:
| Codeblock | ||
|---|---|---|
| ||
{
"Xml": "string",
"RuleSetName": "string"
} |
...
The request returns a JSON object providing the information detailed below.
| Codeblock | ||
|---|---|---|
| ||
{
"ResultXml": "string",
"Sentences": [
{
"Id": 0,
"ContextId": 0,
"DisplayContent": "string",
"SearchResults": [
{
"SearchMode": "Similar",
"Similarity": 0,
"Class": "string",
"DisplayContent": "string",
"ApplyContent": "string",
"Evaluation": "Approved",
"Attributes": [
{
"Name": "string",
"Values": [
"string"
]
}
],
"Penalties": [
{
"PenaltyType": "DifferentText",
"Value": 0
}
]
}
]
}
]
} |
...
Authoring Memory: Attributes
...
| Status | ||||
|---|---|---|---|---|
|
...
/api/AuthoringMemory/v1/Attributes
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
Attributes can be specified by:
- Type (string, optional): Type = ['Text', 'Picklist'],
- Name (string, optional): Name
- Values (Array[string], optional): Available values
Authoring Memory: Sentences
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
/congree/api/AuthoringMemory/v2/Sentences
...
Deletes sentences from Authoring Memory
The body of the request should contain the options you can find in the table below in the following form:
| Codeblock | ||||
|---|---|---|---|---|
| ||||
{
"ClearImportedSentences" : true,
"ClearDataGroomingSentences": true
} |
...
ClearImportedSentences...
ClearDataGroomingSentences...
In order to get the task status and results, use the methods described in Tasks. The result is an empty object.
| Codeblock | ||||
|---|---|---|---|---|
| ||||
{
"Id": "00000000-0000-0000-0000-000000000000"
} |
| Codeblock | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"Id": "514290f4-fc30-48e3-99b8-0973011bd2e5"
} |
Information
...
/congree/api/Information/v1/Version
...
Returns Congree Server and Web API versions
| Codeblock | ||||
|---|---|---|---|---|
| ||||
{
"CongreeWebApiVersion": "string",
"CongreeVersion": "string"
} |
| Codeblock | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"CongreeWebApiVersion": "5.0.14353.13448.20190325.Dev",
"CongreeVersion": "5.0.14353.13448.20190325.Dev"
} |
...
/congree/api/Information/v1/Components
...
Returns available components
The response structure corresponds to CongreeComponentInfo class, see Type definitions - IBulkCheckService - Auxiliary types.
| Codeblock | ||||
|---|---|---|---|---|
| ||||
[
{
"Id": "string",
"Name": "string"
}
] |
| Codeblock | ||||||
|---|---|---|---|---|---|---|
| ||||||
[
{
"Id": "CLTEditorWord",
"Name": "Congree for Microsoft Word"
},
{
"Id": "CLTFeatureDataGrooming",
"Name": "Congree Authoring Memory Candidates"
},
{
"Id": "CltFeatAuthMemory",
"Name": "Congree Authoring Memory"
},
{
"Id": "CltFeatLangCheckDe",
"Name": "Congree Language Check German"
},
{
"Id": "CltFeatBcs",
"Name": "Congree Language Check German"
},
{
"Id": "CltFeatLangCheckEn",
"Name": "Congree Language Check English"
},
{
"Id": "CltEditorPpt",
"Name": "Congree for Microsoft PowerPoint"
},
{
"Id": "CltEditorOutlook",
"Name": "Congree for Microsoft Outlook"
},
{
"Id": "CltEditorArbortext",
"Name": "Congree for PTC® Arbortext Editor™"
},
{
"Id": "CltEditorXmetal",
"Name": "Congree for JustSystems XMetaL® Author"
},
{
"Id": "CltEditorFrame",
"Name": "Congree for Adobe® FrameMaker®"
},
{
"Id": "CltEditorIndesign",
"Name": "Congree for Adobe® InDesign®"
},
{
"Id": "CltEditorAnytime",
"Name": "Congree Indie"
},
{
"Id": "CltEditorXmax",
"Name": "Congree for JustSystems XMetaL® XMAX™"
},
{
"Id": "CltFeatAmNative",
"Name": "Authoring Memory Non-native Authoring"
},
{
"Id": "CltFeatTerm",
"Name": "Congree Terminology"
},
{
"Id": "CltFeatTermExtract",
"Name": "Congree Term Extraction"
},
{
"Id": "CltEditorAuthit",
"Name": "Congree for ASC Author-it®"
},
{
"Id": "CltEditorProxy",
"Name": "Congree Client Proxy"
}
] |