Indexer API (Open Data for Industries)

Index records for efficient search.

You can use the Indexer API to optimize search operations by indexing documents that contain structured and unstructured data. You can index or reindex records on the storage layer of Open Data for Industries. Indexes that are created that way are stored separately from the documents.

Attributes are defined in the schema and are indexed during the indexing process. For more information about schemas, see Schema structure.

The Indexer service also adds a number of metadata attributes:

  • id
  • kind
  • parent
  • acl, which is the Access Control List.
  • namespace
  • type
  • version
  • legal tags
  • index, which is the index of each record at the time of indexing.
To use the Indexer API, see the Indexer API reference.
Learn more

Prerequisites

Note: To use the Indexer API, you need to create access roles and assign users to them.

For data access authorization purposes, you need the service.search.admin role. This role is created by using the Entitlements API.

Indexer API endpoints

Table 1. Indexer service endpoints
API endpoint Description API reference
POST ​/reindex Reindex the records in the storage layer based on the kind. Reindex searchable objects

Indexer API endpoints permissions

Table 2. API method permissions
Endpoint URL Method Minimum permissions required
/reindex POST service.search.admin