Translations REST API
To retrieve translations by using HTTP, you use the following API.
|
Method
|
GET
|
|
URL
|
/<instance>/translations
|
|
Parameters
|
language, keys, application, object, origin
|
|
Response Content Type
|
application/json
|
Response Examples
The following example Status Code 200 response is a JSON code block that represents the map of translations, including map and translation keys and the map value of the translated message:
{
"Showcase Content: Attachments": "Showcase Content: Attachments",
"Object and Field": "Object and Field",
"Owner": "Owner",
"Platform Changes Permitted": "Platform Changes Permitted",
"Record ID": "Record ID",
"Showcase Timestamp": "Showcase Timestamp",
"Page Document": "Page Document",
"Showcase Currency Amount": "Showcase Currency Amount",
.
.
}
"Showcase Content: Attachments": "Showcase Content: Attachments",
"Object and Field": "Object and Field",
"Owner": "Owner",
"Platform Changes Permitted": "Platform Changes Permitted",
"Record ID": "Record ID",
"Showcase Timestamp": "Showcase Timestamp",
"Page Document": "Page Document",
"Showcase Currency Amount": "Showcase Currency Amount",
.
.
}
For metadata translations, the Status Code 200 response format is a JSON Map, whose key is the object’s full identifier and whose value corresponds to a Map with the object record’s translations. The record map is another JSON Map, whose key is the record's UUID and whose value is another JSON Map that contains each translated field for the specified record.
{
"io_object": {
"8b283436-18f9-3cb7-a1f8-2d330fe154cf": {
"io_name": "User"
},
"bf35c30e-c6e5-11e0-be1e-001ec93afa2c": {
"io_name": "Account"
}
}
}
"io_object": {
"8b283436-18f9-3cb7-a1f8-2d330fe154cf": {
"io_name": "User"
},
"bf35c30e-c6e5-11e0-be1e-001ec93afa2c": {
"io_name": "Account"
}
}
}
Parameters
|
Parameter
|
Description
|
DataType
|
Example
|
||
|---|---|---|---|---|---|
|
language
|
Language code for which to retrieve translations. If not specified, the authenticated user’s language is used.
|
String
|
Retrieve all existing translations for Spanish:
/<instance>/translations?language=es
|
||
|
keys
|
Indicates the subset of translations to retrieve. If not specified, and object is not specified, all translations are retrieved. Keys that include commas must be enclosed in double quotes.
|
String
|
Retrieve the translated keys Dashboard Components, Report Name and User Management:
/<instance>/translations?keys=Dashboard Components,Report Name,User Management
Retrieve the translated key containing a comma Agriculture, Forestry and Fishing:
/<instance>/translations?keys="Agriculture, Forestry and Fishing"
|
||
|
application
|
Application scope of translations to retrieve. Specify the application full identifier or the application UUID. If not specified, and object is not specified, all translations for the application are retrieved.
|
String
|
Retrieve all existing translations for Max Designer:
/<instance>/translations?application=io_designer
or
/<instance>/translations?application=7a4979b5-ceb1-47a9-842b-7c761748fbc5
|
||
|
object
|
Object for which translated metadata is retrieved. Specify the object full identifier. If not specified, and keys is not specified, all translations are retrieved. Output format is the same as what is retrieved by the Object metadata service with translation. For example JSON output, see Object Metadata Translation.
|
String
|
Retrieve translated metadata for the Showcase object:
/<instance>/translations?object=io_showcase
|
||
|
origin
|
Origin (code or metadata) to use to filter translations to be retrieved.
|
String
|
Retrieve code translations for authenticated user’s language:
instance/translations?origin=code
Retrieve metadata translations for French:
instance/translations?origin=metadata&language=fr
|
Response Messages
|
HTTP Status Code
|
Error Message
|
|---|---|
|
200
|
OK
|
|
500
|
Internal Server Error / Serialization Error
|
Examples
Retrieve All Existing Translations in Max Designer That Use the Authenticated User’s Default Language
https://<server>/<instance>/translations?application=io_designer
Retrieve All Existing Spanish Translations
https://<server>/<instance>/translations?language=es
Retrieve Chinese Translations for Showcase String Localized and Text Localized Keys
https://<server>/<instance>/translations?language=zh&keys=Showcase String Localized,Text Localized
Retrieve Default Translations for Agriculture, Forestry and Fishing and Showcase Keys
https://<server>/<instance>/translations?keys="Agriculture, forestry and fishing",Showcase
Retrieve Chinese Translations for Showcase String Localized and Text Localized Keys in Max Designer
https://<server>/<instance>/translations?language=zh&application=io_designer&keys=Showcase String Localized,Text Localized
Retrieve French Metadata Translation for Showcase Object
https://<server>/<instance>/translations?language=fr&object=io_showcase
For more information: