Difference between revisions of "REST API:translationWorkbench Resource"
From AgileApps Support Wiki
imported>Aeric |
imported>Aeric |
||
| Line 11: | Line 11: | ||
;URI: | ;URI: | ||
:<tt><nowiki>https://{domain}/networking/rest/translationWorkBench/{type}/{category}.{token}</nowiki></tt> | :<tt><nowiki>https://{domain}/networking/rest/translationWorkBench/{type}/{category}.{token}</nowiki></tt> | ||
:<tt><nowiki>https://{domain}/networking/rest/translationWorkBench/{type}/{category}.{token}?args=param1,...</nowiki></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>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.}} | ||
Revision as of 00:11, 16 June 2011
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
- Method
- GET
- URI
- https://{domain}/networking/rest/translationWorkBench/{type}/{category}.{token}
- https://{domain}/networking/rest/translationWorkBench/{type}/{category}.{token}?args=param1,...
- 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
- <syntaxhighlight lang="xml" enclose="div">
<platform>
<__resourceName__>
<id>...</id>
<field>data</field>
...
</__resourceName__>
<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.