Versions Compared

Old Version 4

changes.mady.by.user Technische Redaktion

Saved on

compared with

New Version Current

changes.mady.by.user Technische Redaktion

Saved on

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 MethodPOST
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 the global or app-specific catalog identified by its name qname with the data passed in JSON format in the request body.

If no global or app-specific catalog with name qname is available, it will be created.

The response body is a JSON structure with the list errors containing possibly occured error messages, and the boolean valid that is true for a successfully validated JSON in the request body.

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
201 OK
400 Bad Request
401 Unauthorized
403 Forbidden


Request Example

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

Code Block
languageyml
titlerequest body
{
  "readonly": false,
  "entries": [
    {
      "name": "Private",
      "disabled": false
    },
    {
      "name": "Public",
      "disabled": false
    }
  ]
}


Response Example

200 OK

Code Block
languageyml
titlerequest body
{
  "errors": [],
  "valid": true
}
 true
}