PingOne Platform APIs

Language Translations

The translations endpoint supplies operations to view the custom string translations for a specified language, and to update localized strings for UI elements in the specified language.

The response for a GET request returns the embedded resources that supply UI strings in English, and the associated localized string content in the specified language. Here’s a sample of a localized string (in French) for the Cancel button in the flow-ui module used in a UI page:

    "_embedded": {
        "translations": [
            {
                "id": "3e90224d-9036-4d78-badb-65e98f4fc944",
                "key": "flow-ui.button.cancel",
                "shortKey": "button.cancel",
                "referenceText": "Cancel",
                "translatedText": "Annuler"
            },

PingOne support UI string translations for the following languages:

Locale Language

de

German

en

English

es

Spanish

fr

French

fr-CA

French (Canadian)

it

Italian

ja

Japanese

ko

Korean

nl

Dutch

pt

Portuguese

ru

Russian

th

Thai

tr

Turkish

zh

Chinese

cs

Czech

Languages translation request data model

For PUT requests, the following properties are required in the request body.

Property Type Required? Mutable? Description

key

String

Required

Mutable

A string that specifies the page and name of the interface element to be localized (for example, flow-ui.button.cancel).

translatedText

String

Required

Mutable

A string that specifies the translated string text associated with the interface element.

PUT operations do not return data in the response. A successful update request returns a 200 OK status.

Languages translation response data model

For GET requests, the data model returns the following information about the specified language’s localized strings.

Property Type Description

translations.id

String

The translation ID for a specific string.

translations.key

String

The page and name of the interface element to be localized (for example, flow-ui.button.cancel).

translations.shortKey

String

The interace element only (for example, button.cancel).

translations.referenceText

String

The English string text associated with the interface element.

translations.translatedText

String

The translated string text associated with the interface element.

Response codes

Code Message

200

Successful operation.

400

The request could not be completed.

401

You do not have access to this resource.

403

You do not have permissions or are not licensed to make this request.

404

The requested resource was not found.