Versions Compared

Key

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



Page Properties
hiddentrue
idDONE

Product Version
Report Note
Assignee

Resources & Remarks

Modification History

NameDateProduct VersionAction
Antje19 MAY 20212021 SummerPage created.
Antje14 JUL 20222022 Autumnadd optional 'tenant' query parameter



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


Excerpt

Updates a catalogthe 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 200 OK
Successful.401 401 Unauthorized
Not successful.403 403 ForbiddenNot successful.
404 404 Not foundNot successful.
500 500 Internal Server ErrorNot successful.


Request Example

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

Code Block
languageyml
titlerequest body
{}


Response Example

200 OK

Code Block
languageyml
titleresponse body
{
  "readonly": false,
  "entries": [
    {
      "disabledname": true"Private",
      "namedisabled": "string"false
    },
    {
 ],     "readonlyname": true"Public",
      "tenantdisabled": "string" false
    }
  ]
}