As of Version

product version 2021 Summer | component version

Request Method GET

Response Format JSON

Description

Retrieves the catalog specified by its name qname.

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.

Response HTTP status codes:

HTTP Status Code	Meaning
200	OK
401	Unauthorized
404	Not found

Request Example

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

no request body

Response Example

200 OK

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

Browser not supported