Search translation memory

Overview

• Runs an asynchronous TMX export based on wildcard/phrase queries and optional metadata filters. The job streams filtered translation units into TMX via the downstream /export_tmx_by_query endpoint. Use downloadExport/{asyncRequestId} to fetch the finished file.

Flow

1. Caller posts ExportByQueryDto.
2. Service queues backend export (job metadata marks it asynchronous).
3. Response contains asyncRequest + asyncExport descriptors so you can poll or receive callbacks.

Queries & locales

• queries align one-to-one with queryLangs. Each entry represents a search expression (supports * and ? wildcards, max 5/10 respectively) applied to a locale.
• Query semantics mirror the wildcard search endpoint: unquoted text = contains mode; quoted text = phrase mode; Boolean operators are ignored; * or empty string means match-all (the backend may drop redundant source-only pairs).
• exportTargetLangs sets which target TUVs are written to TMX. If omitted, all TM target locales are exported.

Filtering

• Timestamp bounds (createdAtMin/Max, modifiedAtMin/Max) and author filters (createdBy, modifiedBy) narrow the TU set before export.
• Optional project reference provides additional downstream scoping or naming context.

Output & limits

• Output is always TMX, streamed in chunks; filenames follow dto.filename when provided, otherwise backend defaults.
• Requests with excessive locales or wildcard limit violations reject with 400.
• If no matches remain after filtering, the job still produces an empty TMX.

Callbacks & polling

• Provide callbackUrl to receive completion notification from the async mediator; otherwise poll asyncRequest via standard async APIs and download through /downloadExport/{asyncRequestId} when ready.

POST /api2/v1/transMemories/{transMemoryUid}/exportByQueryAsync

Search translation memory

cURL

curl --request POST \
  --url https://cloud.memsource.com/web/api2/v1/transMemories/{transMemoryUid}/exportByQueryAsync \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "exportTargetLangs": [
    "<string>"
  ],
  "queries": [
    "<string>"
  ],
  "queryLangs": [
    "<string>"
  ],
  "callbackUrl": "<string>",
  "createdAtMax": "2023-11-07T05:31:56Z",
  "createdAtMin": "2023-11-07T05:31:56Z",
  "filename": "<string>",
  "modifiedAtMax": "2023-11-07T05:31:56Z",
  "modifiedAtMin": "2023-11-07T05:31:56Z"
}
'

200

{
  "asyncExport": {
    "asyncRequest": {},
    "exportTargetLangs": [
      "<string>"
    ],
    "queries": [
      {
        "lang": "<string>",
        "query": "<string>"
      }
    ],
    "transMemory": {}
  },
  "asyncRequest": {
    "asyncResponse": {
      "acceptedSegmentsCount": 123,
      "dateCreated": "2023-11-07T05:31:56Z",
      "errorCode": "<string>",
      "errorDesc": "<string>",
      "errorDetails": [
        {
          "args": {},
          "code": "<string>",
          "message": "<string>"
        }
      ],
      "warnings": [
        {
          "args": {},
          "code": "<string>",
          "message": "<string>"
        }
      ]
    },
    "createdBy": {
      "email": "<string>",
      "firstName": "<string>",
      "id": "<string>",
      "lastName": "<string>",
      "uid": "<string>",
      "userName": "<string>"
    },
    "dateCreated": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "parent": "<unknown>",
    "project": {
      "name": "<string>",
      "uid": "<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

transMemoryUid · string · required

Body

application/json

exportTargetLangs · string[] · required

queries · string[] · required

queryLangs · string[] · required

callbackUrl · string

createdAtMax · string<date-time>

createdAtMin · string<date-time>

createdBy · object

Show child attributes

filename · string

modifiedAtMax · string<date-time>

modifiedAtMin · string<date-time>

modifiedBy · object

Show child attributes

project · object

Show child attributes

Response

200

application/json

successful operation

asyncExport · object

Show child attributes

asyncRequest · object

Show child attributes