Object Metadata Translation
You can retrieve translated metadata by using the language parameter, as follows:
https://<server>/<instance>/metadata?io_id=object_full_identifier&language=<ISO-639-1 language code>
Input Example
Following is an example GET request to retrieve Showcase object metadata translated to Spanish:
GET https://<host>/<instance>/metadata?io_id=io_showcase&language=es
Response Examples
The response is a JSON map, similar to the response for nontranslated metadata, with the following differences:
• Name and Plural Name values for objects are retrieved translated to the specified language.
• Name values for each field in an object are retrieved translated to the specified language.
• Fields with the Option List data type are retrieved with the Name values of associated options translated to the specified language.
• Fields with the Status data type are retrieved with the Name values of associated status options translated to the specified language.
 |
This information is included only when language is specified.
|
• Views associated with an object are retrieved with Name values translated to the specified language.
|
|
This information is included only when language is specified.
|
Translated Object Metadata
Following is an example of JSON metadata retrieved for the Showcase object and translated to Spanish. Only the information that changes when the language parameter is specified is shown.
{
"accessControl": true,
"name": "Presentaci�n", <-- Object name translated
"pluralName": "Presentaciones", <-- Object plural name translated
"physicalDelete": false,
"active": true,
"immutableRecords": false,
"uuid": "294ae5eb-952b-467e-a2fc-d27751221d2a",
...
"fields": ...
...
"views": { <-- Object's views (only included when language parameter is specified)
"c36fabdb-98dd-4b09-b030-df28d922e9d5": {
"identifier": "view_alldatatypes",
"name": "Todos los showcase" <-- View's name translated
}
}
}
"accessControl": true,
"name": "Presentaci�n", <-- Object name translated
"pluralName": "Presentaciones", <-- Object plural name translated
"physicalDelete": false,
"active": true,
"immutableRecords": false,
"uuid": "294ae5eb-952b-467e-a2fc-d27751221d2a",
...
"fields": ...
...
"views": { <-- Object's views (only included when language parameter is specified)
"c36fabdb-98dd-4b09-b030-df28d922e9d5": {
"identifier": "view_alldatatypes",
"name": "Todos los showcase" <-- View's name translated
}
}
}
Field Metadata With Translated Field Names
"io_created_by": {
"fullIdentifier": "io_created_by",
"name": "Creado por", <-- Field name translated
"immutable": false,
"orderingPosition": "18",
...
}
"fullIdentifier": "io_created_by",
"name": "Creado por", <-- Field name translated
"immutable": false,
"orderingPosition": "18",
...
}
Option List Field With Translated Field and Option Names
"io_showcase_option_list": { <-- Option list field
"fullIdentifier": "io_showcase_option_list",
"name": "Lista de opciones de presentaci�n", <-- Field name translated
"immutable": false,
...
"options": [
{
"fullIdentifier": "option_one",
"name": "Opci�n 1", <-- Option name translated
"uuid": "ad9bebb4-271c-4eb4-9706-8e6b91bece5f"
},
{
"fullIdentifier": "option_two",
"name": "Opci�n 2", <-- Option name translated
"uuid": "7234a426-1456-41d4-a0fb-63475e85e83e"
},
{
"fullIdentifier": "option_three",
"name": "Opci�n 3", <-- Option name translated
"uuid": "388136f7-7aad-46d3-b948-ea8ec3cf31f8"
}
],
....
}
"fullIdentifier": "io_showcase_option_list",
"name": "Lista de opciones de presentaci�n", <-- Field name translated
"immutable": false,
...
"options": [
{
"fullIdentifier": "option_one",
"name": "Opci�n 1", <-- Option name translated
"uuid": "ad9bebb4-271c-4eb4-9706-8e6b91bece5f"
},
{
"fullIdentifier": "option_two",
"name": "Opci�n 2", <-- Option name translated
"uuid": "7234a426-1456-41d4-a0fb-63475e85e83e"
},
{
"fullIdentifier": "option_three",
"name": "Opci�n 3", <-- Option name translated
"uuid": "388136f7-7aad-46d3-b948-ea8ec3cf31f8"
}
],
....
}
Status Field With Translated Field and Status Names
|
|
This information is included only when language is specified.
|
"io_status": { <-- Status field
"fullIdentifier": "io_status",
"name": "Estado" <-- Field name translated
"immutable": false,
...
"status_list": [
{
"name": <-- Status name translated
"uuid": "3d152387-4196-4a46-966d-7a280510041d"
},
{
"name": "Anot <-- Status name translated
"uuid": "a13cbe0a-d469-4e8d-a0fb-8c5aff6fc9c3"
},
{
"name": "Canc <-- Status name translated
"uuid": "f9e333c9-af40-43db-af93-2824b9d9abf9"
},
{
"name": "Comp <-- Status name translated
"uuid": "5dc5afa0-584b-4afa-ab3b-6d84cc5fecc0"
}
],
...
}
"fullIdentifier": "io_status",
"name": "Estado" <-- Field name translated
"immutable": false,
...
"status_list": [
{
"name": <-- Status name translated
"uuid": "3d152387-4196-4a46-966d-7a280510041d"
},
{
"name": "Anot <-- Status name translated
"uuid": "a13cbe0a-d469-4e8d-a0fb-8c5aff6fc9c3"
},
{
"name": "Canc <-- Status name translated
"uuid": "f9e333c9-af40-43db-af93-2824b9d9abf9"
},
{
"name": "Comp <-- Status name translated
"uuid": "5dc5afa0-584b-4afa-ab3b-6d84cc5fecc0"
}
],
...
}
For details on how to retrieve all the available currencies and units on the Max platform, see Retrieve Currencies and Units Via HTTP.