Dimension Service API  2.0.0
api indexresource index

POST index

since: 2.0.0
Enables automatic indexing for the current tenant environment and all its dimensions if it was not previously enabled. Otherwise, updates the indexing information. This operation triggers an initial tenant indexing job.

Request Headers

pros-dimension-consistency
0.13optional
string
pros-dimension-consistency is an optional HTTP header used to define the data consistency level of the request. There is a trade off between data consistency and service availability and performance: higher data consistency can result in lower availability and slower performance, while lower data consistency can result in higher availability and faster performance.
0.13 valid values:
  • HIGHEST
  • HIGH
  • NORMAL
  • LOW
  • LOWEST
Accept-Language
0.13optional
string
The Accept-Language request HTTP header advertises which languages the client is able to understand, and which locale variant is preferred.

Resource Information

Response Content
json
Response Object
Success Statuses
200  OK
Error Statuses
404  NOT FOUND
503  SERVICE UNAVAILABLE
Other Methods

Example 1

Request:

Response:
HTTP/1.1  200  OK 

{
    "indexName": "e4e0fa74-bb0c-4c68-825f-20b786077afa_5bf436bc-1a67-4025-8374-1789adc83280_0d2e570a-73be-43ae-a67b-75693924810d",
    "primaryShardCount": 1,
    "primaryShardCountOverwritten": false
}

Error Example - The tenant is not configured to be indexed automatically

see: DIM-006003

Request:

Response:
HTTP/1.1  404  NOT FOUND 

{
  "errorID"     : "DIM-006003",
  "errorMessage": "The specified environment is not configured to be indexed automatically.",
  "requestID"   : "DIM-0800200c9a66"
}

Error Example - The tenant index could not be created

see: DIM-006001

Request:

Response:
HTTP/1.1  503  SERVICE UNAVAILABLE 

{
  "errorID"     : "DIM-006001",
  "errorMessage": "The search index could not be created, please try sending the request again. If the issue persists, please contact your support representative for assistance.",
  "requestID"   : "DIM-0800200c9a66"
}

Error Example - The index feature is not configured in this instance

see: DIM-006002

Request:

Response:
HTTP/1.1  503  SERVICE UNAVAILABLE 

{
  "errorID"     : "DIM-006002",
  "errorMessage": "The integration with the search service is not configured in this instance. Please contact your support representative for assistance.",
  "requestID"   : "DIM-0800200c9a66"
}