POST /api-web/api/dms/catalogs/{qname}

Owned by Technische Redaktion
Last updated: Nov 25, 2022
1 min read
As of Version

product version 2021 Summer | component version 

Request MethodPOST
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 for any logged-in user.

>> AUTHENTICATION Service
Response FormatJSON
Description

Updates the tenant-specific catalog specified by its technical name qname with the data passed in the request body in JSON format.

If no tenant-specific catalog with the specified technical name is available, it will be created.

Response HTTP status codes:

HTTP Status CodeMeaning
200 OK
201 OK
400 Bad request
401 Unauthorized
403 Forbidden
Request Example

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

{
  "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
    }
  ]
}
Response Example

200 OK

response body
{
  "errors": [],
  "valid": true
}