Developer

Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Name

Type

Info

id

integer

GET only

entityVersionintegerGET only, set by server
langResUuidstringGET only, is ignored on PUT/POST, is an auto generated UUID set on language resource creation. Contains a unique identified for the language resource.
specificIdstringGET only, is ignored on PUT/POST, is an ID coming from service behind the language resource, if any. Default null.

name

string

Custom name of the match resource.

forcedbooleanDELETE only, If set to true, all task associations will be removed before delete
deleteLocallybooleanDELETE only, if set to true, the resource will be only removed from the local translate5 instance. When set to false, the connector will try to remove this resource from remote if exist(ex: t5memory exist once as translate5 resource and once as memory on t5memory side)
sourceLangintegerGET / POST, non editable after creation; numeric DB id of the language
targetLangintegerGET / POST, non editable after creation; numeric DB id of the language

color

string

Custom color of the match resource in hexadecimal form, used in the GUI.

resourceId

string

POST / GET, non editable after creation

serviceType

string

POST / GET, only, set by setting a resourceId

serviceName

string

GET only, set by setting a resourceId

status

string

GET only, possible values: notchecked, error, available, unknown, noconnection, novalidlicense, notloaded, quotaexceeded, reorganize, reorganize failed, tuninginprogress, import

fileNamestring

POST / GET, can not be changed

filebasedbooleanGET only, set by setting a resourceId
searchablebooleanGET only, set by setting a resourceId
customerIdsarray of integers

POST, PUT: contains an array with customerIds to be assigned to that language resource

customerUseAsDefaultIdsarray of integers

POST, PUT: contains a subset of customerIds of the above customerIds. The here referenced customers use this language resource by default to read from.

customerWriteAsDefaultIdsarray of integers

POST, PUT: contains a subset of customer ids of the above customerUseAsDefaultIds. The here referenced customers use this language resource by default to write into it.To be able to write by default

the customer must be also set as read as default.

customerPivotAsDefaultIdsarray of integers

POST, PUT: All customers listed here will use this language resource when assigned to a task for pivot pre-translation. All of the listed customers in customerPivotAsDefaultIds must be also contained in customerIds.

configKeyModestring

POST only, required for resources where the resource property supportsClientConfigOverrides is true (ChatGPT (OpenAI), Azure OpenAI and translate5 AI), ignored for all other resources. Defines which configuration (API URL, API key, Azure deployment settings) the language resource uses:

  • system: the system-level configuration. The language resource can be assigned to several customers.
  • client: the configuration overrides of one customer. customerIds must contain exactly one customer, and this customer must have configuration overrides for the resource (see /editor/languageresourceresource/[serviceName]/clients on LanguageResources: Resource).

Cannot be changed after creation. The customer assignment of a language resource with configKeyMode client cannot be changed either. On GET the value is returned in specificData.configKeyMode. Available from translate5 version 7.45.0.

Configuration of the Language Resources

...