Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Page Properties
hiddentrue
idPROGRESS

Product Version2021 Autumn
Report Note
AssigneeAntje

Resources & Remarks


Modification History

NameDateProduct VersionAction
Antje14 JUL 20212021 Autumncreated
Nils10 NOV 20212021 Winteradded HEAD endpoint
Nils10 NOV 20212021 Winteradded DELETE entry endpoint
Nils10 NOV 20212021 Winteradded replace entry endpoint


...

Excerpt

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


Note

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


HTTP Method
as of product version
PurposeResponse FormatDescription
GET
as of 2021 Autumn
Retrieve all catalog names.JSON

Insert excerpt
GET /catalog/api/catalogs
GET /catalog/api/catalogs
nopaneltrue

/catalog/api/catalogs

POST
as of 2021 Autumn
Create a catalog.JSON

Insert excerpt
POST /catalog/api/catalogs
POST /catalog/api/catalogs
nopaneltrue

/catalog/api/catalogs

GET
as of 2021 Autumn
Retrieve catalog entry values.JSON

Insert excerpt
GET /catalog/api/catalogs/{name}
GET /catalog/api/catalogs/{name}
nopaneltrue

/catalog/api/catalogs/name

POST
as of 2021 Autumn
Add new entries.HTTP status code

Insert excerpt
POST /catalog/api/catalogs/{name}
POST /catalog/api/catalogs/{name}
nopaneltrue

/catalog/api/catalogs/{name}

DELETE
as of 2021 Autumn
Delete a catalog.HTTP status code

Insert excerpt
DELETE /catalog/api/catalogs/{name}
DELETE /catalog/api/catalogs/{name}
nopaneltrue

/catalog/api/catalogs/{name}

HEAD
as of 2021 Winter
Check the existence of an entry.HTTP status code

Insert excerpt
HEAD /catalog/api/catalogs/{name}/{entryid}
HEAD /catalog/api/catalogs/{name}/{entryid}
nopaneltrue

/catalog/api/catalogs/{name}/{entryid}

DELETE
as of 2021 Winter
Delete an entry.HTTP status code

Insert excerpt
DELETE /catalog/api/catalogs/{name}/{entryid}
DELETE /catalog/api/catalogs/{name}/{entryid}
nopaneltrue

/catalog/api/catalogs/{name}/{entryid}

POST
as of 2021 Autumn
Replace an entry.HTTP status code

Insert excerpt
POST /catalog/api/catalogs/{name}/{entryid}
POST /catalog/api/catalogs/{name}/{entryid}
nopaneltrue

/catalog/api/catalogs/{name}/{entryid}

...