As of Version

product version 2020 Winter | component version

Request Method GET

Response Format JSON

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

>> AUTHENTICATION Service

Description

This request retrieves global localized text resources for the Accept-Language specified in the request header.

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., follow-up) 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.

As of 2022 Autumn, an optional query parameter tenant can be specified in order to retrieve the tenant-specific localized text resources instead of the global ones.

Response HTTP status codes:

HTTP Status Code	Meaning
200	OK
401	Unauthorized

Request Example

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

No request body

Response Example

200 OK

response body

{
  "system:baseTypeId_label": "Basistype ID",
  "system:objectTypeId_label": "Object-type ID",
  "system:createdBy_label": "Creator",
  "system:creationDate_label": "Created on",
  "system:lastModifiedBy_label": "Editor",
  "system:lastModificationDate_label": "Edited on",
  "system:versionNumber_label": "Version",
  "system:contentStreamLength_label": "File size",
  "system:contentStreamMimeType_label": "File type",
  "system:contentStreamFileName_label": "File name",
  "system:contentStreamId_label": "Content ID",
  "system:contentStreamRange_label": "Content range",
  "system:contentStreamRepositoryId_label": "Content stream repository",
  "system:digest_label": "Digest",
  "system:archivePath_label": "Archive path",
  "system:rmExpirationDate_label": "Retention date",
  "system:rmStartOfRetention_label": "Retention start",
  "system:rmDestructionDate_label": "Destruction date",
  "system:rmDestructionRetention_label": "Retention",
  "system:parentVersionNumber_label": "Folder version",
  "follow-up_label": "Follow-up",
  "follow-up_description": "This is a reminder to react on this object.",
  "review_label": "Review",
  "twosteptest_proc_label": "Two step process",
  "twosteptest_proc_description": "This little process tests task forms",
  "1st_task_label": "First task",
  "1st_task_description": "With this first task, a draft is to be prepared.",
  "2nd_task_label": "Second task",
  "2nd_task_description": "With this second task, the design is to be reviewed.",
  "appClient_label": "Client standards",
  "appClient:minidoc_label": "Smallest document",
  "appClient:minidoc_description": "01 Across all",
  "appClient:clientdefaults_label": "Object header",
  "appClient:clienttitle_label": "Name",
  "appClient:clientdescription_label": "Description",
  "appClientsystem:leadingType_label": "Leading object-type",
  "appClientsystem:leadingTypeId_label": "Type",
  "appClient:titledescription_label": "Name & Description",
  "appAcl:aclowner_label": "Access list",
  "appAcl:acl_label": "Access list",
  "appEmail_label": "Email (exchange)",
  "appEmail:email_label": "Email (exchange)",
  "appEmail:email_description": "01 Across all",
  "appEmail:from_label": "from",
  "appEmail:to_label": "to",
  "appEmail:cc_label": "cc",
  "appEmail:bcc_label": "bcc",
  "appEmail:subject_label": "Subject",
  "appEmail:attachmentcount_label": "Attachments",
  "appEmail:attachmentnames_label": "Attachment names",
  "appEmail:received_label": "Receive date",
  "appEmail:exchangeid_label": "Exchange ID",
  "appEmail:messageid_label": "Message ID",
  "appEmail:mode_label": "Mode",
  "appEmail:maildigest_label": "Email digest",
  "appEmail:meta_label": "Meta",
  "appEmail:datagroup_label": "Email data",
  "appInvoice_label": "Invoice processing",
  "appInvoice:zipreinvoice_label": "Invoice (general)",
  "appInvoice:zipreinvoice_description": "07 Invoice Management",
  "appInvoice:ziinvoicesot_label": "Invoice (ZUGFeRD)",
  "appInvoice:ziinvoicesot_description": "07 Invoice Management",
  "appInvoice:ziId_label": "Document ID",
  "appInvoice:ziName_label": "Document name",
  "appInvoice:ziTypeCode_label": "Type code",
  "appInvoice:ziPaymentReference_label": "Payment reference",
  "appInvoice:ziIssueDateTime_label": "Issue date",
  "appInvoice:ziDeliveryOccurence_label": "Delivery occurence",
  "appInvoice:ziDeliveryNoteId_label": "Delivery note ID",
  "appInvoice:ziDeliveryNoteDate_label": "Delivery note date",
  "appInvoice:ziOrderNoteId_label": "Order number",
  "appInvoice:ziOrderNoteDate_label": "Order date",
  "appInvoice:ziNotes_label": "Notes",
  "appInvoice:ziSellerId_label": "Seller ID",
  "appclient:dlm:prepare:0_label": "prepared",
  "appclient:dlm:prepare:1_label": "finished",
  "doctableofnotices_label": "DocTabelOfNotice",
  "tablecatalog_label": "Static catalog",
  "tablecreatedate_label": "Date",
  "tablecreatedatetime_label": "DateTime",
  "tabledistance_label": "Distance",
  "tabledistancedigit_label": "Distance digit",
  "tableemail_label": "Email",
  "tablenotice_label": "Notice",
  "tablenumber_label": "Number",
  "tablenumberdigit_label": "Number digit",
  "tableofnotices_label": "Table of notices",
  "tablephone_label": "Phone",
  "tablereadonly_label": "Boolean",
  "tablereference_label": "Reference",
  "tableurl_label": "URL",
  "tableuser_label": "User",
  "doctableofnotices_description": "01 Across all",
  "Table Group_label": "Meine Gruppe",
  "system:secondary_bale": "Alle sekundären Documente",
  "appInvoice:ziBuyerCity_label_label": "Stadt",
  "system:objectId_description": null,
  "system:baseTypeId_description": null,
  "system:objectTypeId_description": null,
  "system:secondaryObjectTypeIds_description": null,
  "system:createdBy_description": null,
  "system:creationDate_description": null,
  "system:lastModifiedBy_description": null,
  "system:lastModificationDate_description": null,
  "system:parentId_description": null,
  "system:parentObjectTypeId_description": null,
  "system:versionNumber_description": null,
  "system:tenant_description": null,
  "system:traceId_description": null,
  "system:tags_description": null,
  "system:contentStreamLength_description": null,
  "system:contentStreamMimeType_description": null,
  "system:contentStreamFileName_description": null,
  "system:contentStreamId_description": null,
  "system:contentStreamRange_description": null,
  "system:contentStreamRepositoryId_description": null,
  "system:digest_description": null,
  "system:archivePath_description": null,
  "system:rmExpirationDate_description": null,
  "system:rmStartOfRetention_description": null,
  "system:rmDestructionDate_description": null,
  "testsubject_label": null,
  "testsubject_description": null,
  "from_description": null,
  "to_description": null,
  "cc_description": null,
  "subject_description": null,
  "attachmentcount_description": null,
  "hasattachment_description": null,
  "attachmentnames_description": null,
  "received_description": null,
  "extract_label": "extract",
  "extract_description": null,
  "notice_description": null,
  "tableofnotices_description": null,
  "appClientcatalogs:catalogname_label": "Catalog name",
  "appClientcatalogs:catalogname_description": null,
  "appClientcatalogs:catalogvalue_label": "Catalog value",
  "appClientcatalogs:catalogvalue_description": null,
  "appClientcatalogs:active_label": "active",
  "appClientcatalogs_label": "Catalogs",
  "appClientcatalogs:active_description": null,
  "appClientcatalogs:catalogs_label": "Catalogs",
  "appClientcatalogs:catalogs_description": "01 Across all",
  "appClientcatalogs:lables_label": null,
  "appClientcatalogs:lables_description": null,
  "appClientcatalogs:labels_label": "Labels"
}

{
  "additionalProp1": "email",
  "additionalProp2": "phone",
  "additionalProp3": "mobile"
}

Browser not supported