Introduction

The Search domain provides a comprehensive solution for accessing all relevant information of a selected topic through simple queries, facilitating a holistic view of the data for more effective analysis.

Overview

The Search API utilizes the OpenSearch engine.

Index

Index is a structure used by search engine to organize data for fast retrieval. Indices are accompanied by mappings that define the characteristics of the indexed data. The indexed data can be periodically resynchronized, triggered by a schedule, to ensure data consistency.

There are 2 main different types of indices in Search API, namely standard (canonical models) and custom indices. The Search API includes several built-in standard indices, such as aih-equipment, aih-main-systems, aih-work-items, etc., which are automatically resynchronized once a day. Custom indices can be added by user.

Query

Queries are executed using OpenSearch on selected indices to retrieve relevant search result. Additionally, users can save frequently used queries and authorize access to them.