Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Custom Index Management

Create Custom Index

Use this API to trigger the creation of a custom search index for data elements. The response will include the runId that can be used to query the current creation status using the Get Index Creation Status API.

🗒 Things to Know

  • Each account is limited to only one custom search index.
post/api/consentmanager/v1/custom-indexes

Request body

operationName'CREATE_DATA_ELEMENT_SEARCH_INDEX' required

The parameter representing the operation to be performed. Supported value is CREATE_DATA_ELEMENT_SEARCH_INDEX.

parametersobject required

Map of parameters required for the index creation. dataElementName parameter is mandatory for operation CREATE_DATA_ELEMENT_SEARCH_INDEX

Example request

{
  "operationName": "CREATE_DATA_ELEMENT_SEARCH_INDEX",
  "parameters": {
    "dataElementName": "City"
  }
}

Response

Index creation successfully triggered

runIdstring

Unique identifier for the pipeline run

statusstring

Status of the pipeline trigger

Example response

{
  "runId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "InProgress"
}