Skip to main content

Indexing

In IndexingController we have methods to monitor and run indexing.

Check if indexing is running

GET /api/admin/index/is-running

A call without any parameters returns true if indexing is running, false otherwise.

Index a full workspace

POST /api/admin/index?workspace=…&clear=…
  • workspace, URI of the workspace
  • clear, an optional parameter of type boolean; if true, it will clear all data from the workspace

Runs a full indexing process on the workspace and updates all collection indexes.

Index a collection

POST /api/admin/index/collection?collection=…
  • collection, URI of the collection
  • clear, an optional parameter of type boolean; if true, it will clear all data from the workspace

Runs an indexing process on the specific collection and updates the indexes.

Index a list of items

POST /api/admin/index/items?collection=…&item=…
  • collection, URI of the collection
  • item, a list of item URIs

Runs an indexing process on the specified list of items.