Dimension Service API  2.0.0
api indexresource index

GET index

since: 2.0.0
Retrieves the current tenant environment's indexing information, if available.

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
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
    "lastIndexAt": "2020-01-01T00:00:01"
}

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"
}