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
Antje18 MAY 20212021 SummerPage created.


...

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_TENANT_ADMIN role.

>> AUTHENTICATION Service
Description


Excerpt

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

Code Block
languageyml
titlerequest 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
Code Block
languageyml
titleresponse 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 }