| Name | Type | Description | Additional information |
|---|---|---|---|
| tmGuid | Guid | The Guid of the translation memory |
| Name | Type | Description |
|---|---|---|
| Options | ConcordanceOptions | |
| AbsScoreLimit | Int32 | Optional, default value: 0; Absolute score limit. |
| Ascending | Boolean | Optional, default value: False; Defines whether the sorting order is ascending. |
| CaseSensitive | Boolean | Optional, default value: False; Defines whether the search is case sensitive. |
| Column | Column (enum) | Optional, default value: 0; Possible enum values: 0:Prefix; 1:Middle; 2:Suffix; 3:Source; 4:Target; 5:Meta; 6:None; Defines the primary sort info, namely the column by which items are sorted. |
| FirstLast | FirstLast (enum) | Optional, default value: 0; Possible enum values: 0:First; 1:Last; Defines the secondary sort info, when items are sorted by Prefix or Suffix. |
| IgnorePunctuation | Boolean | Optional, default value: False; Defines whether the search ignores punctuation. |
| Meta | Meta (enum) | Optional, default value: 0; Possible enum values: 0:User; 1:ModifTime; Defines the secondary sort info, when items are sorted by MetaField. |
| NumericEquivalence | Boolean | Optional, default value: False; Defines whether the numbers are equivalent. |
| RelScroreLimit | Int32 | Optional, default value: 0; Relative score limit. |
| ResultsLimit | Int32 | Optional, default value: 64; Limit of the results. |
| ReverseLookup | Boolean | Optional, default value: False; Defines whether the search should be executed on the target side instead of the source side. |
| TargetFilterStrings | String[] | Optional, default value: null; An array of strings to filter target. |
| TopScoreCount | Int32 | Optional, default value: 0; Top score count. |
| SearchExpression | String[] | Obligatory; An array of the expressions to search. |
{
"SearchExpression": [
"sample string 1",
"sample string 2"
],
"Options": {
"AbsScoreLimit": 0,
"Ascending": true,
"CaseSensitive": true,
"Column": 3,
"FirstLast": 1,
"IgnorePunctuation": true,
"Meta": 1,
"NumericEquivalence": true,
"RelScroreLimit": 0,
"ResultsLimit": 100,
"ReverseLookup": true,
"TargetFilterStrings": [
"sample string 1",
"sample string 2"
],
"TopScoreCount": 1000
}
}| Name | Type | Description |
|---|---|---|
| ConcResult | ConcordanceItem[] | The sorted, limited array of results |
| ConcordanceTextRanges | RangeInfo[] | Optional, default value: null; The ranges of the concordance item. |
| Length | Int32 | The length of the range. |
| Start | Int32 | The starting position of the range. |
| ConcordanceTranslationRanges | TranslationRangeInfo[] | Optional, default value: null; The translation ranges of the concordance item. |
| Length | Int32 | The length of the translation range. |
| Score | Double | The score of the translation range. |
| Start | Int32 | The starting position of the translation range. |
| Length | Int32 | Optional, default value: null; The length of the concordance item. |
| StartPos | Int32 | Optional, default value: null; The starting position of the concordance item. |
| TMEntry | TMConcordanceEntryModel | |
| DocumentName | String | The name of the document where the entry came from. |
| EntryId | Int32 | The id of the TM entry the concordance hit comming form or -1 if it comes from a LiveDocs corpora. |
| LastModified | DateTime | The date when the entry was last modified. |
| Modifier | String | The name of the user the entry was last modified by. |
| SourceSegment | String | The source segment. |
| TargetSegment | String | The target segment. |
| ConcTransResult | ConcTransItem[] | The sorted, limited array of scores. |
| Expression | String | The expression. |
| Score | Double | The score. |
| Errors | ConcordanceError[] | The errors returned by the concordance. |
| ErrorType | ErrorTypes (enum) | Possible enum values: 0:TooManySimilarWords; 1:TooManySegments; 2:Unknown; The type of the concordance error. |
| QueryPart | String | The query part of the concordance error. |
| TotalConcResult | Int32 | The total number of results. |
{
"ConcResult": [
{
"ConcordanceTextRanges": [
{
"Length": 10,
"Start": 2
},
{
"Length": 10,
"Start": 2
},
{
"Length": 10,
"Start": 2
}
],
"ConcordanceTranslationRanges": [
{
"Length": 10,
"Score": 95.0,
"Start": 0
},
{
"Length": 10,
"Score": 95.0,
"Start": 0
},
{
"Length": 10,
"Score": 95.0,
"Start": 0
}
],
"Length": 1,
"StartPos": 2,
"TMEntry": {
"SourceSegment": "<seg>Sample segment content1.</seg>",
"TargetSegment": "<seg>Sample segment content2.</seg>",
"EntryId": 12,
"LastModified": "2015-08-28T14:02:31.22Z",
"Modifier": "John Doe",
"DocumentName": "sample.docx"
}
},
{
"ConcordanceTextRanges": [
{
"Length": 10,
"Start": 2
},
{
"Length": 10,
"Start": 2
},
{
"Length": 10,
"Start": 2
}
],
"ConcordanceTranslationRanges": [
{
"Length": 10,
"Score": 95.0,
"Start": 0
},
{
"Length": 10,
"Score": 95.0,
"Start": 0
},
{
"Length": 10,
"Score": 95.0,
"Start": 0
}
],
"Length": 1,
"StartPos": 2,
"TMEntry": {
"SourceSegment": "<seg>Sample segment content1.</seg>",
"TargetSegment": "<seg>Sample segment content2.</seg>",
"EntryId": 12,
"LastModified": "2015-08-28T14:02:31.22Z",
"Modifier": "John Doe",
"DocumentName": "sample.docx"
}
},
{
"ConcordanceTextRanges": [
{
"Length": 10,
"Start": 2
},
{
"Length": 10,
"Start": 2
},
{
"Length": 10,
"Start": 2
}
],
"ConcordanceTranslationRanges": [
{
"Length": 10,
"Score": 95.0,
"Start": 0
},
{
"Length": 10,
"Score": 95.0,
"Start": 0
},
{
"Length": 10,
"Score": 95.0,
"Start": 0
}
],
"Length": 1,
"StartPos": 2,
"TMEntry": {
"SourceSegment": "<seg>Sample segment content1.</seg>",
"TargetSegment": "<seg>Sample segment content2.</seg>",
"EntryId": 12,
"LastModified": "2015-08-28T14:02:31.22Z",
"Modifier": "John Doe",
"DocumentName": "sample.docx"
}
}
],
"ConcTransResult": [
{
"Expression": "sample string",
"Score": 95.0
},
{
"Expression": "sample string",
"Score": 95.0
},
{
"Expression": "sample string",
"Score": 95.0
}
],
"Errors": [
{
"ErrorType": 1,
"QueryPart": ""
},
{
"ErrorType": 1,
"QueryPart": ""
},
{
"ErrorType": 1,
"QueryPart": ""
}
],
"TotalConcResult": 10
}