GET /api-web/api/system/dms/catalogs/{qname}

As of Version

product version 2021 Summer | component version

Request Method GET

Response Format JSON

Description

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 Code	Meaning
`200 OK`	Successful.
`401 Unauthorized`	Not successful.
`404 Not found`	Not successful.

Request Example

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

no request body

Response Example

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