Managing the Catalog

Lifecycle of data in the catalog.

Initially the status of a catalog is clean.

As soon as new data is pushed to the catalog, the system starts processing it. The status of the catalog is then changing to processing. Depending on the amount of data that has changed this may take some time.

After all processing is done, the status changes to data_to_import, which means that the data is now ready to be published to the production system.

In order to make the data available for searching, an import must be triggered. The status changes then to importing while the import is running. After successful completion of the import the status changes back to clean.

Getting information about the catalog

GET /1/catalog/

Provides basic information about the catalog you are working on.

The response contains the following fields:

Response field	Value
name	Unique name of the catalog
available_languages	Available languages in this catalog

note

The provided information is read-only and preconfigured by Partium.

🡢 See API Reference

---

HTTP

> GET https://api.partium.io/1/catalog
> Authorization: Bearer <<Your Access Token or API Key>>
> 
< HTTP/1.1 200 OK
< Content-Type: application/json
<
< {
<   "name": "your catalog name",
<   "available_languages": ["en", "de"]
< }

Python

response = requests.get(
  'https://api.partium.io/1/catalog',
  headers={
    'Authorization': 'Bearer <<Your Access Token or API Key>>',
  }

JavaScript

fetch('https://api.partium.io/1/catalog', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer <<Your Access Token or API Key>>',
  }
}).then(res => {
  ...
});

note

Replace <<Your Access Token or API Key>> with the preferred authentication method. See Authentication.

---

Getting the status of the catalog

GET /1/catalog/status

Provides information about the overall status of the catalog.

The response contains the following fields:

Response field	Value
status	Overall status of the catalog. See description of possible states below.
details	Depending on the status, the "details" section may contain further information describing the current progress.
last_import	Information about the last import: Contains a state, which indicates whether the import was successful and created_at, started_at, and finished_at times.
pending_import	Indicates whether an import is scheduled but has not yet been executed.

Possible catalog states and their meaning:

Status value	Meaning
clean	The catalog is (new or) fully processed and imported. Ready for search. Changes can be done.
processing	Data is being processed. An import can be triggered. Changes can be done.
data_to_import	The catalog is fully processed. An import can be triggered. Changes can be done.
importing	The catalog is being imported. No changes can be done.

note

No changes can be made to the catalog while an import is running (state importing).

🡢 See API Reference

---

HTTP

> GET https://api.partium.io/1/catalog/status
> Authorization: Bearer <<Your Access Token or API Key>>
> 
< HTTP/1.1 200 OK
< Content-Type: application/json
<
< {
<   "status": "processing",
<   "details": {
<     "part_count_pending": "10",
<     "part_count_processing": "4",
<     "part_count_success": "99"
<   },
<   "last_import": {
<     "state": "success",
<     "created_at": "2024-02-26 12:00:01.309000",
<     "started_at": "2024-02-26 12:00:09.908000",
<     "finished_at": "2024-02-26 12:10:08.101000"
<   },
<   "pending_import": true
< }

Python

response = requests.get(
  'https://api.partium.io/1/catalog/status',
  headers={
    'Authorization': 'Bearer <<Your Access Token or API Key>>',
  }
)

JavaScript

fetch('https://api.partium.io/1/catalog/status', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer <<Your Access Token or API Key>>',
  }
}).then(res => {
  ...
});

note

Replace <<Your Access Token or API Key>> with the preferred authentication method. See Authentication.

---

Triggering an import

POST /1/catalog/trigger_import

Trigger an import of the catalog data to the production system. This makes the data available for searching.

note

The import may not start immediately. Imports are delayed until the internal processing of the data is complete. In that case a request to the /catalog/status endpoint reports pending_import as true

If an import is already pending or is currently beeing processed, no further import can be triggered. In that case the request is failing.

🡢 See API Reference

---

HTTP

> POST https://api.partium.io/1/catalog/trigger_import
> Authorization: Bearer <<Your Access Token or API Key>>
> 
< HTTP/1.1 200 OK
< Content-Type: application/json
<
< {
<   "created_at": "2024-02-26 10:00:34.309000",
< }

Python

response = requests.post(
  'https://api.partium.io/1/catalog/trigger_import',
  headers={
    'Authorization': 'Bearer <<Your Access Token or API Key>>',
  }
)

JavaScript

fetch('https://api.partium.io/1/catalog/trigger_import', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <<Your Access Token or API Key>>',
  }
}).then(res => {
  ...
});

note

Replace <<Your Access Token or API Key>> with the preferred authentication method. See Authentication.

---