GET /api-web/api/admin/resources/text

Owned by Technische Redaktion
Last updated: Nov 09, 2022
3 min read
As of Version

product version 2020 Winter | component version 

Request MethodGET
Response FormatJSON
Required Permission

Available if listed in authorization.accesses in authentication-prod.yml and the specified access condition is matched. In the default configuration, access is granted via the YUUVIS_TENANT_ADMIN role.

>> AUTHENTICATION Service
Description

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

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 CodeMeaning
200OK
401 Unauthorized
404Not found
Request Example

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

no request body

Response Example

200 OK

{
  "tenExample:betreff_label": "Subject",
  "tenExample:betreff_description": null,
  "tenExample:strsingle_label": "String",
  "tenExample:strsingle_description": "unlimited",
  "tenExample:strregextime_label": "Time",
  "tenExample:strregextime_description": "Time format is 24 hours with hh:mm",
  "tenExample:strcataloggermancountries_label": "German countries",
  "tenExample:strcataloggermancountries_description": "single-field",
  "tenExample:strcataloggermancountriesro_label": "German countries",
  "tenExample:strcataloggermancountriesro_description": "single-field, read-only",
  "tenExample:intsingle_label": "Integer",
  "tenExample:intsingle_description": "unlimited",
  "tenExample:intsingledigit_label": "Integer",
  "tenExample:intsingledigit_description": "digit grouping",
  "tenExample:decsingle_label": "Decimal",
  "tenExample:decsingle_description": "unlimited",
  "tenExample:decsingledigit_label": "Decimal",
  "tenExample:decsingledigit_description": "digit grouping",
  "tenExample:datetimesingle_label": "Date & time",
  "tenExample:datetimesingle_description": "unlimited",
  "tenExample:datetimesinglerequired_label": "Date & time",
  "tenExample:datetimesinglerequired_description": "mandatory",
  "tenExample:datesingle_label": "Date2",
  "tenExample:datesingle_description": "unlimited",
  "tenExample:datesinglerequired_label": "Date1",
  "tenExample:datesinglerequired_description": "mandatory",
  "tenExample:booleanrequiredtrue_label": "Boolean",
  "tenExample:booleanrequiredtrue_description": "mandatory",
  "tenExample:booleannull_label": "Boolean Tri-State",
  "tenExample:booleannull_description": "Null allowed",
  "tenExample:extract2_label": "Extract & map",
  "tenExample:tablesimplefields_label": "Simple fields",
  "tenExample:tablesimplefields_description": "Table with simple fields",
  "tenExample:tableclassifications_label": "Fields with classifications",
  "tenExample:tableclassifications_description": "Table with classification fields",
  "tenExample:strorganizationsingle_label": "User/Group",
  "tenExample:strorganizationmulti_label": "Users/Groups",
  "tenExample:strcatalogfruitsmulti_label": "Fruits",
  "tenExample:strcatalogfruitmulti_description": "Apple,Banana,Pear,Plum,Pineapple (multi)",
  "tenExample:tablenotice_label": "Notice",
  "tenExample:tablecreatedate_label": "Date",
  "tenExample:tableuser_label": "User",
  "tenExample:tablereadonly_label": "Write protection",
  "tenExample:tablenumber_label": "Number",
  "tenExample:tablenumberdigit_label": "Digit-number",
  "tenExample:tabledistance_label": "Distance",
  "tenExample:tabledistancedigit_label": "Digit-distance",
  "tenExample:tablecreatedatetime_label": "Datetime",
  "tenExample:tableemail_label": "Email",
  "tenExample:tableurl_label": "URL",
  "tenExample:tablephone_label": "Phone",
  "tenExample:tablecatalog_label": "Catalog",
  "tenExample:tablereference_label": "Reference",
  "tenExample:simpleFields_label": "Simple Fields",
  "tenExample:classifications_label": "Classifications",
  "tenExample:number_label": "Number",
  "tenExample:number_description": "Will be filled via script",
  "tenExample:createdate_label": "Created",
  "tenExample:createdate_description": "Will be filled via script as well",
  "tenExample:notice_label": "Notice",
  "tenExample:notice_description": "To be filled by user",
  "tenExample:probability_label": "Probability",
  "tenExample:probability_description": "To be filled by user as well",
  "tenExample:readonly_label": "Read-only",
  "tenExample:readonly_description": "It's still unclear who will do it ...",
  "tenExample:required_label": "Mandatory fields",
  "tenExample:notrequired_label": "Without obligation",
  "tenExample:tableGroup_label": "Table group",
  "tenExample:tableFilling_label": "Table filling",
  "tenExample:process_label": "Approval process",
  "tenExample:process:0_label": "Draft in work",
  "tenExample:process:1_label": "Draft in review",
  "tenExample:process:2_label": "Draft in rework",
  "tenExample:process:3_label": "Document ready",
  "tenExample:process:4_label": "Approved",
  "tenExample:process:5_label": "Rejected",
  "tenExample:datetimemulti_label": "Date & time ",
  "tenExample:datetimemulti_description": "unlimited",
  "tenExample:strcatalogfruitmulti_label": "Fruits",
  "tenExample:strcatalogfruitsmulti_description": "Apple,Banana,Pear,Plum,Pineapple (multi)",
  "tenExample:Table Group_label": "My group",
  "twosteptest_proc_label": "Two step process",
  "twosteptest_proc:2nd_task": "Second task",
  "twosteptest_proc:simplefields_label": "Simple fields",
  "twosteptest_proc:complexfields_label": "Complex fields",
  "twosteptest_proc:datetime_label": "Date & time",
  "twosteptest_proc:date_label": "Date only",
  "twosteptest_proc:boolean_label": "boolean",
  "twosteptest_proc:integer_label": "Integer",
  "twosteptest_proc:decimal_label": "Decimal",
  "twosteptest_proc:string_label": "String",
  "twosteptest_proc:stringmultirow_label": "Multi-row string ",
  "twosteptest_proc:email_label": "Email",
  "twosteptest_proc:phone_label": "Phone",
  "twosteptest_proc:url_label": "URL",
  "twosteptest_proc:user_label": "User",
  "twosteptest_proc:reference_label": "Reference",
  "twosteptest_proc:catalogcustom_label": "Custom catalog",
  "twosteptest_proc:test_table_label": "Notices",
  "twosteptest_proc:test_table_description": "List of notices",
  "twosteptest_proc:column_string_label": "Notice",
  "twosteptest_proc:column_date_label": "Date",
  "twosteptest_proc:column_user_label": "User",
  "twosteptest_proc:column_boolean_label": "Editable",
  "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 .."
}