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; requires search_data, start_date, end_date
  • NP / 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

NameTypeRequiredDescription
advanced_searchstringNo
application_idstringYesApplication ID (100 Projects, 101–104 Forms/Walks, 105 QDocs, 107 QCheck)
end_datestringNoRange end yyyyMMdd. Required for new search
fetch_modestringYes
filter_metadatastringNoURL-encoded JSON object of structured filter values (see INDEXER_SEARCH_API_CONTRACT.md)
ignore_casestringNoCase sensitivity — defaults to Y
is_requested_for_allstringYesPreview only — true fetches RECORDS_COUNT_ALL per app; false fetches RECORDS_COUNT_INDIVIDUAL
page_numberintegerNoLegacy direct page jump (ignored when user_action is present)
page_typestringYesO = Overlay, R = Result Page
search_categorystringNoComma-separated category filter
search_datastringNoSearch text. Required for new search (user_action=A or no pagination cursor)
search_referencestringNoLegacy pagination cursor (ignored when user_action is present)
start_datestringNoRange start yyyyMMdd. Required for new search
tagsstringNoComma-separated tags
user_actionstringNoPaginated flow — A Apply, NP Next Page, PP Previous Page
view_typestringNoSV Store View, DV Department View, etc.

Security

  • ApiKeyHeader (apiKey)
    • APIGEE API key header validated by VerifyAPIKey policy.
  • 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

PropertyTypeRequiredDescription
statusstringYes
api_error_codestringYesApplication-level error code (e.g. E504, E515, E539)
responsestringYesHuman-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

PropertyTypeRequiredDescription
statusstringYes
api_error_codestringYesApplication-level error code (e.g. E504, E515, E539)
responsestringYesHuman-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

PropertyTypeRequiredDescription
statusstringYes
api_error_codestringYesApplication-level error code (e.g. E504, E515, E539)
responsestringYesHuman-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"
}