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

Owned by Technische Redaktion
Nov 12, 2021
As of Version

product version 2021 Summer | component version 

Request MethodPATCH
Response FormatJSON
Description

Updates the existing tenant-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 tenant-specific catalog with name qname is available, an error will be thrown.

The role YUUVIS_TENANT_ADMIN is required.

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/admin/dms/catalogs/tenMytenant:contracts

request body
[
	{
	"op": "replace",
	"path": "/entries/1/name",
	"value": "Rental agreement"
	},
	{
	"op": "remove",
	"path": "/entries/3
	{
	"op": "add",
	"path": "/entries/-",
	"value": {
		"name": "Purchase contract",
		"disabled": true}
	}	
]
Response Example

200 OK

t
response body
{
  "tenant": "mytenant",
  "readonly": false,
  "entries": [
    {
      "name": "Employment contract",
      "disabled": false
    },
    {
      "name": "Rental agreement",
      "disabled": false
    },
    {
      "name": "User contract",
      "disabled": false
    },
    {
      "name": "Purchase contract",
      "disabled": true
    }
  ]
}
rue }