POST /catalog/api/catalogs

Owned by Technische Redaktion
Last updated: Dec 02, 2022
2 min read
As of Version

product version 2021 Winter | component version 

Request MethodPOST
Response FormatJSON
Required Permission

available if listed in authorization.accesses in authentication-prod.yml and the specified access condition is matched.

>> AUTHENTICATION Service
Description

Creates a global catalog stored via CATALOG service with the name specified in the JSON request body.

The catalog will be available for all tenants in the system.

If a catalog with name already exists, an error is thrown.

It is not possible to create a catalog with entries. If the JSON request body contains entries, they are ignored.

Meaning of HTTP status codes:

HTTP status codeDescription
200Success.
409A catalog with specified name already exists.
422Unprocessible entity.
Request HeaderContent-Type: application/json
Request Example

https://<host>/catalog/api/catalogs

{
    "objects": [
        {
            "properties": {
                "name": {
                    "value": "europeancountries"
                }
            }
        }
    ]
}
Response Example
{
    "objects": [
        {
            "properties": {
                "name": {
                    "value": "europeancountries"
                }
            }
        }
    ]
}