REST API:translationWorkbench Resource

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_id}

https://{domain}/networking/rest/translationWorkBench/{type}/{category}.{token_id}?args=param1,...

where:

• '{type} - Is the internal name for one of the Translation Workbench types:

__TBD__

• {category}.{token_id} - Is the identifier for a translated string stored in that category.

{

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

This sample response comes in reply to the request, http://localhost/networking/rest/translationWorkBench/customlabel/validation.record_deleted?args=5, when the user's language is Spanish.

<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.