Difference between revisions of "REST API:translationWorkbench Resource"
From AgileApps Support Wiki
imported>Aeric (→Fields) |
imported>Aeric |
||
| (24 intermediate revisions by the same user not shown) | |||
| Line 6: | Line 6: | ||
:* Translations have been created in the [[Translation Workbench]] | :* Translations have been created in the [[Translation Workbench]] | ||
===Get a Translation=== | ===Get a Translation for a Custom Label=== | ||
;Method:GET | ;Method:GET | ||
;URI:<tt> | ;URI: | ||
:<tt>{{platformURL}}/rest/translationWorkBench/customlabel/{key}</tt> | |||
:<tt>{{platformURL}}/rest/translationWorkBench/customlabel/{key}?args=param1,...</tt> | |||
:where: | |||
::* '''{key}''' - The index value used to look up a translated string, in the form <tt>{category}.{token_id}</tt> | |||
{{Query Parameters| | {{Query Parameters| | ||
::*<tt>args</tt> - A list of one or more arguments that will be interpolated into the string at the locations assigned to them when the base string was created.}} | |||
::*<tt> | |||
;Response: | ;Response: | ||
:When the user's language is Spanish, this sample response comes in reply to the request: | |||
::<tt>{{platformURL}}/rest/translationWorkBench/customlabel/validation.record_deleted?args=5</tt> | |||
:<syntaxhighlight lang="xml" enclose="div"> | :<syntaxhighlight lang="xml" enclose="div"> | ||
<platform> | <platform> | ||
< | <translationWorkBench> | ||
< | <key>validation.record_deleted</key> | ||
< | <translatedText>5 registros eliminados con éxito</translatedText> | ||
</translationWorkBench> | |||
</ | |||
<message> | <message> | ||
Latest revision as of 21:47, 30 March 2012
Get translated strings using the REST API.
- Learn more: REST API Conventions and Considerations.
Requirements
- Translations have been created in the Translation Workbench
Get a Translation for a Custom Label
- Method
- GET
- URI
- https://{yourDomain}/networking/rest/translationWorkBench/customlabel/{key}
- https://{yourDomain}/networking/rest/translationWorkBench/customlabel/{key}?args=param1,...
- where:
- {key} - The index value used to look up a translated string, in the form {category}.{token_id}
- Query Parameters
- args - A list of one or more arguments that will be interpolated into the string at the locations assigned to them when the base string was created.
- For more information, see: Specifying Query Parameters in REST APIs
- Response
- When the user's language is Spanish, this sample response comes in reply to the request:
- https://{yourDomain}/networking/rest/translationWorkBench/customlabel/validation.record_deleted?args=5
- <syntaxhighlight lang="xml" enclose="div">
<platform>
<translationWorkBench>
<key>validation.record_deleted</key>
<translatedText>5 registros eliminados con éxito</translatedText>
</translationWorkBench>
<message>
0
<description>Success</description>
</message>
</platform> </syntaxhighlight>
- See also: REST API:Error Codes
Fields
Name Type Description key String The ID of the translated element, in the form {category}.{token_id}. For example: validation.record_deleted translatedText String The translation for the key, in the current user's language, with any arguments in the request interpolated into the string.