GET /api-web/api/system/dms/catalogs

As of Version

product version 2021 Summer

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

Retrieves the technical names of all catalogs grouped in lists depending on their global (system-wide) or app-specific storage location.

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

Response HTTP status codes:

HTTP Status Code	Meaning
`200`	OK
`401`	Unauthorized
`500`	Internal Server Error

Request Example

https://<host>/api-web/api/system/dms/catalogs

No request body

Response Example

{
  "personalfile": [
    "appPersonalfile:class"
  ],
  "global": [
    "germancountry",
    "contracts",
    "germancountries",
    "globalnotice",
    "currency",
    "class",
    "clubs",
    "food"
  ],
  "invoice": [
    "appInvoice:type"
  ]
}