API routes (Click a route to expand it, click here to expand/collapse all)
Default APIs
GET/ ⎘
Provides the API-specification. Only enabled if API exposure is enabled.
Parameter Location Type Requirements Optional Default value Description
format URI-Query string
enum: [ "KateAPI", "InternalAPIMap", "OpenAPI", "Swagger" ]
 Yes "KateAPI" Documentation format. We support KateAPI documentation, Swagger/OpenAPI documentation and raw output of the internal API-map cache.
openApiVersion URI-Query int
enum: [ 2, 3 ]
 Yes 2 Version 3 is crappy with request bodies, so we prefer version 2 (which only sucks regarding Response definitions; hence we prefer KateAPI documentation).
Response HTTP Type Description
Success 200 object The API-documentation.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
No
Migration Translation API
GET/migration/translations/{rfc5646languageTag}/{rootNamespace} ⎘Authentication required
Obtain all the translations for given language for migration-purposes.
Parameter Location Type Requirements Optional Default value Description
rfc5646languageTag URI-Path string
format: [A-Za-z0-9-]+
 No Language to retrieve, for example "en", "en-US" or "en-US-x-cw".
rootNamespace URI-Path string
enum: [ "red", "wf" ]
 No Root Namespace to retrieve, for example "ui" "red".
Response HTTP Type Description
Success 200 array Language data, either in nested form or as a flat map. Note that this is not always the entire language data, but may be an increment. Always perform a deep merge. This method reserves the right to provide full or incremental results.
TranslationLanguageNotFoundException 404 Provided language could not be found.
RestrictedLanguageException 403 This language is restricted to authorized parties only.
TranslationNamespaceNotFoundException 404 Provided translation namespace could not be found.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
kate:migration ⎘
Translation API
GET/translations/getMissingList ⎘Authentication required
Get list of missing translations.
Parameter Location Type Requirements Optional Default value Description
missingType URI-Query string
enum: [ "TranslationNotFound", "NamespaceNotFound" ]
 No type of missing translations
rfc5646languageTag URI-Query string
format: [A-Za-z0-9-]+
 Yes null Language to retrieve, for example "en", "en-US" or "en-US-x-cw".
Response HTTP Type Description
Success 200 array keys of translations that have missing translations
TranslationLanguageNotFoundException 404 Provided language could not be found.
RestrictedLanguageException 403 This language is restricted to authorized parties only.
TranslationNamespaceNotFoundException 404 Provided translation namespace could not be found.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
('pres:propose' OR 'pres:review') ⎘
GET/translations/{rfc5646languageTag}/missing ⎘Authentication required
Obtain a specific set of translation leafs for given language. Note that these must be actual translation nodes, and cannot contain child namespaces.
Parameter Location Type Requirements Optional Default value Description
rfc5646languageTag URI-Path string
format: [A-Za-z0-9-]+
 No Language to retrieve, for example "en", "en-US" or "en-US-x-cw".
namespaces URI-Query string[]
format: ((?:err|mail|mgmt|red|report|ui|wf)(?:\.[-_A-Za-z0-9]+)+)
 No Array of translation namespace-leafs to retrieve.
fallbackStrategy URI-Query string
enum: [ "none", "inherit", "always" ]
 Yes "inherit" Fallback strategy in case of missing translations. "none": No fallback to other languages, returns null for missing data. "inherit": Fallback to fallback language only when language is defined as inherited language, return null otherwise (default). "always": Always fallback to fallback language until the primary language (en) is reached.
Response HTTP Type Description
Success 200 { [key: string]: string|null } Key-value map, with keys corresponding to the requested namespaces, and values either their translation string or null if not found.
TranslationLanguageNotFoundException 404 Provided language could not be found.
RestrictedLanguageException 403 This language is restricted to authorized parties only.
TranslationNamespaceIsNotLeafException 400 Provided translation namespace is not a translation leaf node.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
None ⎘
GET/translations/{rfc5646languageTag}/{namespace} ⎘Authentication required
Obtain the translations for given language.
Parameter Location Type Requirements Optional Default value Description
rfc5646languageTag URI-Path string
format: [A-Za-z0-9-]+
 No Language to retrieve, for example "en", "en-US" or "en-US-x-cw".
namespace URI-Path string
format: ((?:err|mail|mgmt|red|report|ui|wf)(?:\.[-_A-Za-z0-9]+)+)
 No Namespace to retrieve, for example "ui" or "ui.red".
fallbackStrategy URI-Query string
enum: [ "none", "inherit", "always" ]
 Yes "inherit" Fallback strategy in case of missing translations. "none": No fallback to other languages, returns null for missing data. "inherit": Fallback to fallback language only when language is defined as inherited language, return null otherwise (default). "always": Always fallback to fallback language until the primary language (en) is reached.
Response HTTP Type Description
Success 200 array Language data, either in nested form or as a flat map. Note that this is not always the entire language data, but may be an increment. Always perform a deep merge. This method reserves the right to provide full or incremental results.
TranslationLanguageNotFoundException 404 Provided language could not be found.
RestrictedLanguageException 403 This language is restricted to authorized parties only.
TranslationNamespaceNotFoundException 404 Provided translation namespace could not be found.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
None ⎘
GET/translations/{rfc5646languageTag}/{namespace}/translation ⎘Authentication required
Retrieves a single translation leaf. Should only be used for SSE events.
Parameter Location Type Requirements Optional Default value Description
rfc5646languageTag URI-Path string
format: [A-Za-z0-9-]+
 No Language to retrieve, for example "en", "en-US" or "en-US-x-cw".
namespace URI-Path string
format: ((?:err|mail|mgmt|red|report|ui|wf)(?:\.[-_A-Za-z0-9]+)+)
 No Translation namespace-leaf to retrieve.
fallbackStrategy URI-Query string
enum: [ "none", "inherit", "always" ]
 Yes "inherit" Fallback strategy in case of missing translations. "none": No fallback to other languages, returns null for missing data. "inherit": Fallback to fallback language only when language is defined as inherited language, return null otherwise (default). "always": Always fallback to fallback language until the primary language (en) is reached.
Response HTTP Type Description
Success 200 string|null Translation, or null if not found.
TranslationLanguageNotFoundException 404 Provided language could not be found.
RestrictedLanguageException 403 This language is restricted to authorized parties only.
TranslationNamespaceIsNotLeafException 400 Provided translation namespace is not a translation leaf node.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
None ⎘
POST/translations/dismiss/{nsPath} ⎘Authentication required
Mark the missing namespace as no longer missing
Parameter Location Type Requirements Optional Default value Description
nsPath URI-Path string No The translation namespace that was missing
Response HTTP Type Description
Success 200 int Amount of NamespaceNotFound records dismissed.
ModelNotFoundException 404 Instance of this model with provided ID could not be found.
RestrictedLanguageException 403 This language is restricted to authorized parties only.
InvalidTranslationNamespacePathException 400 Namespace path is invalid, see details for reason.
TranslationLanguageNotFoundException 404 Provided language could not be found.
TranslationNamespaceHasTranslationsException 200 Provided translation namespace can not hold child-namespaces because it already holds translations.
TranslationNamespaceHasChildNamespacesException 200 Provided translation namespace can not hold translations because it already holds child namespaces.
TranslationNamespaceNotFoundException 404 Provided translation namespace could not be found.
SubstitutedTranslationNotFoundException 200 Translation entry contains a referenced translation entry to inherit and substitute, that could not be found.
UnutilizedTranslationParameterException 200 Translation entry contains parameters, but given translation does not utilize all of them.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
('pres:review' OR 'kate:migration') ⎘
POST/translations/{rfc5646languageTag}/missing ⎘Authentication required
Obtain a specific set of translation leafs for given language. Note that these must be actual translation nodes, and cannot contain child namespaces. Does the same thing as the corresponding GET Endpoint but allows for asking for more translations at the same time.
Parameter Location Type Requirements Optional Default value Description
rfc5646languageTag URI-Path string
format: [A-Za-z0-9-]+
 No Language to retrieve, for example "en", "en-US" or "en-US-x-cw".
namespaces POST-body string[]
format: ((?:err|mail|mgmt|red|report|ui|wf)(?:\.[-_A-Za-z0-9]+)+)
 No Array of translation namespace-leafs to retrieve.
fallbackStrategy POST-body string
enum: [ "none", "inherit", "always" ]
 Yes "inherit" Fallback strategy in case of missing translations. "none": No fallback to other languages, returns null for missing data. "inherit": Fallback to fallback language only when language is defined as inherited language, return null otherwise (default). "always": Always fallback to fallback language until the primary language (en) is reached.
Response HTTP Type Description
Success 200 { [key: string]: string|null } Key-value map, with keys corresponding to the requested namespaces, and values either their translation string or null if not found.
TranslationLanguageNotFoundException 404 Provided language could not be found.
RestrictedLanguageException 403 This language is restricted to authorized parties only.
TranslationNamespaceIsNotLeafException 400 Provided translation namespace is not a translation leaf node.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
None ⎘
Translation Language API
GET/translations/languages ⎘Authentication required
Returns all defined translation languages, without inheritance.
Response HTTP Type Description
Success 200 TranslationLanguage[] Array of languages
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
('pres:propose' OR 'pres:review' OR 'kate:admin') ⎘
GET/translations/languages/{rfc5646languageTag} ⎘Authentication required
Returns a defined language including its inheritance.
Parameter Location Type Requirements Optional Default value Description
rfc5646languageTag URI-Path string
pattern: [A-Za-z0-9-]+
 No Language to retrieve, for example "en", "en-US" or "en-US-x-cw".
Response HTTP Type Description
Success 200 TranslationLanguage Returns TranslationLanguage entity.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
None ⎘
POST/translations/languages/{rfc5646languageTag}/createOrUpdate ⎘Authentication required
Returns all defined translation languages, without inheritance.
Parameter Location Type Requirements Optional Default value Description
rfc5646languageTag URI-Path string
pattern: [A-Za-z0-9-]+
 No Language-tag to create or update. If existing, it will be updated, created otherwise.
fallbackRFC5646languageTag POST-body string
pattern: [A-Za-z0-9-]+
 No Language-tag of an existing language to fallback to for missing translations.
isInherited POST-body bool No If this language is inherited, missing translations will not be considered missing, but fallback on the fallback-language without logged warnings.
customerRestrictionRegex POST-body string Yes "" If specified, this language is only available to idCustomer's that match this regex. For example: "/^(kate|envalue)\-nl$/"
Response HTTP Type Description
Success 200 Translation Language Created/Updated Translation Language entity
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
('kate:nick' OR 'kate:niels' OR 'kate:migration') ⎘
Translation Management API
POST/mgmt/translations/clearCache ⎘Authentication required
Invalidates the caches involving the namespace, which will be rebuilt next time they are retrieved. Note that this is purely a management API, and should not be used in application code (i.e. not to be invoked by Nova/Luna): caches should already be cleared on appropriate moments, i.e. when calling publishUpdate.
Parameter Location Type Requirements Optional Default value Description
namespace POST-body string
format: ((?:err|mail|mgmt|red|report|ui|wf)(?:\.[-_A-Za-z0-9]+)+)
 Yes null Optional. Affected namespace; i.e. the one to be cleared, for example "ui" or "ui.redEdit". If left empty, all namespaces are cleared. Must be provided if a language tag is provided.
rfc5646languageTag POST-body string
format: [A-Za-z0-9-]+
 Yes null Affected language; i.e. the one to be cleared, for example "en", "en-US" or "en-US-x-cw". If left empty, all languages for given namespace will be cleared. If provided, also requires namespace to be provided.
Response HTTP Type Description
Success 200 bool Returns true on success
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
('pres:review' OR 'kate:devops' OR 'kate:admin') ⎘
POST/mgmt/translations/clearPluginCaches ⎘Authentication required
Invalidates the caches of the Translation plugin on all services that utilize it.
Parameter Location Type Requirements Optional Default value Description
rootNamespace POST-body string
format: ((?:err|mail|mgmt|red|report|ui|wf)(?:\.[-_A-Za-z0-9]+)+)
 Yes null Optional. Affected namespace; i.e. the one to be cleared, for example "ui" or "ui.redEdit". If left empty, all namespaces are cleared. Must be provided if a language tag is provided.
rfc5646languageTag POST-body string
format: [A-Za-z0-9-]+
 Yes null Affected language; i.e. the one to be cleared, for example "en", "en-US" or "en-US-x-cw". If left empty, all languages for given namespace will be cleared. If provided, also requires namespace to be provided.
Response HTTP Type Description
Success 200 bool Returns true on success
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
kate:devops ⎘
POST/translations/publishUpdate/{namespace} ⎘Authentication required
Clears the caches involving the namespace, and publishes a SSE for updating translations.
Parameter Location Type Requirements Optional Default value Description
namespace URI-Path string
format: ((?:err|mail|mgmt|red|report|ui|wf)(?:\.[-_A-Za-z0-9]+)+)
 No Namespace that got updated, for example "ui" or "ui.redEdit".
Response HTTP Type Description
Success 200 bool Returns true on success
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
('pres:review' OR 'kate:devops' OR 'kate:admin' OR 'kate:migration') ⎘
Translation Namespace API
GET/translations/namespaces/roots ⎘
Returns the array of root namespaces
Response HTTP Type Description
Success 200 string[] Array of root namespaces
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
No
GET/translations/namespaces/{namespace} ⎘
Retrieves a Translation Namespace by its namespace string.
Parameter Location Type Requirements Optional Default value Description
namespace URI-Path string
format: ((?:err|mail|mgmt|red|report|ui|wf)(?:\.[-_A-Za-z0-9]+)+)
 No Namespace to retrieve, for example "ui" or "ui.redEdit".
format URI-Query string
enum: [ "associative", "tree", "list", "leaf-list" ]
 Yes "list" Format to present namespace as. Associative returns the default associative-entry format. Tree returns a pure structure tree with leaf-nodes the namespace-strings. List returns a KV-map, with keys model IDs, and values namespacePaths. Leaf-List returns like list, but only leaf translation nodes.
Response HTTP Type Description
Success 200 array Either returns the Translation Namespace as associative entry, or as tree if specified.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
No
Translation Proposal API
GET/translations/proposals ⎘Authentication required
Retrieves translation proposals.
Response HTTP Type Description
Success 200 TranslationProposal[] List of TranslationProposals
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
('pres:propose' OR 'pres:review') ⎘
GET/translations/sync ⎘Authentication required
Syncs the translations based on the docs
Parameter Location Type Requirements Optional Default value Description
rfc5646languageTag URI-Query string
format: [A-Za-z0-9-]+
 No Language to retrieve, for example "en", "en-US" or "en-US-x-cw".
rootNamespace URI-Query string
enum: [ "ui", "mail", "err", "red", "wf", "mgmt" ]
 No Root Namespace to sync e.g. "ui" "red". If not provided, clears the root namespace for all translations.
skipDelete URI-Query bool Yes true If set to false, delete the translations that are not part of the source file, this can only be done on "en".
dryRun URI-Query bool Yes true Show the changes that it will do, but do not perform the changes
Response HTTP Type Description
Success 200 {"added": string[],"updated": string[],"deleted": string[], "skipped": string[] }[] List of TranslationProposals
TranslationLanguageNotFoundException 404 Provided language could not be found.
RestrictedLanguageException 403 This language is restricted to authorized parties only.
TranslationNamespaceNotFoundException 404 Provided translation namespace could not be found.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
('pres:propose' OR 'pres:review') ⎘
POST/translations/proposals/propose/move/{nsPath} ⎘Authentication required
Propose moving a namespace to a new parent namespace.
Parameter Location Type Requirements Optional Default value Description
nsPath URI-Path string
pattern: ((?:err|mail|mgmt|red|report|ui|wf)(?:\.[-_A-Za-z0-9]+)+)
 No Namespace path to node to move, for example "ui.red".
newNsPath POST-body string
pattern: ((?:err|mail|mgmt|red|report|ui|wf)(?:\.[-_A-Za-z0-9]+)+)
 No Proposed new namespace path. Final part must remain intact; leading parent node must exist.
Response HTTP Type Description
Success 200 TranslationProposal TranslationProposal entity if the proposal passed a dry-run, error otherwise.
InvalidTranslationNamespacePathException 400 Namespace path is invalid, see details for reason.
TranslationNamespaceHasTranslationsException 200 Provided translation namespace can not hold child-namespaces because it already holds translations.
TranslationNamespaceNotFoundException 404 Provided translation namespace could not be found.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
('pres:propose' OR 'kate:migration') ⎘
POST/translations/proposals/propose/namespace/{nsPath} ⎘Authentication required
Propose a new namespace to be created.
Parameter Location Type Requirements Optional Default value Description
nsPath URI-Path string
pattern: ((?:err|mail|mgmt|red|report|ui|wf)(?:\.[-_A-Za-z0-9]+)+)
 No Namespace path to create, for example "ui.red".
Response HTTP Type Description
Success 200 TranslationProposal TranslationProposal entity if the proposal passed a dry-run, error otherwise.
InvalidTranslationNamespacePathException 400 Namespace path is invalid, see details for reason.
TranslationNamespaceHasTranslationsException 200 Provided translation namespace can not hold child-namespaces because it already holds translations.
TranslationNamespaceNotFoundException 404 Provided translation namespace could not be found.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
('pres:propose' OR 'kate:migration') ⎘
POST/translations/proposals/propose/rename/{nsPath} ⎘Authentication required
Propose a rename of a namespace/translation node.
Parameter Location Type Requirements Optional Default value Description
nsPath URI-Path string
pattern: ((?:err|mail|mgmt|red|report|ui|wf)(?:\.[-_A-Za-z0-9]+)+)
 No Namespace path to node to rename, for example "ui.red".
newName POST-body string No Proposed new name of the node.
Response HTTP Type Description
Success 200 TranslationProposal TranslationProposal entity if the proposal passed a dry-run, error otherwise.
InvalidTranslationNamespacePathException 400 Namespace path is invalid, see details for reason.
TranslationNamespaceNotFoundException 404 Provided translation namespace could not be found.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
('pres:propose' OR 'kate:migration') ⎘
POST/translations/proposals/propose/translation/redCategory/{idCategory} ⎘Authentication required
Propose a new Category-label translation node to be created, with optionally predefined translations.
Parameter Location Type Requirements Optional Default value Description
idCategory URI-Path int No Category ID to create label translation(s) for
parameters POST-body string[] Yes [] Parameters that occur in this translation node.
translations POST-body string
format: json
 Yes [] KV-map of translations; with keys representing defined RFC5646 language-tags, and values their corresponding initial translations
Response HTTP Type Description
Success 200 TranslationProposal TranslationProposal entity if the proposal passed a dry-run, error otherwise.
RestrictedLanguageException 403 This language is restricted to authorized parties only.
InvalidTranslationNamespacePathException 400 Namespace path is invalid, see details for reason.
TranslationLanguageNotFoundException 404 Provided language could not be found.
TranslationNamespaceHasTranslationsException 200 Provided translation namespace can not hold child-namespaces because it already holds translations.
TranslationNamespaceHasChildNamespacesException 200 Provided translation namespace can not hold translations because it already holds child namespaces.
TranslationNamespaceNotFoundException 404 Provided translation namespace could not be found.
SubstitutedTranslationNotFoundException 200 Translation entry contains a referenced translation entry to inherit and substitute, that could not be found.
UnutilizedTranslationParameterException 200 Translation entry contains parameters, but given translation does not utilize all of them.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
('pres:propose' OR 'kate:migration') ⎘
POST/translations/proposals/propose/translation/redPoint/{redPath}/label ⎘Authentication required
Propose a new REDPoint-label translation node to be created, with optionally predefined translations.
Parameter Location Type Requirements Optional Default value Description
redPath URI-Path string
pattern: [A-Za-z-_\.\[\]0-9]{1,}
 No REDPath of the REDPoint to create translation node for
parameters POST-body string[] Yes [] Parameters that occur in this translation node.
translations POST-body string
format: json
 Yes [] KV-map of translations; with keys representing defined RFC5646 language-tags, and values their corresponding initial translations
Response HTTP Type Description
Success 200 TranslationProposal TranslationProposal entity if the proposal passed a dry-run, error otherwise.
RestrictedLanguageException 403 This language is restricted to authorized parties only.
InvalidTranslationNamespacePathException 400 Namespace path is invalid, see details for reason.
TranslationLanguageNotFoundException 404 Provided language could not be found.
TranslationNamespaceHasTranslationsException 200 Provided translation namespace can not hold child-namespaces because it already holds translations.
TranslationNamespaceHasChildNamespacesException 200 Provided translation namespace can not hold translations because it already holds child namespaces.
TranslationNamespaceNotFoundException 404 Provided translation namespace could not be found.
SubstitutedTranslationNotFoundException 200 Translation entry contains a referenced translation entry to inherit and substitute, that could not be found.
UnutilizedTranslationParameterException 200 Translation entry contains parameters, but given translation does not utilize all of them.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
('pres:propose' OR 'kate:migration') ⎘
POST/translations/proposals/propose/translation/redPoint/{redPath}/valueSelect/{valueKey} ⎘Authentication required
Propose a new ValueSelect value-label translation node to be created, with optionally predefined translations.
Parameter Location Type Requirements Optional Default value Description
redPath URI-Path string
pattern: ^[A-Za-z-_\.\[\]0-9]{1,}
 No REDPath of the REDPoint to create translation node for
valueKey URI-Path string
pattern: ^[^.\/]+$
 No Key of the value on the ValueSelect
parameters POST-body string[] Yes [] Parameters that occur in this translation node.
translations POST-body string
format: json
 Yes [] KV-map of translations; with keys representing defined RFC5646 language-tags, and values their corresponding initial translations
Response HTTP Type Description
Success 200 TranslationProposal TranslationProposal entity if the proposal passed a dry-run, error otherwise.
RestrictedLanguageException 403 This language is restricted to authorized parties only.
InvalidTranslationNamespacePathException 400 Namespace path is invalid, see details for reason.
TranslationLanguageNotFoundException 404 Provided language could not be found.
TranslationNamespaceHasTranslationsException 200 Provided translation namespace can not hold child-namespaces because it already holds translations.
TranslationNamespaceHasChildNamespacesException 200 Provided translation namespace can not hold translations because it already holds child namespaces.
TranslationNamespaceNotFoundException 404 Provided translation namespace could not be found.
SubstitutedTranslationNotFoundException 200 Translation entry contains a referenced translation entry to inherit and substitute, that could not be found.
UnutilizedTranslationParameterException 200 Translation entry contains parameters, but given translation does not utilize all of them.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
('pres:propose' OR 'kate:migration') ⎘
POST/translations/proposals/propose/translation/{nsPath} ⎘Authentication required
Propose a new translation node to be created, with optionally predefined translations.
Parameter Location Type Requirements Optional Default value Description
nsPath URI-Path string
pattern: ((?:err|mail|mgmt|red|report|ui|wf)(?:\.[-_A-Za-z0-9]+)+)
 No Namespace path to create translation node on, for example "ui.red".
parameters POST-body string[] Yes [] Parameters that occur in this translation node.
translations POST-body string
format: json
 Yes [] KV-map of translations; with keys representing defined RFC5646 language-tags, and values their corresponding initial translations
Response HTTP Type Description
Success 200 TranslationProposal TranslationProposal entity if the proposal passed a dry-run, error otherwise.
RestrictedLanguageException 403 This language is restricted to authorized parties only.
InvalidTranslationNamespacePathException 400 Namespace path is invalid, see details for reason.
TranslationLanguageNotFoundException 404 Provided language could not be found.
TranslationNamespaceHasTranslationsException 200 Provided translation namespace can not hold child-namespaces because it already holds translations.
TranslationNamespaceHasChildNamespacesException 200 Provided translation namespace can not hold translations because it already holds child namespaces.
TranslationNamespaceNotFoundException 404 Provided translation namespace could not be found.
SubstitutedTranslationNotFoundException 200 Translation entry contains a referenced translation entry to inherit and substitute, that could not be found.
UnutilizedTranslationParameterException 200 Translation entry contains parameters, but given translation does not utilize all of them.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
('pres:propose' OR 'kate:migration') ⎘
POST/translations/proposals/propose/updateTranslation/{nsPath} ⎘Authentication required
Propose updates of translations on a translation node, or add new translations to an existing translation node.
Parameter Location Type Requirements Optional Default value Description
nsPath URI-Path string
pattern: ((?:err|mail|mgmt|red|report|ui|wf)(?:\.[-_A-Za-z0-9]+)+)
 No Namespace path to update translation node of, for example "ui.red".
translations POST-body string
format: json
 No KV-map of translations; with keys representing defined RFC5646 language-tags, and values their corresponding translations. Only specified languages are updated.
Response HTTP Type Description
Success 200 TranslationProposal TranslationProposal entity if the proposal passed a dry-run, error otherwise.
ModelNotFoundException 404 Instance of this model with provided ID could not be found.
RestrictedLanguageException 403 This language is restricted to authorized parties only.
InvalidTranslationNamespacePathException 400 Namespace path is invalid, see details for reason.
TranslationLanguageNotFoundException 404 Provided language could not be found.
TranslationNamespaceHasTranslationsException 200 Provided translation namespace can not hold child-namespaces because it already holds translations.
TranslationNamespaceHasChildNamespacesException 200 Provided translation namespace can not hold translations because it already holds child namespaces.
TranslationNamespaceNotFoundException 404 Provided translation namespace could not be found.
SubstitutedTranslationNotFoundException 200 Translation entry contains a referenced translation entry to inherit and substitute, that could not be found.
UnutilizedTranslationParameterException 200 Translation entry contains parameters, but given translation does not utilize all of them.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
('pres:propose' OR 'kate:migration') ⎘
POST/translations/proposals/{idProposal}/accept ⎘Authentication required
Accept and process a translation proposal.
Parameter Location Type Requirements Optional Default value Description
idProposal URI-Path int No ID of the TranslationProposal.
dryRun POST-body bool Yes false If set to true, only tests whether it can validly be applied without performing any actions.
Response HTTP Type Description
Success 200 TranslationProposal TranslationProposal
ModelNotFoundException 404 Instance of this model with provided ID could not be found.
RestrictedLanguageException 403 This language is restricted to authorized parties only.
InvalidTranslationNamespacePathException 400 Namespace path is invalid, see details for reason.
TranslationLanguageNotFoundException 404 Provided language could not be found.
TranslationNamespaceHasTranslationsException 200 Provided translation namespace can not hold child-namespaces because it already holds translations.
TranslationNamespaceHasChildNamespacesException 200 Provided translation namespace can not hold translations because it already holds child namespaces.
TranslationNamespaceNotFoundException 404 Provided translation namespace could not be found.
SubstitutedTranslationNotFoundException 200 Translation entry contains a referenced translation entry to inherit and substitute, that could not be found.
UnutilizedTranslationParameterException 200 Translation entry contains parameters, but given translation does not utilize all of them.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
('pres:review' OR 'kate:migration') ⎘
POST/translations/proposals/{idProposal}/reject ⎘Authentication required
Reject a translation proposal.
Parameter Location Type Requirements Optional Default value Description
idProposal URI-Path int No ID of the TranslationProposal.
reason POST-body string Yes null Optional rejection reason.
Response HTTP Type Description
Success 200 TranslationProposal TranslationProposal
ModelNotFoundException 404 Instance of this model with provided ID could not be found.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
pres:review ⎘
POST/translations/proposals/{idProposal}/update/move ⎘Authentication required
Update a move namespace proposal with new parameters.
Parameter Location Type Requirements Optional Default value Description
idProposal URI-Path int No ID of the TranslationProposal.
nsPath POST-body string
pattern: ((?:err|mail|mgmt|red|report|ui|wf)(?:\.[-_A-Za-z0-9]+)+)
 Yes null Namespace path to node to move, for example "ui.red".
newNsPath POST-body string
pattern: ((?:err|mail|mgmt|red|report|ui|wf)(?:\.[-_A-Za-z0-9]+)+)
 Yes null Proposed new namespace path. Final part must remain intact; leading parent node must exist.
Response HTTP Type Description
Success 200 TranslationProposal TranslationProposal entity if the proposal passed a dry-run, error otherwise.
ModelNotFoundException 404 Instance of this model with provided ID could not be found.
InvalidTranslationNamespacePathException 400 Namespace path is invalid, see details for reason.
TranslationNamespaceHasTranslationsException 200 Provided translation namespace can not hold child-namespaces because it already holds translations.
TranslationNamespaceNotFoundException 404 Provided translation namespace could not be found.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
('pres:propose' OR 'kate:migration') ⎘
POST/translations/proposals/{idProposal}/update/newTranslation ⎘Authentication required
Update a new translation proposal with new parameters.
Parameter Location Type Requirements Optional Default value Description
idProposal URI-Path int No ID of the TranslationProposal.
nsPath POST-body string
pattern: ((?:err|mail|mgmt|red|report|ui|wf)(?:\.[-_A-Za-z0-9]+)+)
 Yes null Namespace path to create translation node on, for example "ui.red".
parameters POST-body string[] Yes null Parameters that occur in this translation node.
translations POST-body string
format: json
 Yes null KV-map of translations; with keys representing defined RFC5646 language-tags, and values their corresponding initial translations
Response HTTP Type Description
Success 200 TranslationProposal TranslationProposal entity if the proposal passed a dry-run, error otherwise.
ModelNotFoundException 404 Instance of this model with provided ID could not be found.
RestrictedLanguageException 403 This language is restricted to authorized parties only.
InvalidTranslationNamespacePathException 400 Namespace path is invalid, see details for reason.
TranslationLanguageNotFoundException 404 Provided language could not be found.
TranslationNamespaceHasTranslationsException 200 Provided translation namespace can not hold child-namespaces because it already holds translations.
TranslationNamespaceHasChildNamespacesException 200 Provided translation namespace can not hold translations because it already holds child namespaces.
TranslationNamespaceNotFoundException 404 Provided translation namespace could not be found.
SubstitutedTranslationNotFoundException 200 Translation entry contains a referenced translation entry to inherit and substitute, that could not be found.
UnutilizedTranslationParameterException 200 Translation entry contains parameters, but given translation does not utilize all of them.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
('pres:propose' OR 'kate:migration') ⎘
POST/translations/proposals/{idProposal}/update/rename ⎘Authentication required
Update a rename proposal with new parameters.
Parameter Location Type Requirements Optional Default value Description
idProposal URI-Path int No ID of the TranslationProposal.
nsPath POST-body string
pattern: ((?:err|mail|mgmt|red|report|ui|wf)(?:\.[-_A-Za-z0-9]+)+)
 Yes null Namespace path to node to rename, for example "ui.red".
newName POST-body string Yes null Proposed new name of the node.
Response HTTP Type Description
Success 200 TranslationProposal TranslationProposal entity if the proposal passed a dry-run, error otherwise.
ModelNotFoundException 404 Instance of this model with provided ID could not be found.
InvalidTranslationNamespacePathException 400 Namespace path is invalid, see details for reason.
TranslationNamespaceNotFoundException 404 Provided translation namespace could not be found.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
('pres:propose' OR 'kate:migration') ⎘
POST/translations/proposals/{idProposal}/update/updateTranslation ⎘Authentication required
Update a update translation proposal with new parameters.
Parameter Location Type Requirements Optional Default value Description
idProposal URI-Path int No ID of the TranslationProposal.
nsPath POST-body string
pattern: ((?:err|mail|mgmt|red|report|ui|wf)(?:\.[-_A-Za-z0-9]+)+)
 Yes null Namespace path to update translation node of, for example "ui.red".
translations POST-body string
format: json
 Yes null KV-map of translations; with keys representing defined RFC5646 language-tags, and values their corresponding translations. Only specified languages are updated.
Response HTTP Type Description
Success 200 TranslationProposal TranslationProposal entity if the proposal passed a dry-run, error otherwise.
ModelNotFoundException 404 Instance of this model with provided ID could not be found.
RestrictedLanguageException 403 This language is restricted to authorized parties only.
InvalidTranslationNamespacePathException 400 Namespace path is invalid, see details for reason.
TranslationLanguageNotFoundException 404 Provided language could not be found.
TranslationNamespaceHasTranslationsException 200 Provided translation namespace can not hold child-namespaces because it already holds translations.
TranslationNamespaceHasChildNamespacesException 200 Provided translation namespace can not hold translations because it already holds child namespaces.
TranslationNamespaceNotFoundException 404 Provided translation namespace could not be found.
SubstitutedTranslationNotFoundException 200 Translation entry contains a referenced translation entry to inherit and substitute, that could not be found.
UnutilizedTranslationParameterException 200 Translation entry contains parameters, but given translation does not utilize all of them.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
('pres:propose' OR 'kate:migration') ⎘
Authentication schemes (Click an authentication scheme to expand it)
JWTAuth
Result wrappers (Click a result-wrapper to expand it)
Success
Error