Versions Compared

Old Version 1

changes.mady.by.user Technische Redaktion

Saved on

compared with

New Version 2

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 MethodGET
Response FormatJSON
Description


Excerpt

Retrieves the catalog specified by its name qname, with optional restriction to either tenant-specific or global resource.

If necessary, add the query parameter ?global=true (?global=false) for a global (tenant-specific) catalog with name qname. The endpoint returns null, if no catalog with qname is available in the global (tenant-specific) resource.

If no query parameter is specified, the tenant-specific resource will be checked first. If a catalog with name qname is available, it will be returned. Otherwise the global resource will be checked. If there is a catalog with name qname, it will be returned. The endpoint returns null if no catalog with qname was found in both global and tenant-specific resource.

The role YUUVIS_TENANT_ADMIN is required.

Response HTTP status codes:

HTTP Status CodeMeaning
200 OKSuccessful.
400 Bad RequestNot successful.
401 UnauthorizedNot successful.
404 Not foundNot successful.


Request Example

https://<host>/api-web/api/admin/dms/catalogs/entries?global=true

no request body

Response Example


Code Block
languageyml
{
	"entries": [
		{
			"disabled": true,
			"name": "string"
		}
	],
	"readonly": true,
	"tenant": "string"
}