Documentation of memoQ Server Resources API

POST v1/tms/{tmGuid}/lookupsegments

Performs a lookup operation in the translation memory specified by a Guid. Remark: for performance reasons the operation currently does not return valid values in the context related fields (ContextID, PrecedingSegment, FollowingSegment) of the TransUnit field of the returned TMHits object. These pieces of information can be retrieved by issuing an extra request getting the specific TM entry based on its key.

Request information

Uri parameters

Name	Type	Description	Additional information
tmGuid	Guid	The Guid of the translation memory

Request body type

Name	Type	Description
Options	LookupSegmentOptions
AdjustFuzzyMatches	Boolean	Optional, default value: False; Defines whether an adjustment of fuzzy hits should be performed.
InlineTagStrictness	InlineTagStrictness (enum)	Optional, default value: 0; Possible enum values: 0:Strict; 1:Medium; 2:Permissive; Defines the strictness of matching inline tags.
MatchThreshold	Int32	Optional, default value: 0; The match threshold for the lookup result. A number between 50 and 102 is expected.
OnlyBest	Boolean	Optional, default value: False; Defines whether the lookup should return only the best matches. If true, custom metas are not included in the lookup result (the "CustomMetas" array member is always empty for the returned "TransUnit" items).
OnlyUnambiguous	Boolean	Optional, default value: False; Defines whether the lookup should return only unambiguous matches. Only relevant if MatchThreshold is 100, 101 or 102.
ReverseLookup	Boolean	Optional, default value: False; Defines whether a reversed lookup should be performed.
ShowFragmentHits	Boolean	Optional, default value: False; Defines whether to show fragment assembly hits in the lookup result.
Segments	QuerySegment[]	Obligatory; An array of the segments to search.
ContextID	String	Optional, default value: null; The context id of the segment.
FollowingSegment	String	Optional, default value: null; The following segment.
PrecedingSegment	String	Optional, default value: null; The preceding segment.
Segment	String	Obligatory; The segment to search.

Request body formats

application/json

Sample:

{
  "Segments": [
    {
      "ContextID": "context id",
      "FollowingSegment": "<seg>Following segment content.</seg>",
      "PrecedingSegment": "<seg>Preceding segment content.</seg>",
      "Segment": "<seg>Sample segment content.</seg>"
    },
    {
      "ContextID": "context id",
      "FollowingSegment": "<seg>Following segment content.</seg>",
      "PrecedingSegment": "<seg>Preceding segment content.</seg>",
      "Segment": "<seg>Sample segment content.</seg>"
    },
    {
      "ContextID": "context id",
      "FollowingSegment": "<seg>Following segment content.</seg>",
      "PrecedingSegment": "<seg>Preceding segment content.</seg>",
      "Segment": "<seg>Sample segment content.</seg>"
    }
  ],
  "Options": {
    "AdjustFuzzyMatches": true,
    "InlineTagStrictness": 2,
    "MatchThreshold": 100,
    "ShowFragmentHits": false,
    "OnlyBest": true,
    "OnlyUnambiguous": true,
    "ReverseLookup": true
  }
}

Response information

Response return type

Name	Type	Description
Result	TMHitsPerSegment[]	Optional, default value: null; The result of the lookup.
TMHits	TMHit[]	Optional, default value: null; The result of the lookup per segment.
MatchRate	Int32	Optional, default value: null; The match rate of the lookup hit.
TransUnit	TMEntryModel
Client	String	The client of the TM entry.
ContextID	String	The context id of the TM entry.
Created	DateTime	The creaton date of the TM entry.
Creator	String	The creator of the TM entry.
CustomMetas	TMCustomMetaItem[]	An array of the TM entry's custom meta properties.
Name	String	The name of the custom meta property.
Value	Object	The value of the custom meta property.
Document	String	The document of the TM entry.
Domain	String	The domain of the TM entry.
FollowingSegment	String	The following segment of the TM entry.
Key	Int32	The key of the TM entry.
Modified	DateTime	The date of the TM entry's last modification. An OptimisticConcurrencyError occurs during the update action if it does not match the existing entry's Modified parameter.
Modifier	String	The last modifier of the TM entry.
PrecedingSegment	String	The preceding segment of the TM entry.
Project	String	The project of the TM entry.
SourceSegment	String	The source segment of the TM entry.
Subject	String	The subject of the TM entry.
TargetSegment	String	The target segment of the TM entry.

Response body formats

application/json

Sample:

{
  "Result": [
    {
      "TMHits": [
        {
          "MatchRate": 1,
          "TransUnit": {
            "Created": "2015-08-28T14:02:31.22Z",
            "Creator": "Built-in administrator",
            "Modified": "2015-08-28T14:02:31.22Z",
            "Modifier": "Built-in administrator",
            "Client": "client",
            "ContextID": "context id",
            "Document": "document",
            "Domain": "domain",
            "FollowingSegment": "<seg>Following segment content.</seg>",
            "Key": 0,
            "PrecedingSegment": "<seg>Preceding segment content.</seg>",
            "Project": "project",
            "SourceSegment": "<seg>Sample segment content1.</seg>",
            "Subject": "subject",
            "TargetSegment": "<seg>Sample segment content2.</seg>",
            "CustomMetas": [
              {
                "Name": "name",
                "Value": "value"
              },
              {
                "Name": "name",
                "Value": "value"
              },
              {
                "Name": "name",
                "Value": "value"
              }
            ]
          }
        },
        {
          "MatchRate": 1,
          "TransUnit": {
            "Created": "2015-08-28T14:02:31.22Z",
            "Creator": "Built-in administrator",
            "Modified": "2015-08-28T14:02:31.22Z",
            "Modifier": "Built-in administrator",
            "Client": "client",
            "ContextID": "context id",
            "Document": "document",
            "Domain": "domain",
            "FollowingSegment": "<seg>Following segment content.</seg>",
            "Key": 0,
            "PrecedingSegment": "<seg>Preceding segment content.</seg>",
            "Project": "project",
            "SourceSegment": "<seg>Sample segment content1.</seg>",
            "Subject": "subject",
            "TargetSegment": "<seg>Sample segment content2.</seg>",
            "CustomMetas": [
              {
                "Name": "name",
                "Value": "value"
              },
              {
                "Name": "name",
                "Value": "value"
              },
              {
                "Name": "name",
                "Value": "value"
              }
            ]
          }
        },
        {
          "MatchRate": 1,
          "TransUnit": {
            "Created": "2015-08-28T14:02:31.22Z",
            "Creator": "Built-in administrator",
            "Modified": "2015-08-28T14:02:31.22Z",
            "Modifier": "Built-in administrator",
            "Client": "client",
            "ContextID": "context id",
            "Document": "document",
            "Domain": "domain",
            "FollowingSegment": "<seg>Following segment content.</seg>",
            "Key": 0,
            "PrecedingSegment": "<seg>Preceding segment content.</seg>",
            "Project": "project",
            "SourceSegment": "<seg>Sample segment content1.</seg>",
            "Subject": "subject",
            "TargetSegment": "<seg>Sample segment content2.</seg>",
            "CustomMetas": [
              {
                "Name": "name",
                "Value": "value"
              },
              {
                "Name": "name",
                "Value": "value"
              },
              {
                "Name": "name",
                "Value": "value"
              }
            ]
          }
        }
      ]
    },
    {
      "TMHits": [
        {
          "MatchRate": 1,
          "TransUnit": {
            "Created": "2015-08-28T14:02:31.22Z",
            "Creator": "Built-in administrator",
            "Modified": "2015-08-28T14:02:31.22Z",
            "Modifier": "Built-in administrator",
            "Client": "client",
            "ContextID": "context id",
            "Document": "document",
            "Domain": "domain",
            "FollowingSegment": "<seg>Following segment content.</seg>",
            "Key": 0,
            "PrecedingSegment": "<seg>Preceding segment content.</seg>",
            "Project": "project",
            "SourceSegment": "<seg>Sample segment content1.</seg>",
            "Subject": "subject",
            "TargetSegment": "<seg>Sample segment content2.</seg>",
            "CustomMetas": [
              {
                "Name": "name",
                "Value": "value"
              },
              {
                "Name": "name",
                "Value": "value"
              },
              {
                "Name": "name",
                "Value": "value"
              }
            ]
          }
        },
        {
          "MatchRate": 1,
          "TransUnit": {
            "Created": "2015-08-28T14:02:31.22Z",
            "Creator": "Built-in administrator",
            "Modified": "2015-08-28T14:02:31.22Z",
            "Modifier": "Built-in administrator",
            "Client": "client",
            "ContextID": "context id",
            "Document": "document",
            "Domain": "domain",
            "FollowingSegment": "<seg>Following segment content.</seg>",
            "Key": 0,
            "PrecedingSegment": "<seg>Preceding segment content.</seg>",
            "Project": "project",
            "SourceSegment": "<seg>Sample segment content1.</seg>",
            "Subject": "subject",
            "TargetSegment": "<seg>Sample segment content2.</seg>",
            "CustomMetas": [
              {
                "Name": "name",
                "Value": "value"
              },
              {
                "Name": "name",
                "Value": "value"
              },
              {
                "Name": "name",
                "Value": "value"
              }
            ]
          }
        },
        {
          "MatchRate": 1,
          "TransUnit": {
            "Created": "2015-08-28T14:02:31.22Z",
            "Creator": "Built-in administrator",
            "Modified": "2015-08-28T14:02:31.22Z",
            "Modifier": "Built-in administrator",
            "Client": "client",
            "ContextID": "context id",
            "Document": "document",
            "Domain": "domain",
            "FollowingSegment": "<seg>Following segment content.</seg>",
            "Key": 0,
            "PrecedingSegment": "<seg>Preceding segment content.</seg>",
            "Project": "project",
            "SourceSegment": "<seg>Sample segment content1.</seg>",
            "Subject": "subject",
            "TargetSegment": "<seg>Sample segment content2.</seg>",
            "CustomMetas": [
              {
                "Name": "name",
                "Value": "value"
              },
              {
                "Name": "name",
                "Value": "value"
              },
              {
                "Name": "name",
                "Value": "value"
              }
            ]
          }
        }
      ]
    },
    {
      "TMHits": [
        {
          "MatchRate": 1,
          "TransUnit": {
            "Created": "2015-08-28T14:02:31.22Z",
            "Creator": "Built-in administrator",
            "Modified": "2015-08-28T14:02:31.22Z",
            "Modifier": "Built-in administrator",
            "Client": "client",
            "ContextID": "context id",
            "Document": "document",
            "Domain": "domain",
            "FollowingSegment": "<seg>Following segment content.</seg>",
            "Key": 0,
            "PrecedingSegment": "<seg>Preceding segment content.</seg>",
            "Project": "project",
            "SourceSegment": "<seg>Sample segment content1.</seg>",
            "Subject": "subject",
            "TargetSegment": "<seg>Sample segment content2.</seg>",
            "CustomMetas": [
              {
                "Name": "name",
                "Value": "value"
              },
              {
                "Name": "name",
                "Value": "value"
              },
              {
                "Name": "name",
                "Value": "value"
              }
            ]
          }
        },
        {
          "MatchRate": 1,
          "TransUnit": {
            "Created": "2015-08-28T14:02:31.22Z",
            "Creator": "Built-in administrator",
            "Modified": "2015-08-28T14:02:31.22Z",
            "Modifier": "Built-in administrator",
            "Client": "client",
            "ContextID": "context id",
            "Document": "document",
            "Domain": "domain",
            "FollowingSegment": "<seg>Following segment content.</seg>",
            "Key": 0,
            "PrecedingSegment": "<seg>Preceding segment content.</seg>",
            "Project": "project",
            "SourceSegment": "<seg>Sample segment content1.</seg>",
            "Subject": "subject",
            "TargetSegment": "<seg>Sample segment content2.</seg>",
            "CustomMetas": [
              {
                "Name": "name",
                "Value": "value"
              },
              {
                "Name": "name",
                "Value": "value"
              },
              {
                "Name": "name",
                "Value": "value"
              }
            ]
          }
        },
        {
          "MatchRate": 1,
          "TransUnit": {
            "Created": "2015-08-28T14:02:31.22Z",
            "Creator": "Built-in administrator",
            "Modified": "2015-08-28T14:02:31.22Z",
            "Modifier": "Built-in administrator",
            "Client": "client",
            "ContextID": "context id",
            "Document": "document",
            "Domain": "domain",
            "FollowingSegment": "<seg>Following segment content.</seg>",
            "Key": 0,
            "PrecedingSegment": "<seg>Preceding segment content.</seg>",
            "Project": "project",
            "SourceSegment": "<seg>Sample segment content1.</seg>",
            "Subject": "subject",
            "TargetSegment": "<seg>Sample segment content2.</seg>",
            "CustomMetas": [
              {
                "Name": "name",
                "Value": "value"
              },
              {
                "Name": "name",
                "Value": "value"
              },
              {
                "Name": "name",
                "Value": "value"
              }
            ]
          }
        }
      ]
    }
  ]
}