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

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

product version 2021 Summer | component version 

Request MethodPATCH
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

Updates the existing global or app-specific catalog identified by its name qname, with the data passed in JSON format in the request body.

In the response body, the modified catalog will be returned.

If no global or app-specific catalog with name qname is available, an error will be thrown.

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

Response HTTP status codes:

HTTP Status CodeMeaning
200 OK
401 Unauthorized
403 Forbidden
404 Not found
500 Internal Server Error
Request Example

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

request body
{}
Response Example

200 OK

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