reference

Translation Memory

13 endpoints

GET/api/v1/atlas-tm

List Translation Memory (TM)

Requires: TM_list

query parameters

id integer (int64)
uuid string (uuid)
name string
sourceLocale string
sourceLocales string[]
targetLocales string[]
client.id string (uuid)
client.name string
creator.id string (uuid)
creator.name string
organization string (uuid)
clientUUIDs string (uuid)[]
organizationUUIDs string (uuid)[]
ignoredIds integer (int64)[]
creationDate integer (int64)
startCreateDate string
endCreateDate string
domain string
subDomain string
note string
customFields map<string, object>[]
customFieldsJson string
idsOnly boolean
page integer
pageSize integer
restrictOwnAccount boolean
includeCustomFields boolean

Responses

200 OK

PageTMDto

content TMDto[]
empty boolean
first boolean
last boolean
number integer
numberOfElements integer
pageable PageableObject
size integer
sort SortObject
totalElements integer (int64)
totalPages integer

Request

curl -X GET 'https://app.wxrks.com/api/v1/atlas-tm' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

{
  "content": [
    {}
  ],
  "empty": false,
  "first": false,
  "last": false,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": false,
    "sort": {},
    "unpaged": false
  },
  "size": 0,
  "sort": {
    "empty": false,
    "sorted": false,
    "unsorted": false
  },
  "totalElements": 0,
  "totalPages": 0
}

POST/api/v1/atlas-tm/{tmUuid}/bulk-importer

Import TM File

Requires: TM_import_segments

path parameters

tmUuidrequired string (uuid)

query parameters

languagesrequired string[]

Request body

objectmultipart/form-data

Responses

200 OK

TMJobDto

creationDate integer (int64)
endTime integer (int64)
failureReason string
fileName string
id integer (int64)
jobExecutionId integer (int64)
jobName string
jobType string
processingTime string
progress TMJobProgressDto
segmentsCount integer (int64)
startTime integer (int64)
status string
tmId integer (int64)
tmUuid string (uuid)
workUnitScoped boolean

Request

curl -X POST 'https://app.wxrks.com/api/v1/atlas-tm/{tmUuid}/bulk-importer?languages=<languages>' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -F 'file=@./file'

Response 200

{
  "creationDate": 0,
  "endTime": 0,
  "failureReason": "string",
  "fileName": "string",
  "id": 0,
  "jobExecutionId": 0,
  "jobName": "string",
  "jobType": "string",
  "processingTime": "string",
  "progress": {
    "done": 0,
    "phase": "string",
    "total": 0,
    "translationUnits": 0,
    "unit": "string"
  },
  "segmentsCount": 0,
  "startTime": 0,
  "status": "string",
  "tmId": 0,
  "tmUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "workUnitScoped": false
}

POST/api/v1/atlas-tm/{tmUuid}/export

Export TM

Requires: TM_export

Also requires: PROJECT_export_import_file

Exports the TM. format is required: tmx or xlsx. With projectId plus workUnitIds or projectStepLevel, exports as TMX only the entries whose current version was saved by those work units of the project (TM updates); the TM must be linked to the project, tuIds and date filters do not apply, and the caller also needs the PROJECT_export_import_file permission. Such an export is SCHEDULED first: a few seconds after the request it waits until the translations still on their way to the TM have been written, then runs; after two minutes it ends FAILED with failureReason TM_WRITES_PENDING, and can be requested again. Leave projectId, workUnitIds and projectStepLevel out to export the whole TM.

path parameters

tmUuidrequired string (uuid)

Request body

TmExportRequest

createdAfter integer (int64)
Only entries created after this time, in epoch milliseconds. Not with the work-unit path.
createdBefore integer (int64)
Only entries created before this time, in epoch milliseconds. Not with the work-unit path.
formatrequired stringtmx xlsx
Case-insensitive. The work-unit path is TMX only.
languages string[]
Locales to export. Omitted or empty exports all of them.
projectId string (uuid)
Work-unit path: the project whose work units saved the entries. The TM must be linked to it, and the caller also needs the PROJECT_export_import_file permission.
projectStepLevel integer
Work-unit path: the workflow step whose saved entries are exported. Sending it, even as 0, selects the work-unit path.
tuIds integer (int64)[]
Export only these translation units. Not with the work-unit path.
workUnitIds string (uuid)[]
Work-unit path: the project's work units whose saved entries are exported.

Responses

200 OK

TMJobDto

creationDate integer (int64)
endTime integer (int64)
failureReason string
fileName string
id integer (int64)
jobExecutionId integer (int64)
jobName string
jobType string
processingTime string
progress TMJobProgressDto
segmentsCount integer (int64)
startTime integer (int64)
status string
tmId integer (int64)
tmUuid string (uuid)
workUnitScoped boolean

Request

curl -X POST 'https://app.wxrks.com/api/v1/atlas-tm/{tmUuid}/export' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "format": "tmx",
  "languages": [
    "en_us",
    "de_de"
  ]
}'

Response 200

{
  "creationDate": 0,
  "endTime": 0,
  "failureReason": "string",
  "fileName": "string",
  "id": 0,
  "jobExecutionId": 0,
  "jobName": "string",
  "jobType": "string",
  "processingTime": "string",
  "progress": {
    "done": 0,
    "phase": "string",
    "total": 0,
    "translationUnits": 0,
    "unit": "string"
  },
  "segmentsCount": 0,
  "startTime": 0,
  "status": "string",
  "tmId": 0,
  "tmUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "workUnitScoped": false
}

GET/api/v1/atlas-tm/job/{jobId}

Get TM Job

Requires: TM_get_by_id

Reports a TM import or export job. status is SCHEDULED, STARTING or STARTED while it runs, then COMPLETED or FAILED (also INTERRUPTED, STOPPED or ABANDONED when the job was cut short). A completed export's fileName is a signed link to the file, valid for one hour.

path parameters

jobIdrequired integer (int64)

Responses

200 OK

TMJobDto

creationDate integer (int64)
endTime integer (int64)
failureReason string
fileName string
id integer (int64)
jobExecutionId integer (int64)
jobName string
jobType string
processingTime string
progress TMJobProgressDto
segmentsCount integer (int64)
startTime integer (int64)
status string
tmId integer (int64)
tmUuid string (uuid)
workUnitScoped boolean

Request

curl -X GET 'https://app.wxrks.com/api/v1/atlas-tm/job/{jobId}' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

{
  "creationDate": 0,
  "endTime": 0,
  "failureReason": "string",
  "fileName": "string",
  "id": 0,
  "jobExecutionId": 0,
  "jobName": "string",
  "jobType": "string",
  "processingTime": "string",
  "progress": {
    "done": 0,
    "phase": "string",
    "total": 0,
    "translationUnits": 0,
    "unit": "string"
  },
  "segmentsCount": 0,
  "startTime": 0,
  "status": "string",
  "tmId": 0,
  "tmUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "workUnitScoped": false
}

DELETE/api/v1/translation-memory/{tmUuid}/{tuId}/segment

Delete Translation in TU

Requires: TM_delete_translation_unit

Deletes the translation of one locale from the TU. The TM's source locale can't be deleted: delete the whole TU instead. A TU of another TM, or one with no translation in that locale, answers 404.

path parameters

tmUuidrequired string (uuid)
tuIdrequired integer (int64)

query parameters

localerequired string
Locale of the translation to delete.

Responses

204 No Content

Request

curl -X DELETE 'https://app.wxrks.com/api/v1/translation-memory/{tmUuid}/{tuId}/segment?locale=de_de' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

GET/api/v1/translation-memory/{tmUuid}/segment/fuzzy-search

Fuzzy Search Segments

Requires: TM_get_by_id

path parameters

tmUuidrequired string (uuid)

query parameters

sourceTextrequired string
Text to search for.
targetLocalerequired string
Target locale of the hits.
threshold number (float)
Minimum similarity. Default: 0.49.
maxHits integer
Maximum number of hits. Default: 5.
sourceContext.type string
sourceContext.previousText string
sourceContext.nextText string
sourceContext.contextKey string
overviewOnly boolean

Responses

200 OK

SimpleTmHitDto[]

contextKey string
createdAt integer (int64)
createdBy UserDto
match number (double)
modifiedAt integer (int64)
modifiedBy UserDto
nextSourceText string
previousSourceText string
sourceLocale string
sourceSegmentId integer (int64)
sourceText string
targetLocale string
targetSegmentId integer (int64)
targetText string
tmName string
tmUuid string (uuid)
translationUnitId integer (int64)

Request

curl -X GET 'https://app.wxrks.com/api/v1/translation-memory/{tmUuid}/segment/fuzzy-search?sourceText=Hello%20world&targetLocale=fr_fr' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

[
  {
    "contextKey": "string",
    "createdAt": 0,
    "createdBy": {},
    "match": 0,
    "modifiedAt": 0,
    "modifiedBy": {},
    "nextSourceText": "string",
    "previousSourceText": "string",
    "sourceLocale": "string",
    "sourceSegmentId": 0,
    "sourceText": "string",
    "targetLocale": "string",
    "targetSegmentId": 0,
    "targetText": "string",
    "tmName": "string",
    "tmUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "translationUnitId": 0
  }
]

POST/api/v1/translation-memory/{tmUuid}/translation-unit

Upsert Translation in TU

Requires: TM_create_translation_unit

The TM must be linked to the caller's organization or one of the caller's org units.

path parameters

tmUuidrequired string (uuid)

query parameters

override boolean

Request body

SimpleTUUpsertData

sourceContext TMContext
sourceLocalerequired string
sourceTextrequired string
targetLocalerequired string
targetTextrequired string

Responses

201 Created

SimpleTUDto

id integer (int64)
tmUuid string (uuid)

Request

curl -X POST 'https://app.wxrks.com/api/v1/translation-memory/{tmUuid}/translation-unit' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "sourceLocale": "en_us",
  "sourceText": "Click Save to keep your changes.",
  "targetLocale": "de_de",
  "targetText": "Klicken Sie auf Speichern, um Ihre Änderungen zu behalten.",
  "sourceContext": {
    "type": "CONTEXT_KEY",
    "contextKey": "settings.save.hint"
  }
}'

Response 201

{
  "id": 0,
  "tmUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

PUT/api/v1/translation-memory/{tmUuid}/translation-unit/{tuId}

Update Translation in TU

Requires: TM_update_translation_unit

path parameters

tmUuidrequired string (uuid)
tuIdrequired integer (int64)

Request body

SimpleTUUpdateData

locale string
text string

Responses

200 OK

SimpleTUDto

id integer (int64)
tmUuid string (uuid)

Request

curl -X PUT 'https://app.wxrks.com/api/v1/translation-memory/{tmUuid}/translation-unit/{tuId}' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "locale": "string",
  "text": "string"
}'

Response 200

{
  "id": 0,
  "tmUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

DELETE/api/v1/translation-memory/{tmUuid}/translation-unit/{tuId}

Delete Translation Unit (TU)

Requires: TM_delete_translation_unit

path parameters

tmUuidrequired string (uuid)
tuIdrequired integer (int64)

Responses

204 No Content

Request

curl -X DELETE 'https://app.wxrks.com/api/v1/translation-memory/{tmUuid}/translation-unit/{tuId}' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

GET/api/v1/translation-memory/{tmUuid}/translation-unit/fuzzy-search

Fuzzy Search Translation Units

Requires: TM_get_by_id

path parameters

tmUuidrequired string (uuid)

query parameters

sourceTextrequired string
Text to search for.
targetLocales string[]
Target locales of the translations to return. The singular targetLocale is not read by this operation.
threshold number (float)
Minimum similarity. Default: 0.49.

Responses

200 OK

TranslationUnitMatch[]

locale string
match number (double)
segments SegmentDto[]
translationUnitId integer (int64)

Request

curl -X GET 'https://app.wxrks.com/api/v1/translation-memory/{tmUuid}/translation-unit/fuzzy-search?sourceText=Hello%20world' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

[
  {
    "locale": "string",
    "match": 0,
    "segments": [],
    "translationUnitId": 0
  }
]

GET/api/v1/translation-memory/{tmUuid}/translation-unit/search

Search Translation Units

Requires: TM_get_by_id

path parameters

tmUuidrequired string (uuid)

query parameters

sourceTextrequired string
Text to search for.
targetLocalerequired string
Target locale of the translations to return.
matchType stringContains StartsWith EndsWith ExactMatch Expression
How sourceText is matched. Default: Contains.
isSourceLocale boolean
page integer
Page number, from 0. Default: 0.
pageSize integer
Page size, 1 to 250. Default: 50.
offset integer (int64)

Responses

200 OK

PagedResponseTranslationUnitMatch

content TranslationUnitMatch[]
empty boolean
first boolean
last boolean
offset integer (int64)
pageNumber integer
pageSize integer
totalElements integer (int64)
totalPages integer

Request

curl -X GET 'https://app.wxrks.com/api/v1/translation-memory/{tmUuid}/translation-unit/search?sourceText=Hello%20world&targetLocale=fr_fr' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

{
  "content": [
    {}
  ],
  "empty": false,
  "first": false,
  "last": false,
  "offset": 0,
  "pageNumber": 0,
  "pageSize": 0,
  "totalElements": 0,
  "totalPages": 0
}

POST/api/v3/client/translation-memory/{tmUuid}

Associate Translation Memory with Org Units

Requires: ORG_UNIT_add_tm

Also requires: ORG_UNIT_update

The caller also needs the ORG_UNIT_update permission on each org unit in orgUnitUuids. Org units that don't exist are ignored.

path parameters

tmUuidrequired string (uuid)

query parameters

orgUnitUuidsrequired string (uuid)[]
Org units to associate, comma-separated.

Request body

TmOrgUnitAssociationRequest

defaultThreshold number (double)
Minimum match score. Default: 0.75.
fixPreTranslateMismatchTags boolean
fixSuggestionMismatchTags boolean
fixTags boolean
isDefault boolean
The TM is the org units' default TM.
penalty number (double)
Penalty applied to the TM's matches. Default: 0.
read boolean
The org units read from the TM. Default: false.
settings Settings
write boolean
The org units write to the TM. Default: false.

Responses

200 OK

Request

curl -X POST 'https://app.wxrks.com/api/v3/client/translation-memory/{tmUuid}?orgUnitUuids=b146d2ca-aa95-429f-8860-da62701de326' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "read": true,
  "write": true,
  "isDefault": false,
  "penalty": 5
}'

POST/api/v3/translation-memory

Create Translation Memory

Requires: TM_create

Request body

TMCreateParams

organization OrganizationDto
tmMetadata TMMetadata

Responses

200 OK

TMDto

client IdNameDto
creationDate integer (int64)
creator IdNameDto
customFields map<string, object>[]
domain string
id integer (int64)
name string
note string
orgUnits IdNameDto[]
organization IdNameDto
sourceLocale string
subDomain string
targetLocales string[]
translationUnitCount integer (int64)
uuid string (uuid)

Request

curl -X POST 'https://app.wxrks.com/api/v3/translation-memory' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "organization": {
    "country": "string",
    "customFields": [],
    "id": 0,
    "logo": "string",
    "mtSettings": {},
    "name": "string",
    "orgUnitDrafts": [],
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "tmMetadata": {
    "client": {},
    "creator": {},
    "customFields": [],
    "domain": "string",
    "isLarge": false,
    "name": "string",
    "note": "string",
    "organization": {},
    "sourceLocale": "string",
    "subDomain": "string",
    "targetLocales": []
  }
}'

Response 200

{
  "client": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
  },
  "creationDate": 0,
  "creator": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
  },
  "customFields": [
    {}
  ],
  "domain": "string",
  "id": 0,
  "name": "string",
  "note": "string",
  "orgUnits": [
    {}
  ],
  "organization": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
  },
  "sourceLocale": "string",
  "subDomain": "string",
  "targetLocales": [
    "string"
  ],
  "translationUnitCount": 0,
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}