Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

ParameterDescriptionDefault
csvSection of parameters for the export of search result lists via the endpoint POST /api-web/api/dms/objects/export.

delimiterSeparator between individual values.;

encodingUsed encoding.UTF-8

batchSizeMaximum number of objects to be included in the exported result list.100

writeBOM (as of 2023 Spring)Boolean value that specifies if byte order mark should be used (true) or not (false). If true, emojis and German umlauts can be displayed correctly.
Note: true is only supported for UTF-8 encoding.
false
api-web.technical-roles

Comma-separated list of strings that specify the names of the roles that should be considered as technical roles. As such, they are filtered out, e.g., by the endpoints GET /api-web/api/idm/users and GET /api-web/api/idm/users/{userId}.

YUUVIS_SYSTEM_INTEGRATOR, YUUVIS_TENANT_ADMIN
api-web.default-localeAn ISO language code that specifies the default locale for requests to the Web-API gateway.en
api-web.user-label-templates(as of 2023 Spring)

List of templates for creating display name for users instead of user IDs.

If you want to avoid the userId to appear in your client application, you can display the value of one or multiple of the following user attributes instead:

  • id
  • email
  • username
  • firstname
  • lastname

Configure a template with comma-separated references on those attributes as shown in the example below. If you list multiple templates, the first one for which all referenced attributes are available will be used. If all configured templates contain at least one attribute for which no value is available for the corresponding user, the default applies.

Example configuration:


Code Block
api-web.user-label-templates:
    - "%{lastname}, %{firstname} (%{username})"
    - "%{firstname} (%{username})"
    - "%{lastname} (%{username})"
    - "%{username}"


corresponding ID value