Smart-search data (preview or paginated)
GET /indexer/v1/search/data
Operation id: getIndexerSearchData
Description
Unified replacement for legacy /service/search/getSearchData and /service/search/getMoreSearchData. All session params are derived from the auth token.
Fetch modes:
preview— initial/top-level view (limited records, no pagination)paginated— full pagination with Next/Previous (user_action=NP/PP)
Recommended paginated flow: send user_action on every paginated call.
A(Apply) — fresh search; requiressearch_data,start_date,end_dateNP/PP— next/previous page; search text and dates are resolved from Redis session
See devdocs/api/nextgen/indexer/INDEXER_SEARCH_API_CONTRACT.md.
Tags: IndexerSearch
Parameters
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
advanced_search | string | No | |
application_id | string | Yes | Application ID (100 Projects, 101–104 Forms/Walks, 105 QDocs, 107 QCheck) |
end_date | string | No | Range end yyyyMMdd. Required for new search |
fetch_mode | string | Yes | |
filter_metadata | string | No | URL-encoded JSON object of structured filter values (see INDEXER_SEARCH_API_CONTRACT.md) |
ignore_case | string | No | Case sensitivity — defaults to Y |
is_requested_for_all | string | Yes | Preview only — true fetches RECORDS_COUNT_ALL per app; false fetches RECORDS_COUNT_INDIVIDUAL |
page_number | integer | No | Legacy direct page jump (ignored when user_action is present) |
page_type | string | Yes | O = Overlay, R = Result Page |
search_category | string | No | Comma-separated category filter |
search_data | string | No | Search text. Required for new search (user_action=A or no pagination cursor) |
search_reference | string | No | Legacy pagination cursor (ignored when user_action is present) |
start_date | string | No | Range start yyyyMMdd. Required for new search |
tags | string | No | Comma-separated tags |
user_action | string | No | Paginated flow — A Apply, NP Next Page, PP Previous Page |
view_type | string | No | SV Store View, DV Department View, etc. |
Security
- AuthTokenHeader (apiKey)
- Session authentication token validated server-side against the user session store.
Responses
200 — Success — preview (has_more_results, records_count) or paginated
(current_page, has_next, has_previous, …). Empty search_data is valid.
Content type: application/json
400 — Invalid or missing request parameter
Content type: application/json
401 — Invalid or missing X-reflexis-csrf-token-X (HTTP 401)
Content type: application/json
500 — Unexpected server-side error
Content type: application/json
Response models
200 — Success — preview (has_more_results, records_count) or paginated
(current_page, has_next, has_previous, …). Empty search_data is valid.
Content type: application/json
Schema
JSON object (structure varies by endpoint). Field names are snake_case in responses.
{
"type": "object",
"description": "JSON object (structure varies by endpoint). Field names are snake_case in responses."
}
400 — Invalid or missing request parameter
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
status | string | Yes | |
api_error_code | string | Yes | Application-level error code (e.g. E504, E515, E539) |
response | string | Yes | Human-readable error message |
{
"type": "object",
"example": {
"status": "ER",
"api_error_code": "E504",
"response": "page_type is mandatory"
},
"required": [
"status",
"api_error_code",
"response"
],
"properties": {
"status": {
"type": "string",
"enum": [
"ER"
]
},
"api_error_code": {
"type": "string",
"description": "Application-level error code (e.g. E504, E515, E539)"
},
"response": {
"type": "string",
"description": "Human-readable error message"
}
}
}
401 — Invalid or missing X-reflexis-csrf-token-X (HTTP 401)
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
status | string | Yes | |
api_error_code | string | Yes | Application-level error code (e.g. E504, E515, E539) |
response | string | Yes | Human-readable error message |
{
"type": "object",
"example": {
"status": "ER",
"api_error_code": "E504",
"response": "page_type is mandatory"
},
"required": [
"status",
"api_error_code",
"response"
],
"properties": {
"status": {
"type": "string",
"enum": [
"ER"
]
},
"api_error_code": {
"type": "string",
"description": "Application-level error code (e.g. E504, E515, E539)"
},
"response": {
"type": "string",
"description": "Human-readable error message"
}
}
}
Example:
{
"status": "ER",
"api_error_code": "E202",
"response": "User session is invalid"
}
500 — Unexpected server-side error
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
status | string | Yes | |
api_error_code | string | Yes | Application-level error code (e.g. E504, E515, E539) |
response | string | Yes | Human-readable error message |
{
"type": "object",
"example": {
"status": "ER",
"api_error_code": "E504",
"response": "page_type is mandatory"
},
"required": [
"status",
"api_error_code",
"response"
],
"properties": {
"status": {
"type": "string",
"enum": [
"ER"
]
},
"api_error_code": {
"type": "string",
"description": "Application-level error code (e.g. E504, E515, E539)"
},
"response": {
"type": "string",
"description": "Human-readable error message"
}
}
}
Example:
{
"status": "ER",
"api_error_code": "E500",
"response": "Internal server error"
}