View Source

Everything within this section is only visible while editing. Use Page Properties ID "STUB", "REFACTURE", "PROGRESS", "rDEV", "rDOC", "rLANG" and "DONE".

Everything contained within the table is displayed in the (INTERNAL) Reports page.

Product Version	2021 Autumn
Report Note
Assignee	Antje

Resources & Remarks

Modification History

Add a new line to this table and fill it whenever you edit the page.

Name	Date	Product Version	Action
Antje	14 JUL 2021	2021 Autumn	created
Nils	10 NOV 2021	2021 Winter	added HEAD endpoint
Nils	10 NOV 2021	2021 Winter	added DELETE entry endpoint
Nils	10 NOV 2021	2021 Winter	added replace entry endpoint

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	/catalog/api/catalogs
POST as of 2021 Autumn	Create a catalog.	JSON	/catalog/api/catalogs
GET as of 2021 Autumn	Retrieve catalog entry values.	JSON	/catalog/api/catalogs/name
POST as of 2021 Autumn	Add new entries.	HTTP status code	/catalog/api/catalogs/{name}
DELETE as of 2021 Autumn	Delete a catalog.	HTTP status code	/catalog/api/catalogs/{name}
HEAD as of 2021 Winter	Check the existence of an entry.	HTTP status code	/catalog/api/catalogs/{name}/{entryid}
DELETE as of 2021 Winter	Delete an entry.	HTTP status code	/catalog/api/catalogs/{name}/{entryid}
POST as of 2021 Autumn	Replace an entry.	HTTP status code	/catalog/api/catalogs/{name}/{entryid}