Page tree
Skip to end of metadata
Go to start of metadata


If the API changes in an incompatible manner this is listed explicitly in the "important release notes" section of each releases changelog.

Provides access to the customers available in the application.

URL:

/editor/customer

Available Methods:

GET / POST / PUT / DELETE

Specialities:

-

Availability:

This functionality is only available for users with special right

Resource Layout

Name

Type

Info

id

string

The id of the customer

name

string

The name of the customer

numberstringCustomer number. It is unique field
searchCharacterLimitinteger

Character translation limit which all resources of this customer will have.

This limitation can also be defined for each language resource separately (runtimeOptions.LanguageResources.searchCharacterLimit) 

domainstring

transate5 domain for this customer. Used for SSO and IpBasedAuthentication.

openIdServer

openIdServerRoles

openIdAuth2Url

openIdClientId

openIdClientSecret

openIdRedirectLabel

openIdRedirectCheckbox

openIdIssuer

openIdDefaultServerRoles

mixedOpen id specific customer fields. For more info about those fields, check this link: OpenID connect in translate5

Special customer Export URLs

URL:

/editor/customer/exportresource/

Available Methods:

GET

Specialities:

Export language resources usage for single (when customerId is provided as parameter) or all customers as excel document

Availability:

This functionality is only available for users with special right

Resource layout
NameTypeInfo
customerIdintOptional parameter. If provided, only resources for this customer will be exported.
taskTypestringOptional parameter (comma separated if multiple taskTypes are required). If provided, "Documents by month" will contain documents of this task type. Default to "default","projectTask"
  • No labels