REST API:translationWorkbench Resource

REST API:translationWorkbench Resource

From LongJump Support Wiki

REST API:translationWorkbench Resource
Jump to: navigation, search

Get translated strings using the REST API.

Learn more: REST API Conventions and Considerations.

Requirements

Get a Translation for a Custom Label

Method
GET
URI
https://na.longjump.com/networking/rest/translationWorkBench/customlabel/{key}
https://na.longjump.com/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://na.longjump.com/networking/rest/translationWorkBench/customlabel/validation.record_deleted?args=5
<platform>
    <translationWorkBench>
        <key>validation.record_deleted</key>
        <translatedText>5 registros eliminados con éxito</translatedText>
    </translationWorkBench>

    <message>
        <code>0</code>
        <description>Success</description>
    </message>
</platform>
See also: REST API:Error Codes

Fields

NameTypeDescription
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.
Personal tools