Dimension Service API  2.0.0
api indexresource index

POST {+dimension}/index

since: 0.32
Enables automatic indexing for the referenced dimension if tenant automatic indexing is enabled and if it was not previously enabled. Otherwise, updates the indexing information. This operation triggers an initial dimension indexing job.

Path Elements

+dimension
0.32required
string
The URI path to a specific dimension (by ir or name). by ID or by name).

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.

Request Body

primaryShardCount
0.32optional
string
The primary shard count to use for this dimension index. This parameter has been deprecated and any value provided will not be honored.

Resource Information

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

Example 1

Request:

primaryShardCount=5

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 dimension's tenant environment 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 dimension's tenant environment is currently performing indexing.

see: DIM-006004

Request:

Response:
HTTP/1.1  404  NOT FOUND 

{
  "errorID"     : "DIM-006004",
  "errorMessage": "The specified environment is currently performing index operations.  This action has been deferred while this operation is in progress.",
  "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"
}