GET /api-web/api/admin/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_TENANT_ADMIN role.

>> AUTHENTICATION Service
Description

Retrieves the catalog specified by its technical name of either global/app-specific or tenant-specific origin.

Behind the technical name, add the query parameter ?global=false (?global=true) for a tenant-specific (app-specific or global) catalog. The endpoint returns null if no catalog with qname is available in the tenant-specific (app-specific or global) resource. 

Response HTTP status codes:

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

https://<host>/api-web/api/admin/dms/catalogs/appInvoice:type?global=true

no request body

Response Example

200 OK

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