GET /api-web/api/system/dms/catalogs/{qname}

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

product version 2021 Summer | 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_SYSTEM_INTEGRATOR role.

>> AUTHENTICATION Service
Description

Retrieves the global or app-specific catalog specified by its name qname

The endpoint returns null if no catalog with qname was found in both global and app-specific resource.

As of 2022 Autumn, an optional query parameter tenant can be specified in order to retrieve the tenant-specific catalog instead of the global or app-specific one.

Response HTTP status codes:

HTTP Status CodeMeaning
200 OK
401 Unauthorized
404 Not found
Request Example

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

No request body

Response Example

200 OK

{
  "readonly": false,
  "entries": [
    {
      "name": "Private",
      "disabled": false
    },
    {
      "name": "Public",
      "disabled": false
    }
  ]
}