reference

Glossary

23 endpoints

Glossary Management

GET/api/v3/glossary

List Glossary

Requires: GLOSSARY_list

query parameters

glossaryUuid string (uuid)
name string
organizationUuid string (uuid)
orgUnitUuid string (uuid)
ignoreIds string (uuid)[]
idsOnly boolean
restrictOwnAccount boolean
customFields map<string, object>[]
customFieldsJson string
sort string
page integer
Page to return, starting at 0.
size integer
Items per page.
includeCustomFields boolean

Responses

200 OK

PageGlossaryDto

content GlossaryDto[]
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/v3/glossary' \
  -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/v3/glossary

Create Glossary

Requires: GLOSSARY_create

Request body

GlossaryCreateRequest

customAttributes map<string, object>[]
Each item has name, type (SINGLE_VALUE, SINGLE_SELECT or MULTI_SELECT), value and, for the select types, options.
domain string
Domain name; created in the organization when it doesn't exist.
languagesrequired string[]
At least two languages.
namerequired string
note string
orgUnits GlossaryOrgUnitRef[]
Org units the caller must have access to.
organizationrequired GlossaryOrganizationRef
subDomain string
Subdomain name; created in the organization when it doesn't exist.

Responses

200 OK

GlossaryDto

allLanguages string[]
bwGlossaryId integer (int64)
createdBy UserDto
creationDate integer (int64)
customAttributes map<string, object>[]
customFields map<string, object>[]
domain string
enabledTerminologyFlow boolean
isDefault boolean
languages string[]
lastImportJob GlossaryJobDto
name string
note string
orgUnits OrganizationalUnitDto[]
organization OrganizationDto
requiredTermFields RequiredTermFields
subDomain string
totalConcepts integer
uuid string (uuid)

Request

curl -X POST 'https://app.wxrks.com/api/v3/glossary' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Product terminology",
  "note": "Approved terms for the product UI.",
  "languages": [
    "en_us",
    "de_de"
  ],
  "organization": {
    "uuid": "97b55a5e-9133-464c-937e-a99c8156c23e"
  },
  "orgUnits": [
    {
      "uuid": "b146d2ca-aa95-429f-8860-da62701de326"
    }
  ]
}'

Response 200

{
  "allLanguages": [
    "string"
  ],
  "bwGlossaryId": 0,
  "createdBy": {
    "accessKey": "string",
    "accessKeyTimestamp": 0,
    "accountOwner": false,
    "accountType": "CLI",
    "accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "address": "string",
    "address2": "string",
    "admin": false,
    "assignedJobs": 0,
    "avatar": "string",
    "captcha": "string",
    "cellPhone": "string",
    "city": "string",
    "companyName": "string",
    "completedJobs": 0,
    "country": "string",
    "currency": "string",
    "customFields": [],
    "dailyRate": 0,
    "defaultWorkflowRates": [],
    "deleteAllLanguagePair": false,
    "email": "string",
    "emailMagicCode": "string",
    "entryPoint": "WORKS_HOME",
    "externalId": "string",
    "forwardUrl": "string",
    "hourlyRate": 0,
    "id": 0,
    "invoicingDayOfMonth": "DAY_15",
    "invoicingPeriodicity": 0,
    "lastAccessAt": 0,
    "messageError": "string",
    "messageWarning": "string",
    "mfa": 0,
    "mfaEnabled": false,
    "minimumFee": 0,
    "name": "string",
    "nameEmail": "string",
    "newPassword": "string",
    "notes": "string",
    "notifyUser": false,
    "orgUnits": [],
    "organizations": [],
    "pagesRate": 0,
    "parentUserUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "paymentMethod": "PAYONEER",
    "payoneerId": "string",
    "paypalAccount": "string",
    "permissionGroups": [],
    "phone": "string",
    "postalCode": "string",
    "productName": "string",
    "punctuality": 0,
    "quickBooksVendorId": "string",
    "roles": [],
    "skypeId": "string",
    "slackHandle": "string",
    "state": "string",
    "status": "Active",
    "subUser": false,
    "subscriptions": [],
    "supportedLanguagePairs": [],
    "tags": [],
    "targetAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tasksCompletedCount": 0,
    "taxId": "string",
    "taxpayerId": "string",
    "timezone": "string",
    "totalJobs": 0,
    "useProjectCurrency": false,
    "userQualityMetrics": {},
    "userRates": [],
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "wordRate": 0
  },
  "creationDate": 0,
  "customAttributes": [
    {}
  ],
  "customFields": [
    {}
  ],
  "domain": "string",
  "enabledTerminologyFlow": false,
  "isDefault": false,
  "languages": [
    "string"
  ],
  "lastImportJob": {
    "creationDate": 0,
    "endTime": 0,
    "failureReason": "string",
    "fileName": "string",
    "glossaryId": 0,
    "id": 0,
    "jobExecutionId": 0,
    "jobName": "string",
    "jobType": "string",
    "processingTime": "string",
    "skippedTermsCount": 0,
    "startTime": 0,
    "status": "string",
    "termsCount": 0
  },
  "name": "string",
  "note": "string",
  "orgUnits": [
    {}
  ],
  "organization": {
    "accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "country": "string",
    "customFields": [],
    "id": 0,
    "logo": "string",
    "mtSettings": {},
    "name": "string",
    "orgUnitDrafts": [],
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "requiredTermFields": {
    "customAttributes": [],
    "fields": []
  },
  "subDomain": "string",
  "totalConcepts": 0,
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

PUT/api/v3/glossary

Update Glossary

Requires: GLOSSARY_update

Replaces the glossary with the body. An omitted domain or subDomain is cleared, and customAttributes is replaced by the list sent (an omitted list removes them all). An omitted or blank name and an omitted note keep their stored values.

Request body

GlossaryUpdateRequest

customAttributes map<string, object>[]
Replaces the stored list; omitted removes them all. Each item has name, type (SINGLE_VALUE, SINGLE_SELECT or MULTI_SELECT), value and, for the select types, options.
domain string
Domain name. Omitted clears it.
languages string[]
The full list of languages; omitted keeps the stored ones.
name string
Omitted or blank keeps the stored name.
note string
Omitted keeps the stored note.
subDomain string
Subdomain name. Omitted clears it.
uuidrequired string (uuid)
The glossary to update.

Responses

200 OK

GlossaryDto

allLanguages string[]
bwGlossaryId integer (int64)
createdBy UserDto
creationDate integer (int64)
customAttributes map<string, object>[]
customFields map<string, object>[]
domain string
enabledTerminologyFlow boolean
isDefault boolean
languages string[]
lastImportJob GlossaryJobDto
name string
note string
orgUnits OrganizationalUnitDto[]
organization OrganizationDto
requiredTermFields RequiredTermFields
subDomain string
totalConcepts integer
uuid string (uuid)

Request

curl -X PUT 'https://app.wxrks.com/api/v3/glossary' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "uuid": "bfb645fd-ad81-4f77-8744-0c13782b6243",
  "name": "Product terminology",
  "note": "Approved terms for the product UI.",
  "languages": [
    "en_us",
    "de_de",
    "fr_fr"
  ]
}'

Response 200

{
  "allLanguages": [
    "string"
  ],
  "bwGlossaryId": 0,
  "createdBy": {
    "accessKey": "string",
    "accessKeyTimestamp": 0,
    "accountOwner": false,
    "accountType": "CLI",
    "accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "address": "string",
    "address2": "string",
    "admin": false,
    "assignedJobs": 0,
    "avatar": "string",
    "captcha": "string",
    "cellPhone": "string",
    "city": "string",
    "companyName": "string",
    "completedJobs": 0,
    "country": "string",
    "currency": "string",
    "customFields": [],
    "dailyRate": 0,
    "defaultWorkflowRates": [],
    "deleteAllLanguagePair": false,
    "email": "string",
    "emailMagicCode": "string",
    "entryPoint": "WORKS_HOME",
    "externalId": "string",
    "forwardUrl": "string",
    "hourlyRate": 0,
    "id": 0,
    "invoicingDayOfMonth": "DAY_15",
    "invoicingPeriodicity": 0,
    "lastAccessAt": 0,
    "messageError": "string",
    "messageWarning": "string",
    "mfa": 0,
    "mfaEnabled": false,
    "minimumFee": 0,
    "name": "string",
    "nameEmail": "string",
    "newPassword": "string",
    "notes": "string",
    "notifyUser": false,
    "orgUnits": [],
    "organizations": [],
    "pagesRate": 0,
    "parentUserUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "paymentMethod": "PAYONEER",
    "payoneerId": "string",
    "paypalAccount": "string",
    "permissionGroups": [],
    "phone": "string",
    "postalCode": "string",
    "productName": "string",
    "punctuality": 0,
    "quickBooksVendorId": "string",
    "roles": [],
    "skypeId": "string",
    "slackHandle": "string",
    "state": "string",
    "status": "Active",
    "subUser": false,
    "subscriptions": [],
    "supportedLanguagePairs": [],
    "tags": [],
    "targetAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tasksCompletedCount": 0,
    "taxId": "string",
    "taxpayerId": "string",
    "timezone": "string",
    "totalJobs": 0,
    "useProjectCurrency": false,
    "userQualityMetrics": {},
    "userRates": [],
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "wordRate": 0
  },
  "creationDate": 0,
  "customAttributes": [
    {}
  ],
  "customFields": [
    {}
  ],
  "domain": "string",
  "enabledTerminologyFlow": false,
  "isDefault": false,
  "languages": [
    "string"
  ],
  "lastImportJob": {
    "creationDate": 0,
    "endTime": 0,
    "failureReason": "string",
    "fileName": "string",
    "glossaryId": 0,
    "id": 0,
    "jobExecutionId": 0,
    "jobName": "string",
    "jobType": "string",
    "processingTime": "string",
    "skippedTermsCount": 0,
    "startTime": 0,
    "status": "string",
    "termsCount": 0
  },
  "name": "string",
  "note": "string",
  "orgUnits": [
    {}
  ],
  "organization": {
    "accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "country": "string",
    "customFields": [],
    "id": 0,
    "logo": "string",
    "mtSettings": {},
    "name": "string",
    "orgUnitDrafts": [],
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "requiredTermFields": {
    "customAttributes": [],
    "fields": []
  },
  "subDomain": "string",
  "totalConcepts": 0,
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

GET/api/v3/glossary/{glossaryUuid}

Get Glossary

Requires: GLOSSARY_get_by_id

path parameters

glossaryUuidrequired string (uuid)

Responses

200 OK

GlossaryDto

allLanguages string[]
bwGlossaryId integer (int64)
createdBy UserDto
creationDate integer (int64)
customAttributes map<string, object>[]
customFields map<string, object>[]
domain string
enabledTerminologyFlow boolean
isDefault boolean
languages string[]
lastImportJob GlossaryJobDto
name string
note string
orgUnits OrganizationalUnitDto[]
organization OrganizationDto
requiredTermFields RequiredTermFields
subDomain string
totalConcepts integer
uuid string (uuid)

Request

curl -X GET 'https://app.wxrks.com/api/v3/glossary/{glossaryUuid}' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

{
  "allLanguages": [
    "string"
  ],
  "bwGlossaryId": 0,
  "createdBy": {
    "accessKey": "string",
    "accessKeyTimestamp": 0,
    "accountOwner": false,
    "accountType": "CLI",
    "accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "address": "string",
    "address2": "string",
    "admin": false,
    "assignedJobs": 0,
    "avatar": "string",
    "captcha": "string",
    "cellPhone": "string",
    "city": "string",
    "companyName": "string",
    "completedJobs": 0,
    "country": "string",
    "currency": "string",
    "customFields": [],
    "dailyRate": 0,
    "defaultWorkflowRates": [],
    "deleteAllLanguagePair": false,
    "email": "string",
    "emailMagicCode": "string",
    "entryPoint": "WORKS_HOME",
    "externalId": "string",
    "forwardUrl": "string",
    "hourlyRate": 0,
    "id": 0,
    "invoicingDayOfMonth": "DAY_15",
    "invoicingPeriodicity": 0,
    "lastAccessAt": 0,
    "messageError": "string",
    "messageWarning": "string",
    "mfa": 0,
    "mfaEnabled": false,
    "minimumFee": 0,
    "name": "string",
    "nameEmail": "string",
    "newPassword": "string",
    "notes": "string",
    "notifyUser": false,
    "orgUnits": [],
    "organizations": [],
    "pagesRate": 0,
    "parentUserUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "paymentMethod": "PAYONEER",
    "payoneerId": "string",
    "paypalAccount": "string",
    "permissionGroups": [],
    "phone": "string",
    "postalCode": "string",
    "productName": "string",
    "punctuality": 0,
    "quickBooksVendorId": "string",
    "roles": [],
    "skypeId": "string",
    "slackHandle": "string",
    "state": "string",
    "status": "Active",
    "subUser": false,
    "subscriptions": [],
    "supportedLanguagePairs": [],
    "tags": [],
    "targetAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tasksCompletedCount": 0,
    "taxId": "string",
    "taxpayerId": "string",
    "timezone": "string",
    "totalJobs": 0,
    "useProjectCurrency": false,
    "userQualityMetrics": {},
    "userRates": [],
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "wordRate": 0
  },
  "creationDate": 0,
  "customAttributes": [
    {}
  ],
  "customFields": [
    {}
  ],
  "domain": "string",
  "enabledTerminologyFlow": false,
  "isDefault": false,
  "languages": [
    "string"
  ],
  "lastImportJob": {
    "creationDate": 0,
    "endTime": 0,
    "failureReason": "string",
    "fileName": "string",
    "glossaryId": 0,
    "id": 0,
    "jobExecutionId": 0,
    "jobName": "string",
    "jobType": "string",
    "processingTime": "string",
    "skippedTermsCount": 0,
    "startTime": 0,
    "status": "string",
    "termsCount": 0
  },
  "name": "string",
  "note": "string",
  "orgUnits": [
    {}
  ],
  "organization": {
    "accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "country": "string",
    "customFields": [],
    "id": 0,
    "logo": "string",
    "mtSettings": {},
    "name": "string",
    "orgUnitDrafts": [],
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "requiredTermFields": {
    "customAttributes": [],
    "fields": []
  },
  "subDomain": "string",
  "totalConcepts": 0,
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

DELETE/api/v3/glossary/{glossaryUuid}

Delete Glossary

Requires: GLOSSARY_delete

path parameters

glossaryUuidrequired string (uuid)

Responses

200 OK

Request

curl -X DELETE 'https://app.wxrks.com/api/v3/glossary/{glossaryUuid}' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

POST/api/v3/glossary/{glossaryUuid}/clear

Clear Glossary

Requires: GLOSSARY_delete_term

path parameters

glossaryUuidrequired string (uuid)

Responses

200 OK

Request

curl -X POST 'https://app.wxrks.com/api/v3/glossary/{glossaryUuid}/clear' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

POST/api/v3/glossary/{glossaryUuid}/org-unit-settings

Associate Glossary with Org Units

Requires: ORG_UNIT_add_glossary

path parameters

glossaryUuidrequired string (uuid)

Request body

GlossaryOrgUnitSettingsParams

orgUnitUuids string (uuid)[]
settings OrgUnitSettings

Responses

200 OK

GlossaryOrgUnitSettingsDto[]

adaptiveTermInflectionEnabled boolean
glossaryUuid string (uuid)
isDefault boolean
learntTermsDefault boolean
orgUnitName string
orgUnitUuid string (uuid)
uuid string (uuid)

Request

curl -X POST 'https://app.wxrks.com/api/v3/glossary/{glossaryUuid}/org-unit-settings' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "orgUnitUuids": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "settings": {
    "adaptiveTermInflectionEnabled": false,
    "isDefault": false,
    "learntTermsDefault": false
  }
}'

Response 200

[
  {
    "adaptiveTermInflectionEnabled": false,
    "glossaryUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "isDefault": false,
    "learntTermsDefault": false,
    "orgUnitName": "string",
    "orgUnitUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
]

Terms

POST/api/v3/glossary/term

Create a New Term

Requires: GLOSSARY_create_term

glossaryUuid, text, language and status are required, and status must be Approved on create. The fields the glossary marks as required for terms must be filled too.

Request body

TermCreateRequest

caseSensitive boolean
conceptUuid string (uuid)
The concept the term belongs to.
definition string
Definition of the concept the term belongs to.
dnt boolean
Do not translate.
exactMatch boolean
forbidden boolean
gender stringMasculine Feminine Neutral Undefined
glossaryCustomAttributes map<string, object>[]
Values of the glossary's custom attributes. Each item has name, type and value.
glossaryUuidrequired string (uuid)
internal boolean
languagerequired string
One of the glossary's languages.
note string
part stringNoun Pronoun Adjective Determiner Verb Adverb Preposition Conjunction Interjection Acronym Other Proper Noun Undefined
rtl boolean
Right-to-left text.
statusrequired stringUnder_Review Approved Published Preferred Deprecated
Must be Approved on create.
termType stringFull Acronym
textrequired string
usage string
writable boolean

Responses

200 OK

TermEntryDto

caseSensitive boolean
conceptDefinition string
conceptId integer (int64)
conceptUuid string (uuid)
createdAt integer (int64)
definition string
dnt boolean
exactMatch boolean
forbidden boolean
forbiddenMetadata string
gender stringMasculine Feminine Neutral Undefined
glossaryCustomAttributes map<string, object>[]
glossaryUuid string (uuid)
id integer (int64)
internal boolean
language string
lastModifiedAt integer (int64)
learnt boolean
note string
part stringNoun Pronoun Adjective Determiner Verb Adverb Preposition Conjunction Interjection Acronym Other Proper Noun Undefined
rtl boolean
status stringUnder_Review Approved Published Preferred Deprecated
termType stringFull Acronym
text string
usage string
uuid string (uuid)
writable boolean

Request

curl -X POST 'https://app.wxrks.com/api/v3/glossary/term' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "glossaryUuid": "bfb645fd-ad81-4f77-8744-0c13782b6243",
  "text": "release note",
  "language": "en_us",
  "status": "Approved",
  "note": "Reviewed by the documentation team."
}'

Response 200

{
  "caseSensitive": false,
  "conceptDefinition": "string",
  "conceptId": 0,
  "conceptUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": 0,
  "definition": "string",
  "dnt": false,
  "exactMatch": false,
  "forbidden": false,
  "forbiddenMetadata": "string",
  "gender": "Undefined",
  "glossaryCustomAttributes": [
    {}
  ],
  "glossaryUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "id": 0,
  "internal": false,
  "language": "string",
  "lastModifiedAt": 0,
  "learnt": false,
  "note": "string",
  "part": "Noun",
  "rtl": false,
  "status": "Approved",
  "termType": "Full",
  "text": "string",
  "usage": "string",
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "writable": false
}

GET/api/v3/glossary/term/{termUuid}

Get Term

Requires: EDITOR_glossary_terms_search

path parameters

termUuidrequired string (uuid)

Responses

200 OK

TermEntryDto

caseSensitive boolean
conceptDefinition string
conceptId integer (int64)
conceptUuid string (uuid)
createdAt integer (int64)
definition string
dnt boolean
exactMatch boolean
forbidden boolean
forbiddenMetadata string
gender stringMasculine Feminine Neutral Undefined
glossaryCustomAttributes map<string, object>[]
glossaryUuid string (uuid)
id integer (int64)
internal boolean
language string
lastModifiedAt integer (int64)
learnt boolean
note string
part stringNoun Pronoun Adjective Determiner Verb Adverb Preposition Conjunction Interjection Acronym Other Proper Noun Undefined
rtl boolean
status stringUnder_Review Approved Published Preferred Deprecated
termType stringFull Acronym
text string
usage string
uuid string (uuid)
writable boolean

Request

curl -X GET 'https://app.wxrks.com/api/v3/glossary/term/{termUuid}' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

{
  "caseSensitive": false,
  "conceptDefinition": "string",
  "conceptId": 0,
  "conceptUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": 0,
  "definition": "string",
  "dnt": false,
  "exactMatch": false,
  "forbidden": false,
  "forbiddenMetadata": "string",
  "gender": "Undefined",
  "glossaryCustomAttributes": [
    {}
  ],
  "glossaryUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "id": 0,
  "internal": false,
  "language": "string",
  "lastModifiedAt": 0,
  "learnt": false,
  "note": "string",
  "part": "Noun",
  "rtl": false,
  "status": "Approved",
  "termType": "Full",
  "text": "string",
  "usage": "string",
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "writable": false
}

PUT/api/v3/glossary/term/{termUuid}

Update a Term

Requires: GLOSSARY_update_term

path parameters

termUuidrequired string (uuid)

Request body

TermUpdateRequest

caseSensitive boolean
conceptUuid string (uuid)
The concept the term belongs to.
definition string
Definition of the concept the term belongs to.
dnt boolean
Do not translate.
exactMatch boolean
forbidden boolean
gender stringMasculine Feminine Neutral Undefined
glossaryCustomAttributes map<string, object>[]
Values of the glossary's custom attributes. Each item has name, type and value.
internal boolean
note string
part stringNoun Pronoun Adjective Determiner Verb Adverb Preposition Conjunction Interjection Acronym Other Proper Noun Undefined
rtl boolean
Right-to-left text.
status stringUnder_Review Approved Published Preferred Deprecated
termType stringFull Acronym
text string
Omitted or blank keeps the stored text.
usage string
writable boolean

Responses

200 OK

TermEntryDto

caseSensitive boolean
conceptDefinition string
conceptId integer (int64)
conceptUuid string (uuid)
createdAt integer (int64)
definition string
dnt boolean
exactMatch boolean
forbidden boolean
forbiddenMetadata string
gender stringMasculine Feminine Neutral Undefined
glossaryCustomAttributes map<string, object>[]
glossaryUuid string (uuid)
id integer (int64)
internal boolean
language string
lastModifiedAt integer (int64)
learnt boolean
note string
part stringNoun Pronoun Adjective Determiner Verb Adverb Preposition Conjunction Interjection Acronym Other Proper Noun Undefined
rtl boolean
status stringUnder_Review Approved Published Preferred Deprecated
termType stringFull Acronym
text string
usage string
uuid string (uuid)
writable boolean

Request

curl -X PUT 'https://app.wxrks.com/api/v3/glossary/term/{termUuid}' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "text": "Versionshinweis",
  "status": "Under_Review",
  "note": "Reviewed by the documentation team."
}'

Response 200

{
  "caseSensitive": false,
  "conceptDefinition": "string",
  "conceptId": 0,
  "conceptUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": 0,
  "definition": "string",
  "dnt": false,
  "exactMatch": false,
  "forbidden": false,
  "forbiddenMetadata": "string",
  "gender": "Undefined",
  "glossaryCustomAttributes": [
    {}
  ],
  "glossaryUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "id": 0,
  "internal": false,
  "language": "string",
  "lastModifiedAt": 0,
  "learnt": false,
  "note": "string",
  "part": "Noun",
  "rtl": false,
  "status": "Approved",
  "termType": "Full",
  "text": "string",
  "usage": "string",
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "writable": false
}

DELETE/api/v3/glossary/term/{termUuid}

Delete a Term

Requires: GLOSSARY_delete_term

path parameters

termUuidrequired string (uuid)

Responses

200 OK

Request

curl -X DELETE 'https://app.wxrks.com/api/v3/glossary/term/{termUuid}' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

GET/api/v3/glossary/term/{termUuid}/translations

Get Translations for a Term

Requires: EDITOR_glossary_terms_search

path parameters

termUuidrequired string (uuid)

Responses

200 OK

TermDTO[]

caseSensitive boolean
commentsAboutReview string
concept ConceptDTO
createdAt integer (int64)
definition string
dnt boolean
exactMatch boolean
forbidden boolean
gender stringMasculine Feminine Neutral Undefined
glossary GlossaryThinDTO
id integer (int64)
internal boolean
isRequestedReview boolean
language string
lastModifiedAt integer (int64)
legal boolean
note string
part stringNoun Pronoun Adjective Determiner Verb Adverb Preposition Conjunction Interjection Acronym Other Proper Noun Undefined
requestReviewAt integer (int64)
requestReviewBy string
rtl boolean
status stringUnder_Review Approved Published Preferred Deprecated
termArbitrationStatus stringREQUESTED IN_PROGRESS CLOSED
termType stringFull Acronym
termsLinked TermLinkedDTO[]
text string
usage string
writable boolean

Request

curl -X GET 'https://app.wxrks.com/api/v3/glossary/term/{termUuid}/translations' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

[
  {
    "caseSensitive": false,
    "commentsAboutReview": "string",
    "concept": {},
    "createdAt": 0,
    "definition": "string",
    "dnt": false,
    "exactMatch": false,
    "forbidden": false,
    "gender": "Masculine",
    "glossary": {},
    "id": 0,
    "internal": false,
    "isRequestedReview": false,
    "language": "string",
    "lastModifiedAt": 0,
    "legal": false,
    "note": "string",
    "part": "Noun",
    "requestReviewAt": 0,
    "requestReviewBy": "string",
    "rtl": false,
    "status": "Under_Review",
    "termArbitrationStatus": "REQUESTED",
    "termType": "Full",
    "termsLinked": [],
    "text": "string",
    "usage": "string",
    "writable": false
  }
]

POST/api/v3/glossary/term/check-duplicated

Check for Duplicated Terms

Requires: EDITOR_add_terms

Request body

CheckDuplicatedTermsRequest

glossaryIdsrequired integer (int64)[]
Ids (bwGlossaryId) of the glossaries to check. Each must be readable by the caller.
sourceLanguagerequired string
sourceTermrequired string
targetLanguagerequired string
targetTermrequired string
taskUuids string (uuid)[]
Tasks that give a vendor access to their projects' glossaries.

Responses

200 OK

boolean

Request

curl -X POST 'https://app.wxrks.com/api/v3/glossary/term/check-duplicated' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "glossaryIds": [
    1042
  ],
  "sourceLanguage": "en_us",
  "sourceTerm": "release note",
  "targetLanguage": "de_de",
  "targetTerm": "Versionshinweis"
}'

Response 200

false

GET/api/v3/glossary/term/recognition

Search Terms (Term Recognition)

Requires: EDITOR_glossary_terms_search

query parameters

textrequired string
Text to search for terms.
sourceLanguagerequired string
Language of the text.
glossaryUuidsrequired string (uuid)[]
Glossaries to search.
targetLanguage string

Responses

200 OK

TermEntryOnSegment[]

contextProjectId string (uuid)
contextWorkId string (uuid)
sourceTerm TermTranslationDTO
targetTerm TermTranslationDTO

Request

curl -X GET 'https://app.wxrks.com/api/v3/glossary/term/recognition?text=Click%20Save%20to%20keep%20your%20changes.&sourceLanguage=en_us&glossaryUuids=bfb645fd-ad81-4f77-8744-0c13782b6243' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

[
  {
    "contextProjectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "contextWorkId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "sourceTerm": {},
    "targetTerm": {}
  }
]

GET/api/v3/glossary/term/search/params

Search Terms by Parameters

Requires: EDITOR_glossary_terms_search

query parameters

query string
queryLocale string
targetLocale string
filename string
statusList string[]
glossaryIds integer (int64)[]
tmId integer (int64)[]
rtl boolean
createdByUuid string (uuid)
modifiedByUuid string (uuid)
createdAtStart integer (int64)
createdAtEnd integer (int64)
modifiedAtStart integer (int64)
modifiedAtEnd integer (int64)
projectId string (uuid)
workUnitId string (uuid)
workflowUuid string (uuid)
matchType stringContains StartsWith EndsWith ExactMatch Expression
ignoreCase boolean
page integer
pageSize integer
offset integer (int64)
orderBy string[]
sortDirection string
isSourceLocale boolean

Responses

200 OK

PageTermEntryOnSegment

content TermEntryOnSegment[]
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/v3/glossary/term/search/params' \
  -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
}

GET/api/v3/glossary/term/search/segment

Search Terms Based on a Segment

Requires: EDITOR_glossary_terms_search

Finds the terms that occur in the segment. glossaryIds chooses the glossaries to search; without it, the search covers every glossary the caller can reach. A vendor reaches a project's glossaries through workUnitId, a work unit where it has a task. When no glossary is reachable, the answer is [].

query parameters

segmentrequired string
Segment text to search for terms.
sourceLanguagerequired string
Language of the segment.
targetLanguage string
Language of the translations to return. Without it, each term found comes with sourceTerm only and no targetTerm.
forbidden boolean
workUnitId string (uuid)
statusList string[]
glossaryIds integer (int64)[]
matchType stringContains StartsWith EndsWith ExactMatch Expression
orderByGlossaryPriority boolean

Responses

200 OK

TermEntryOnSegment[]

contextProjectId string (uuid)
contextWorkId string (uuid)
sourceTerm TermTranslationDTO
targetTerm TermTranslationDTO

Request

curl -X GET 'https://app.wxrks.com/api/v3/glossary/term/search/segment?segment=Click%20Save%20to%20keep%20your%20changes.&sourceLanguage=en_us' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

[
  {
    "contextProjectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "contextWorkId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "sourceTerm": {},
    "targetTerm": {}
  }
]

Concept Entries

GET/api/v3/glossary/{glossaryUuid}/concept-entries

List Concept Entries

Requires: GLOSSARY_get_by_id

query parameters

conceptUuid string (uuid)
glossaryUuid string (uuid)
language string
text string
matchMode stringCONTAINS EXACT STARTS_WITH
languages string[]
strictLanguageMatch boolean
createdBy string (uuid)
createdAtStart integer (int64)
createdAtEnd integer (int64)
lastModifiedAtStart integer (int64)
lastModifiedAtEnd integer (int64)
status string[]
customAttributeName string
customAttributeType string
customAttributeValue string
sort string
page integer
Page to return, starting at 0.
size integer
Items per page.

Responses

200 OK

PageConceptEntryDtoV3

content ConceptEntryDtoV3[]
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/v3/glossary/{glossaryUuid}/concept-entries' \
  -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
}

GET/api/v3/glossary/concept-entries/{conceptId}

Get a Concept Entry

Requires: GLOSSARY_get_by_id

path parameters

conceptIdrequired integer (int64)

Responses

200 OK

ConceptEntryDtoV3

createdDate integer (int64)
definition string
id integer (int64)
note string
terms TermEntryDto[]
uuid string (uuid)

Request

curl -X GET 'https://app.wxrks.com/api/v3/glossary/concept-entries/{conceptId}' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

{
  "createdDate": 0,
  "definition": "string",
  "id": 0,
  "note": "string",
  "terms": [
    {}
  ],
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Import and Export

POST/api/v3/glossary/{glossaryUuid}/import

Import TBX

Requires: GLOSSARY_update

Imports a TBX or XLSX file into the glossary. The file name's extension (.tbx or .xlsx) decides the format.

path parameters

glossaryUuidrequired string (uuid)

Request body

objectmultipart/form-data

Responses

200 OK

GlossaryJobDto

creationDate integer (int64)
endTime integer (int64)
failureReason string
fileName string
glossaryId integer (int64)
id integer (int64)
jobExecutionId integer (int64)
jobName string
jobType string
processingTime string
skippedTermsCount integer
startTime integer (int64)
status string
termsCount integer (int64)

Request

curl -X POST 'https://app.wxrks.com/api/v3/glossary/{glossaryUuid}/import' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -F 'file=@./glossary.tbx'

Response 200

{
  "creationDate": 0,
  "endTime": 0,
  "failureReason": "string",
  "fileName": "string",
  "glossaryId": 0,
  "id": 0,
  "jobExecutionId": 0,
  "jobName": "string",
  "jobType": "string",
  "processingTime": "string",
  "skippedTermsCount": 0,
  "startTime": 0,
  "status": "string",
  "termsCount": 0
}

GET/api/v3/glossary/{glossaryUuid}/jobs

List Imports

Requires: GLOSSARY_get_by_id

path parameters

glossaryUuidrequired string (uuid)

query parameters

glossaryId integer (int64)
jobType string
sort string
page integer
Page to return, starting at 0.
size integer
Items per page.

Responses

200 OK

GlossaryJobDto[]

creationDate integer (int64)
endTime integer (int64)
failureReason string
fileName string
glossaryId integer (int64)
id integer (int64)
jobExecutionId integer (int64)
jobName string
jobType string
processingTime string
skippedTermsCount integer
startTime integer (int64)
status string
termsCount integer (int64)

Request

curl -X GET 'https://app.wxrks.com/api/v3/glossary/{glossaryUuid}/jobs' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

[
  {
    "creationDate": 0,
    "endTime": 0,
    "failureReason": "string",
    "fileName": "string",
    "glossaryId": 0,
    "id": 0,
    "jobExecutionId": 0,
    "jobName": "string",
    "jobType": "string",
    "processingTime": "string",
    "skippedTermsCount": 0,
    "startTime": 0,
    "status": "string",
    "termsCount": 0
  }
]

GET/api/v3/glossary/{glossaryUuid}/last-import-job

Last Import

Requires: GLOSSARY_get_by_id

path parameters

glossaryUuidrequired string (uuid)

Responses

200 OK

GlossaryJobDto

creationDate integer (int64)
endTime integer (int64)
failureReason string
fileName string
glossaryId integer (int64)
id integer (int64)
jobExecutionId integer (int64)
jobName string
jobType string
processingTime string
skippedTermsCount integer
startTime integer (int64)
status string
termsCount integer (int64)

Request

curl -X GET 'https://app.wxrks.com/api/v3/glossary/{glossaryUuid}/last-import-job' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

{
  "creationDate": 0,
  "endTime": 0,
  "failureReason": "string",
  "fileName": "string",
  "glossaryId": 0,
  "id": 0,
  "jobExecutionId": 0,
  "jobName": "string",
  "jobType": "string",
  "processingTime": "string",
  "skippedTermsCount": 0,
  "startTime": 0,
  "status": "string",
  "termsCount": 0
}

GET/api/v3/glossary/export/{glossaryUuid}/{fileType}

Init Export Glossary

Requires: GLOSSARY_export

path parameters

glossaryUuidrequired string (uuid)
fileTyperequired string

query parameters

languages string[]
exportFields string[]
customAttributes string[]

Responses

200 OK

DownloadTranslatedFiles

downloadUrl string
error string
requestUuid string (uuid)
status string

Request

curl -X GET 'https://app.wxrks.com/api/v3/glossary/export/{glossaryUuid}/{fileType}' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

{
  "downloadUrl": "string",
  "error": "string",
  "requestUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "string"
}

GET/api/v3/glossary/export/{glossaryUuid}/{fileType}/{requestUUID}/status

Export Glossary Status

Requires: GLOSSARY_export

path parameters

glossaryUuidrequired string (uuid)
fileTyperequired string
requestUUIDrequired string (uuid)

Responses

200 OK

DownloadTranslatedFiles

downloadUrl string
error string
requestUuid string (uuid)
status string

Request

curl -X GET 'https://app.wxrks.com/api/v3/glossary/export/{glossaryUuid}/{fileType}/{requestUUID}/status' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

{
  "downloadUrl": "string",
  "error": "string",
  "requestUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "string"
}