Search translation memory for segment in the project

Returns at most maxSegments records with score >= scoreThreshold and at most maxSubsegments records which are subsegment, i.e. the source text is substring of the query text.

POST /api2/v1/projects/{projectUid}/transMemories/searchSegmentInProject

Search translation memory for segment in the project

cURL

curl --request POST \
  --url https://cloud.memsource.com/web/api2/v1/projects/{projectUid}/transMemories/searchSegmentInProject \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "segment": "<string>",
  "targetLangs": [
    "<string>"
  ],
  "contextKey": "<string>",
  "maxSegments": 2,
  "maxSubSegments": 2,
  "nextSegment": "<string>",
  "previousSegment": "<string>",
  "scoreThreshold": 0.505,
  "tagMetadata": [
    {
      "content": "<string>",
      "id": "<string>",
      "transAttributes": "<string>",
      "type": "<string>"
    }
  ],
  "workflowLevel": 8
}
'

200

{
  "searchResults": [
    {
      "grossScore": 123,
      "score": 123,
      "segmentId": "<string>",
      "source": {
        "client": {
          "id": 123,
          "name": "<string>"
        },
        "createdAt": 123,
        "createdBy": {
          "email": "<string>",
          "firstName": "<string>",
          "id": "<string>",
          "lastName": "<string>",
          "uid": "<string>",
          "userName": "<string>"
        },
        "domain": {
          "id": 123,
          "name": "<string>"
        },
        "filename": "<string>",
        "id": "<string>",
        "key": "<string>",
        "lang": "<string>",
        "modifiedAt": 123,
        "modifiedBy": {
          "email": "<string>",
          "firstName": "<string>",
          "id": "<string>",
          "lastName": "<string>",
          "uid": "<string>",
          "userName": "<string>"
        },
        "nextSegment": "<string>",
        "previousSegment": "<string>",
        "project": {
          "id": 123,
          "name": "<string>",
          "uid": "<string>"
        },
        "rtl": true,
        "subDomain": {
          "id": 123,
          "name": "<string>"
        },
        "tagMetadata": [
          {
            "content": "<string>",
            "id": "<string>",
            "transAttributes": "<string>",
            "type": "<string>"
          }
        ],
        "text": "<string>"
      },
      "subSegment": true,
      "transMemory": {
        "id": "<string>",
        "name": "<string>",
        "reverse": true,
        "uid": "<string>"
      },
      "translations": [
        {
          "client": {
            "id": 123,
            "name": "<string>"
          },
          "createdAt": 123,
          "createdBy": {
            "email": "<string>",
            "firstName": "<string>",
            "id": "<string>",
            "lastName": "<string>",
            "uid": "<string>",
            "userName": "<string>"
          },
          "domain": {
            "id": 123,
            "name": "<string>"
          },
          "filename": "<string>",
          "id": "<string>",
          "key": "<string>",
          "lang": "<string>",
          "modifiedAt": 123,
          "modifiedBy": {
            "email": "<string>",
            "firstName": "<string>",
            "id": "<string>",
            "lastName": "<string>",
            "uid": "<string>",
            "userName": "<string>"
          },
          "nextSegment": "<string>",
          "previousSegment": "<string>",
          "project": {
            "id": 123,
            "name": "<string>",
            "uid": "<string>"
          },
          "rtl": true,
          "subDomain": {
            "id": 123,
            "name": "<string>"
          },
          "tagMetadata": [
            {
              "content": "<string>",
              "id": "<string>",
              "transAttributes": "<string>",
              "type": "<string>"
            }
          ],
          "text": "<string>"
        }
      ]
    }
  ]
}

Authorizations

ApiTokenOAuth2

Authorization · string · header · required

Get a token from auth/login endpoint and then pass it in the Authorization HTTP header in every subsequent API call. For more information visit our help center.

Path Parameters

projectUid · string · required

Body

application/json

segment · string · required

targetLangs · string[] · required

Required array length: 1 - 2147483647 elements

contextKey · string

maxSegments · integer<int32>

Default: 5

Required range: 0 <= x <= 5

maxSubSegments · integer<int32>

Default: 5

Required range: 0 <= x <= 5

nextSegment · string

previousSegment · string

scoreThreshold · number<double>

Required range: 0 < x < 1.01

tagMetadata · object[]

Show child attributes

workflowLevel · integer<int32>

Required range: 1 <= x <= 15

Response

200

application/json

successful operation

searchResults · object[]

Show child attributes