Skip to content

Class.TermbaseApi

Jump to bottom
Octavian Condre edited this page Dec 10, 2025 · 4 revisions

Trados User Interface Extensibility / TermbaseApi

Class: TermbaseApi

Defined in: lc-public-api/apis/TermbaseApi.ts:128

Extends

  • BaseAPI

Constructors

Constructor

new TermbaseApi(configuration): TermbaseApi

Defined in: lc-public-api/runtime.ts:97

Parameters

configuration

Configuration = DefaultConfig

Returns

TermbaseApi

Inherited from

runtime.BaseAPI.constructor

Methods

createTermbase()

createTermbase(requestParameters, initOverrides?): Promise<Termbase>

Defined in: lc-public-api/apis/TermbaseApi.ts:182

Creates a new termbase. The termbase can be created with a termbase template by providing the templateId or by providing a custom termbaseStructure. If only a termbaseTemplateId was provided, the termbase will be created using data from the template. If only a termbaseStructure was provided, the termbase will be created using data from the structure. If both, termbaseTemplateId and termbaseStructure are added in the request, the termbaseStructure takes precedence. Create Termbase

Parameters

requestParameters

CreateTermbaseRequest

initOverrides?

RequestInit | InitOverrideFunction

Returns

Promise<Termbase>

createTermbaseEntry()

createTermbaseEntry(requestParameters, initOverrides?): Promise<TermbaseEntry>

Defined in: lc-public-api/apis/TermbaseApi.ts:246

Creates a new termbase entry. For more information about how to use fieldValueLinks see Create termbase entry. Create Termbase Entry

Parameters

requestParameters

CreateTermbaseEntryRequest

initOverrides?

RequestInit | InitOverrideFunction

Returns

Promise<TermbaseEntry>

createTermbaseEntryRaw()

createTermbaseEntryRaw(requestParameters, initOverrides?): Promise<ApiResponse<TermbaseEntry>>

Defined in: lc-public-api/apis/TermbaseApi.ts:191

Creates a new termbase entry. For more information about how to use fieldValueLinks see Create termbase entry. Create Termbase Entry

Parameters

requestParameters

CreateTermbaseEntryRequest

initOverrides?

RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<TermbaseEntry>>

createTermbaseRaw()

createTermbaseRaw(requestParameters, initOverrides?): Promise<ApiResponse<Termbase>>

Defined in: lc-public-api/apis/TermbaseApi.ts:134

Creates a new termbase. The termbase can be created with a termbase template by providing the templateId or by providing a custom termbaseStructure. If only a termbaseTemplateId was provided, the termbase will be created using data from the template. If only a termbaseStructure was provided, the termbase will be created using data from the structure. If both, termbaseTemplateId and termbaseStructure are added in the request, the termbaseStructure takes precedence. Create Termbase

Parameters

requestParameters

CreateTermbaseRequest

initOverrides?

RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<Termbase>>

deleteTermbase()

deleteTermbase(requestParameters, initOverrides?): Promise<void>

Defined in: lc-public-api/apis/TermbaseApi.ts:303

Deletes a termbase by identifier. Delete Termbase

Parameters

requestParameters

DeleteTermbaseRequest

initOverrides?

RequestInit | InitOverrideFunction

Returns

Promise<void>

deleteTermbaseEntries()

deleteTermbaseEntries(requestParameters, initOverrides?): Promise<void>

Defined in: lc-public-api/apis/TermbaseApi.ts:359

Deletes all the entries in the termbase. Delete Termbase Entries

Parameters

requestParameters

DeleteTermbaseEntriesRequest

initOverrides?

RequestInit | InitOverrideFunction

Returns

Promise<void>

deleteTermbaseEntriesRaw()

deleteTermbaseEntriesRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Defined in: lc-public-api/apis/TermbaseApi.ts:311

Deletes all the entries in the termbase. Delete Termbase Entries

Parameters

requestParameters

DeleteTermbaseEntriesRequest

initOverrides?

RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<void>>

deleteTermbaseEntry()

deleteTermbaseEntry(requestParameters, initOverrides?): Promise<void>

Defined in: lc-public-api/apis/TermbaseApi.ts:422

Deletes a termbase entry. Delete Termbase Entry

Parameters

requestParameters

DeleteTermbaseEntryRequest

initOverrides?

RequestInit | InitOverrideFunction

Returns

Promise<void>

deleteTermbaseEntryRaw()

deleteTermbaseEntryRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Defined in: lc-public-api/apis/TermbaseApi.ts:367

Deletes a termbase entry. Delete Termbase Entry

Parameters

requestParameters

DeleteTermbaseEntryRequest

initOverrides?

RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<void>>

deleteTermbaseRaw()

deleteTermbaseRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Defined in: lc-public-api/apis/TermbaseApi.ts:255

Deletes a termbase by identifier. Delete Termbase

Parameters

requestParameters

DeleteTermbaseRequest

initOverrides?

RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<void>>

getTermbase()

getTermbase(requestParameters, initOverrides?): Promise<Termbase>

Defined in: lc-public-api/apis/TermbaseApi.ts:482

Retrieves a termbase by identifier. Get Termbase

Parameters

requestParameters

GetTermbaseRequest

initOverrides?

RequestInit | InitOverrideFunction

Returns

Promise<Termbase>

getTermbaseEntry()

getTermbaseEntry(requestParameters, initOverrides?): Promise<TermbaseEntry>

Defined in: lc-public-api/apis/TermbaseApi.ts:550

Retrieves a termbase entry by identifier. Get Termbase Entry

Parameters

requestParameters

GetTermbaseEntryRequest

initOverrides?

RequestInit | InitOverrideFunction

Returns

Promise<TermbaseEntry>

getTermbaseEntryRaw()

getTermbaseEntryRaw(requestParameters, initOverrides?): Promise<ApiResponse<TermbaseEntry>>

Defined in: lc-public-api/apis/TermbaseApi.ts:491

Retrieves a termbase entry by identifier. Get Termbase Entry

Parameters

requestParameters

GetTermbaseEntryRequest

initOverrides?

RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<TermbaseEntry>>

getTermbaseRaw()

getTermbaseRaw(requestParameters, initOverrides?): Promise<ApiResponse<Termbase>>

Defined in: lc-public-api/apis/TermbaseApi.ts:430

Retrieves a termbase by identifier. Get Termbase

Parameters

requestParameters

GetTermbaseRequest

initOverrides?

RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<Termbase>>

listTermbase()

listTermbase(requestParameters, initOverrides?): Promise<ListTermbasesResponse>

Defined in: lc-public-api/apis/TermbaseApi.ts:620

List termbases. List Termbases

Parameters

requestParameters

ListTermbaseRequest

initOverrides?

RequestInit | InitOverrideFunction

Returns

Promise<ListTermbasesResponse>

listTermbaseEntries()

listTermbaseEntries(requestParameters, initOverrides?): Promise<ListTermbaseEntriesResponse>

Defined in: lc-public-api/apis/TermbaseApi.ts:693

Retrieves a list of all the entries in a termbase. List Termbase Entries

Parameters

requestParameters

ListTermbaseEntriesRequest

initOverrides?

RequestInit | InitOverrideFunction

Returns

Promise<ListTermbaseEntriesResponse>

listTermbaseEntriesRaw()

listTermbaseEntriesRaw(requestParameters, initOverrides?): Promise<ApiResponse<ListTermbaseEntriesResponse>>

Defined in: lc-public-api/apis/TermbaseApi.ts:629

Retrieves a list of all the entries in a termbase. List Termbase Entries

Parameters

requestParameters

ListTermbaseEntriesRequest

initOverrides?

RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<ListTermbaseEntriesResponse>>

listTermbaseRaw()

listTermbaseRaw(requestParameters, initOverrides?): Promise<ApiResponse<ListTermbasesResponse>>

Defined in: lc-public-api/apis/TermbaseApi.ts:559

List termbases. List Termbases

Parameters

requestParameters

ListTermbaseRequest

initOverrides?

RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<ListTermbasesResponse>>

listTermbaseTerms()

listTermbaseTerms(requestParameters, initOverrides?): Promise<ListTermbaseTermsResponse>

Defined in: lc-public-api/apis/TermbaseApi.ts:777

Retrieves a list of all the terms of the termbase. Search types: - normal: Use normal search to look for terms that match the text exactly as entered. - linguistic: Use linguistic search to look for terms that are similar to the search term. Linguistic search is based on stemming and other language-dependent aspects. - fuzzy: Use fuzzy search to look for terms that are similar to the search term. Fuzzy search is more fault-tolerant than linguistic search. List Termbase Terms

Parameters

requestParameters

ListTermbaseTermsRequest

initOverrides?

RequestInit | InitOverrideFunction

Returns

Promise<ListTermbaseTermsResponse>

listTermbaseTermsRaw()

listTermbaseTermsRaw(requestParameters, initOverrides?): Promise<ApiResponse<ListTermbaseTermsResponse>>

Defined in: lc-public-api/apis/TermbaseApi.ts:702

Retrieves a list of all the terms of the termbase. Search types: - normal: Use normal search to look for terms that match the text exactly as entered. - linguistic: Use linguistic search to look for terms that are similar to the search term. Linguistic search is based on stemming and other language-dependent aspects. - fuzzy: Use fuzzy search to look for terms that are similar to the search term. Fuzzy search is more fault-tolerant than linguistic search. List Termbase Terms

Parameters

requestParameters

ListTermbaseTermsRequest

initOverrides?

RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<ListTermbaseTermsResponse>>

updateTermbase()

updateTermbase(requestParameters, initOverrides?): Promise<void>

Defined in: lc-public-api/apis/TermbaseApi.ts:837

Updates the termbase. The termbase can be updated with a termbase template by providing the termbaseTemplateId or by providing a custom termbaseStructure. If only a termbaseTemplateId was provided, the termbase will be updated using data from the template. If only a termbaseStructure was provided, the termbase will be updated using data from the structure. If both, termbaseTemplateId and termbaseStructure are added in the request, the termbaseStructure takes precedence. Update Termbase

Parameters

requestParameters

UpdateTermbaseRequest

initOverrides?

RequestInit | InitOverrideFunction

Returns

Promise<void>

updateTermbaseEntry()

updateTermbaseEntry(requestParameters, initOverrides?): Promise<void>

Defined in: lc-public-api/apis/TermbaseApi.ts:903

Updates a termbase entry by identifier. The request body will overwrite the existing data. Update Termbase Entry

Parameters

requestParameters

UpdateTermbaseEntryRequest

initOverrides?

RequestInit | InitOverrideFunction

Returns

Promise<void>

updateTermbaseEntryRaw()

updateTermbaseEntryRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Defined in: lc-public-api/apis/TermbaseApi.ts:845

Updates a termbase entry by identifier. The request body will overwrite the existing data. Update Termbase Entry

Parameters

requestParameters

UpdateTermbaseEntryRequest

initOverrides?

RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<void>>

updateTermbaseRaw()

updateTermbaseRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Defined in: lc-public-api/apis/TermbaseApi.ts:786

Updates the termbase. The termbase can be updated with a termbase template by providing the termbaseTemplateId or by providing a custom termbaseStructure. If only a termbaseTemplateId was provided, the termbase will be updated using data from the template. If only a termbaseStructure was provided, the termbase will be updated using data from the structure. If both, termbaseTemplateId and termbaseStructure are added in the request, the termbaseStructure takes precedence. Update Termbase

Parameters

requestParameters

UpdateTermbaseRequest

initOverrides?

RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<void>>

withMiddleware()

withMiddleware<T>(this, ...middlewares): T

Defined in: lc-public-api/runtime.ts:101

Type Parameters

T

T extends BaseAPI

Parameters

this

T

middlewares

...Middleware[]

Returns

T

Inherited from

runtime.BaseAPI.withMiddleware

withPostMiddleware()

withPostMiddleware<T>(this, ...postMiddlewares): T

Defined in: lc-public-api/runtime.ts:112

Type Parameters

T

T extends BaseAPI

Parameters

this

T

postMiddlewares

...((context) => Promise<void | Response> | undefined)[]

Returns

T

Inherited from

runtime.BaseAPI.withPostMiddleware

withPreMiddleware()

withPreMiddleware<T>(this, ...preMiddlewares): T

Defined in: lc-public-api/runtime.ts:107

Type Parameters

T

T extends BaseAPI

Parameters

this

T

preMiddlewares

...((context) => Promise<void | FetchParams> | undefined)[]

Returns

T

Inherited from

runtime.BaseAPI.withPreMiddleware

API

Classes

Interfaces

Type Aliases

Variables

Functions

Clone this wiki locally