Search Translations

This endpoint is used to search translations on a client, the phrase property will do a partial match on the default culture phrase and filter translations by culture if provided. If start is included limit must also be provided.

Parameter Value
End Point https://api.fundpress.io/config/searchTranslations
Headers X-KSYS-TOKEN
Content Type application/json
HTTP Method POST

Request

{
    "phrase": "bond",
    "start": 0,
    "limit": 20,
    "cultures": ["en-GB", "it-IT"]
}
Parameter Required
phrase false
start false
limit false
cultures false

Response

{
    "start": 0,
    "total": 3,
    "values": [
        {
            "phrase": "Bond Quality Breakdown",
            "translations": [
                {
                    "translation": "Répartition de la qualité des obligations",
                    "translationCulture": "fr-FR"
                },
                {
                    "translation": "Ripartizione della qualità dell'obbligazione",
                    "translationCulture": "it-IT"
                },
                {
                    "translation": "Bond Aufteilung nach Rating",
                    "translationCulture": "de-DE"
                }
            ]
        },
        {
            "phrase": "Bonds",
            "translations": []
        },
        {
            "phrase": "Kurtosys Bond Fund",
            "translations": []
        }
    ]
}

Upsert Translation/s

Translations are used in the /searchEntity service to convert text into other languages. They can also be used to provde a dictionary of terms to be used in converting on screen labels. To add new translations, provide a message that converts the original phrase to the target phrase. It is important that the phrase is exact and that it targets a common culture set that is used across the client data set.

Service call details

Parameter Value
End Points https://api.fundpress.io/config/upsertTranslation
https://api.fundpress.io/config/upsertTranslations
Headers X-KSYS-TOKEN, X-KSYS-API
Content Type application/json
HTTP Method POST
Return Type JSON
Return Data The inserted record or OK

Request

for insert

{
    "culture": "en-GB",
    "phrase": "Test",
    "translation": "Tester",
    "translationCulture": "fr-FR"
}

or for an update

[
    {
        "culture": "en-GB",
        "phrase": "Test",
        "translation": "Tester",
        "translationCulture": "fr-FR"
    }
]
Property Required TYPE Description
culture TRUE STRING The culture of the translation phrase
phrase TRUE STRING The translation phrase to compare against
translation TRUE STRING The translation value that will be updated
translationCulture TRUE STRING The culture of the translation value that will be updated

Response

Results will look like:

for insert

{
    "clientId": 2,
    "created": "2019-03-13T09:15:16.000Z",
    "createdBy": 3,
    "culture": "en-GB",
    "lastModified": "2019-03-13T09:15:16.000Z",
    "lastModifiedBy": 3,
    "phrase": "Test",
    "rowHash": "3ddbd7aa91146d92eb82b34a2e782c682002d986bd2436e5166e66487588aff8",
    "translation": "Tester",
    "translationCulture": "fr-FR",
    "translationId": 3941
}

or for an update

"OK"

Delete Translation/s

This endpoint is used to delete a single or mulitple translations where the default translation phrase and target culture is provided.

Service call details

Parameter Value
End Points https://api.fundpress.io/config/deleteTranslations
Headers X-KSYS-TOKEN, X-KSYS-API
Content Type application/json
HTTP Method POST
Return Type JSON
Return Data OK

Request

[
    {
        "translationCultures": ["de-DE", "ja-JP"],
        "phrases": ["Manager"]
    },
    {
        "translationCultures": ["fr-FR"],
        "phrases": ["Fundlist", "Auditor"]
    },
    {
        "translationCultures": ["en-GB"],
        "phrases": ["Sector Funds"]
    }
]
Property Required TYPE Description
translationCultures TRUE STRING ARRAY The target culture
phrases TRUE STRING ARRAY The default phrase

Response

{ "message": "OK" }

List Translation Providers

Returns a list of translation providers

Service call details

Parameter Value
End Points https://api.fundpress.io/config/listTranslationProviders
Headers X-KSYS-TOKEN, X-KSYS-API
Content Type application/json
HTTP Method POST
Return Type JSON

Response

{
    "values": [
        {
            "translationProviderId": 0,
            "translationProviderConfigurationId": 0,
            "name": "Cloudwords",
            "enabled": true,
            "details": {
                "apiKeySecretId": "123456789",
                "dmxName": "{module_name}-{page_title}",
                "department": "Team A"
            }
        }
    ]
}

Upsert Translation Provider

Upserts a translation provider configuration

Service call details

Parameter Value
End Points https://api.fundpress.io/config/upsertTranslationProvider
Headers X-KSYS-TOKEN, X-KSYS-API
Content Type application/json
HTTP Method POST
Return Type JSON
Return Data OK

Request

{
    "translationProviderId": 0,
    "translationProviderConfigurationId": 0,
    "name": "Cloudwords",
    "clientId": 2,
    "enabled": true,
    "details": {
        "apiKeySecret": "the-cloudwords-api-key",
        "dmxName": "{module_name}-{page_title}",
        "department": "Team A"
    }
}

Response

{
    "message": "OK"
}