Developer

Page tree

Provides a list with the available language resource services, as they are configured in translate5.

URL:

/editor/languageresourceresource

Available Methods:

GET listing only

Specialities:

Data is generated depending on the available and configured match resource services.

Resource Layout

Name

Type

Info

id

string

GET only

name

string

GET only, defined by the service and depends on the configured resources of the service.

serviceNamestringGET only, defined by the service (readable name of the service)

serviceType

string

GET only, defined by the service (PHP class name)

filebased

boolean

GET only, defined by the service

searchable

boolean

GET only, defined by the service

defaultColor

string

GET only, defined by the service

writablebooleanGET only, Flag if edited matches can be saved back to this resource
sourceLanguagesarrayGET only, Available source language codes for the resources.
targetLanguagesarrayGET only, Available target language codes for the resources.
creatablebooleanGET only, Shows if a resource can be created
specificIdstringGET only, identifier coming from the service
supportsClientConfigOverridesbooleanGET only, true if language resources of this service can use the configuration overrides of a customer instead of the system-level configuration. In this case configKeyMode is required when creating a language resource, see LanguageResources: Instance. Available from translate5 version 7.45.0.

Special URLs

URLMethodsParametersDescription
/editor/languageresourceresource/[serviceName]/clientsGET

keyMode (string, required): system, client or all

Lists the customers that can be assigned to a new language resource of the given service with the given configKeyMode. With keyMode client, only customers with configuration overrides for this service are returned. Only customers the authenticated user may see are returned.

/editor/languageresourceresource/[serviceName]/configGET

customerId (integer, optional)

Returns isConfigured, isDeploymentCapable and engineBased for the configuration of the given customer, or for the system-level configuration if customerId is omitted. isDeploymentCapable is only set for Azure OpenAI: if false, the deployment name must be given on creation instead of selecting a model.

/editor/languageresourceresource/[serviceName]/enginesGET

customerId (integer, optional)

Lists the engines/models of an engine-based service. With customerId the list is based on the configuration of this customer, otherwise on the system-level configuration. Each row contains id, name, source, sourceIso, target, targetIso, domainCode and engineName.



  • No labels