CATALOG Service Endpoints

The CATALOG service API provides CRUD (create, read, update, delete) operations on catalogs and catalog entries.

As of version 2021 Winter, the CATALOG service is provided as a beta version.

HTTP Method as of product version	Purpose	Response Format	Description
GET as of 2021 Autumn	Retrieve all catalog names.	JSON	Retrieves all global catalogs stored via CATALOG service without their entries. /catalog/api/catalogs
POST as of 2021 Autumn	Create a catalog.	JSON	Creates a global catalog stored via CATALOG service with the `name` specified in the JSON request body. /catalog/api/catalogs
GET as of 2021 Autumn	Retrieve catalog entry values.	JSON	Retrieves the global catalog specified by its `name` with all its entries. /catalog/api/catalogs/name
POST as of 2021 Autumn	Add new entries.	HTTP status code	Adds the entries as specified in the JSON request body for the global catalog specified by its `name`. /catalog/api/catalogs/{name}
DELETE as of 2021 Autumn	Delete a catalog.	HTTP status code	Deletes the global catalog specified by its `name`. /catalog/api/catalogs/{name}
HEAD as of 2021 Winter	Check the existence of an entry.	HTTP status code	Checks if the catalog specified by its `name` has an entry with the specified `entryid`. /catalog/api/catalogs/{name}/{entryid}
DELETE as of 2021 Winter	Delete an entry.	HTTP status code	Deletes the specified entry from the specified catalog. /catalog/api/catalogs/{name}/{entryid}
POST as of 2021 Autumn	Replace an entry.	HTTP status code	Replaces an entry by another entry in the specified catalog. /catalog/api/catalogs/{name}/{entryid}