Using the Catalog API
Create a catalog
POST
/catalogs
Query Parameters
Name | Type | Description |
---|---|---|
tenant* | string | |
environment* | string |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Bearer token containing the following permission: |
Request Body
Name | Type | Description |
---|---|---|
catalog* | object | catalog |
Remember! Catalog API can handle only 2 catalogs at the same time. If this limit is reached, one inactive catalog must be deleted by using the API before creating a new one. Determining the inactive catalog is done by listing all catalogs API.
Create a catalog returns the created catalog version. The catalog state is managed by the API. New catalogs are always set as Inactive and you must use the "Activate" method to this activate it.
The catalogCategoryTrees
nested JSON object is optional.
Delete a catalog
DELETE
https://items.attraqt.io/catalogs/{version}
Path Parameters
Name | Type | Description |
---|---|---|
version* | integer | βVersion of catalog to delete. |
Query Parameters
Name | Type | Description |
---|---|---|
tenant* | string | |
environment* | string |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Bearer token containing the following permission: |
Only Inactive catalogs can be deleted.
Attention: removing a catalog will delete items attached to this catalog, this operation can't be undone
Activate a catalog version
POST
https://items.attraqt.io/catalogs/activate/{version}
Path Parameters
Name | Type | Description |
---|---|---|
version* | integer | βVersion of catalog to activate. |
Query Parameters
Name | Type | Description |
---|---|---|
tenant* | string | |
environment* | string |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Bearer token containing the following permission: |
Get active catalogue version
GET
https://items.attraqt.io/catalogs/active
Get the catalog version currently promoted
Query Parameters
Name | Type | Description |
---|---|---|
tenant* | string | |
environment* | string |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Bearer token containing the following permission: |
List catalogs
GET
https://items.attraqt.io/catalogs
Query Parameters
Name | Type | Description |
---|---|---|
tenant* | string | |
environment* | string |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Bearer token containing the following permission: |
Api errors
Error category | Description |
---|---|
CATALOG_TENANT_ENV | Tenant and Environment are required |
CATALOG_SCHEMAS | Error in given Item Schema |
CATALOG_CATEGORY_TREES | Error in given Category tree |
CATALOG_LIMIT_REACHED | The limit of 2 catalogs is reached |
CATALOG_ALREADY_ACTIVE | The catalog is already active or in activation state |
CATALOG_FHR_FAILED | Error in FHR api |
CATALOG_NOT_ACTIVE | The catalog must be in activating state to perform the action |
CATALOG_DELETION_ACTIVE | The catalog must be inactive to be deleted |
Last updated