Difference between revisions of "REST API:translationWorkbench Resource"
From AgileApps Support Wiki
imported>Aeric |
imported>Aeric (→Fields) |
||
| Line 41: | Line 41: | ||
! Name!!Type!!Description | ! Name!!Type!!Description | ||
|- | |- | ||
| key || String || The ID of the translated element, in the form <tt>{category}.{token_id}. For example: <tt>validation.record_deleted</tt> | | key || String || The ID of the translated element, in the form <tt>{category}.{token_id}</tt>. For example: <tt>validation.record_deleted</tt> | ||
|- | |- | ||
| translatedText || String || The translation for the key, in the current user's language, with any arguments in the request interpolated into the string. | | translatedText || String || The translation for the key, in the current user's language, with any arguments in the request interpolated into the string. | ||
|} | |} | ||
<noinclude> | <noinclude> | ||
[[Category:REST API|translationWorkbench Resource]] | [[Category:REST API|translationWorkbench Resource]] | ||
</noinclude> | </noinclude> | ||
Revision as of 00:05, 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/__resourceName__/{recordId}
- Return all fields
- URI
- https://{domain}/networking/rest/__resourceName__/{recordId}?{query_parameters}
- Query Parameters
- Introductory sentence, if any
- parameter1 - Description
- parameter2
- If true, ...
- If false, ... (default)
- 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.