Get UI label translations for the authenticated user's locale
GET /mywork/v1/translations
Operation id: getTranslations
Description
Returns the flat resource-bundle map of UI label keys to translated strings for the authenticated user's domain and locale. One URL serves both web and mobile clients via the optional source query param.
source | Legacy equivalent | Lookup |
|---|---|---|
web (default) | POST /service/appConfig/translation | ResourceUtil.getResourceBundleMap — merges domain bundle with default (-99) client bundle and DOMAIN_LANG_KEYS DB overlay |
mobile | POST /service/domain/getMobilityResourceBundle | DomainConfigService.getMobilityResourceBundle — flat MobileResource.{domainId}_{langCode}.properties only; no default-bundle overlay; no DB overlay |
Authentication: domainId and langCode are always resolved from the validated session. These cannot be overridden by the client.
Unlike the legacy endpoints, the map is returned as a raw JSON object under translations (not a URL-encoded JSON string under response).
For source=web, empty object {} when no bundle entries are available. For source=mobile, a missing mobile resource file returns NO_DATA_FOUND (E404) rather than an empty map — this preserves the legacy mobility contract.
Response Fields
| Field | Type | Description |
|---|---|---|
status | String | OK for success |
translations | Object | Flat map of resource key → translated string (e.g. "10001071": "Source") |
Error Scenarios
| Scenario | HTTP | Error Code | Message |
|---|---|---|---|
Missing X-reflexis-csrf-token-X header | 400 | E112 | X-reflexis-csrf-token-X header is mandatory |
Invalid source (not web or mobile) | 400 | E219 | Invalid source. Allowed values: web, mobile |
| Invalid or expired token | 401 | E204 | Invalid or expired token |
Mobile resource file not found (source=mobile) | 200 | E404 | Mobility resource file / path error message from legacy |
| Unexpected server-side error | 500 | E302 | Internal server error |
Error Codes Reference
| Code | Description |
|---|---|
E112 | X-reflexis-csrf-token-X header is mandatory |
E219 | Invalid translations source query param |
E204 | Invalid or expired token |
E404 | No data found (mobile resource file missing) |
E302 | Internal server error |
Tags: MyWorkTranslations
Parameters
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
source | string | No | Default: web. Case-insensitive. - web — web UI label bundle (ResourceUtil.getResourceBundleMap), includes default/-99 fallback and DB overlay. - mobile — mobility properties file only (DomainConfigService.getMobilityResourceBundle); no default-bundle fallback; missing file → E404. |
Security
- AuthTokenHeader (apiKey)
- Session authentication token validated server-side against the user session store.
Responses
200 — Success — flat translations map
Content type: application/json
400 — Invalid or missing request parameter
Content type: application/json
401 — Invalid or expired X-reflexis-csrf-token-X token (HTTP 401)
Content type: application/json
500 — Unexpected server-side error
Content type: application/json
Response models
200 — Success — flat translations map
Content type: application/json
Schema
JSON object (structure varies by endpoint).
{
"type": "object",
"description": "JSON object (structure varies by endpoint)."
}
Example:
{
"status": "OK",
"translations": {
"10000056": "Apply",
"10001028": "Clear",
"10001071": "Source"
}
}
400 — Invalid or missing request parameter
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
status | string | Yes | Always "ER" for error responses |
errorCode | string | Yes | Application-level error code (e.g. E204, E112, E302) |
response | string | Yes | Human-readable error message |
{
"type": "object",
"example": {
"status": "ER",
"errorCode": "E204",
"response": "Invalid or expired token"
},
"required": [
"status",
"errorCode",
"response"
],
"properties": {
"status": {
"type": "string",
"description": "Always \"ER\" for error responses",
"enum": [
"ER"
]
},
"errorCode": {
"type": "string",
"description": "Application-level error code (e.g. E204, E112, E302)"
},
"response": {
"type": "string",
"description": "Human-readable error message"
}
}
}
401 — Invalid or expired X-reflexis-csrf-token-X token (HTTP 401)
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
status | string | Yes | Always "ER" for error responses |
errorCode | string | Yes | Application-level error code (e.g. E204, E112, E302) |
response | string | Yes | Human-readable error message |
{
"type": "object",
"example": {
"status": "ER",
"errorCode": "E204",
"response": "Invalid or expired token"
},
"required": [
"status",
"errorCode",
"response"
],
"properties": {
"status": {
"type": "string",
"description": "Always \"ER\" for error responses",
"enum": [
"ER"
]
},
"errorCode": {
"type": "string",
"description": "Application-level error code (e.g. E204, E112, E302)"
},
"response": {
"type": "string",
"description": "Human-readable error message"
}
}
}
Example:
{
"status": "ER",
"errorCode": "E204",
"response": "Invalid or expired token"
}
500 — Unexpected server-side error
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
status | string | Yes | Always "ER" for error responses |
errorCode | string | Yes | Application-level error code (e.g. E204, E112, E302) |
response | string | Yes | Human-readable error message |
{
"type": "object",
"example": {
"status": "ER",
"errorCode": "E204",
"response": "Invalid or expired token"
},
"required": [
"status",
"errorCode",
"response"
],
"properties": {
"status": {
"type": "string",
"description": "Always \"ER\" for error responses",
"enum": [
"ER"
]
},
"errorCode": {
"type": "string",
"description": "Application-level error code (e.g. E204, E112, E302)"
},
"response": {
"type": "string",
"description": "Human-readable error message"
}
}
}
Example:
{
"status": "ER",
"errorCode": "E302",
"response": "Internal server error"
}