Versions Compared

Old Version 2

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

Adds an entry to 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 
200
OK
Successful.
401 
401
Unauthorized
Not successful.
403 
403
Forbidden
Not successful.
404 
404
Not Found
Not successful.
500 
500
Internal Server Error
Not successful.
Request Example

https://<host>/api-web/api/admin/dms/catalogs/entriestenMytenant:contracts

{}
Code Block
languageyml
titlerequest body that will not apply any changes to the catalog 'entries'
[
	{
	"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": true,
			 false
    },
    {
      "name": "Rental agreement",
      "string"
		}
	],
	"readonly": true,
	"tenant": "string"
}
true
disabled": false
    },
    {
      "name": "User contract",
      "disabled": false
    },
    {
      "name": "Purchase contract",
      "disabled": true
    }
  ]
}
rue }