GET /api-web/api/resources/text

As of Version

product version 2020 Autumn | component version

Request Method GET

Response Format JSON

Description

Retrieves localized text resources for the Accept-Language specified in the request header (formatted in ISO norm, e.g., de, en, es, fr, ...) merged from tenant-specific, app-specific and global resources.

The response body is a JSON structure where each technical term as a key is mapped to a string value that will occur as a localized term in the graphical user interface.

Each technical term consists of a field identification (e.g., twosteptest_proc:test_table) followed by either _label or _description in order to be displayed as field label or field description in the graphical user interface.

If a technical term is mapped to null, localization has not yet been applied. The field identification will be displayed as field label in the graphical user interface. A description will not be provided.

Response HTTP status codes:

HTTP Status Code	Meaning
`200`	OK
`401`	Unauthorized

Request Example

https://<host>/api-web/api/resources/text

No request body

Response Example

200 OK

{
  "system:baseTypeId_label": "Basistype ID",
  "system:objectTypeId_label": "Object-type ID",
  "system:secondaryObjectTypeIds_label": "Characteristics",
  "system:parentObjectTypeId_label": "Folder type",
  "system:objectId_label": "Object ID",
  "system:parentId_label": "Folder ID",
  "system:createdBy_label": "Creator",
  "system:creationDate_label": "Created on",
  "system:lastModifiedBy_label": "Editor",
  "system:lastModificationDate_label": "Edited on",
  "system:versionNumber_label": "Version",
  "system:tenant_label": "Tenant",
  "system:traceId_label": "Trace ID",
  "system:tags_label": "Tags",
  "system:contentStreamLength_label": "File size",
  "system:contentStreamMimeType_label": "File type",
  "system:contentStreamFileName_label": "File name",
  "description_label": "Description",
  "label_label": "Label",
  "language_label": "Language",
  "language_description": "ISO: en, de, ...",
  "twosteptest_proc:datetime_label": "Date & time",
  "twosteptest_proc:column_user_label": "User",
  "twosteptest_proc:column_boolean_label": "Editable",
  "twosteptest_proc:test_table_label": "Notices",
  "twosteptest_proc:test_table_description": "List of notices",
  "userGroupAssignment:user_label": "User",
  "userGroupAssignment:user_description": "Assign the user who should ...",
  "userGroupAssignment:comment_label": "Comment",
  "userGroupAssignment:comment_description": "Tell the user what to do .."
}