Documentation Center

Fetch Search Indexes

Fetches the full list of search indexes.

Request

URI: /v2/searchindex

HTTP Method: GET

Header params:
  • Accept: [application/json] OR [application/xml]
  • Content-Type: [application/json] OR [application/xml]

Response

Success
  • XML: <configuration><indexes indexed="true" indexed_audit="true"><index attribute="" id="search.category.indexterms" ignore="" inline="" standards="DITA" tags="" xpath="//indexterm[not(parent::indexterm)]" xpath_end="indexterm"/><index attribute="" id="search.category.figure.title" ignore="" inline="" standards="DITA" tags="" xpath="//fig/title" xpath_end="title"/><index attribute="" id="search.category.table.title" ignore="" inline="" standards="DITA,S1000D" tags="" xpath="//table/title" xpath_end="title"/><index attribute="" id="examplename" ignore="" inline="" standards="DITA" tags="" xpath="//ben" xpath_end="ben"/></indexes></configuration>
  • JSON: {"indexes":[{"indexed":"true", "indexed_audit":"true", "index":[{"attribute":"", "id":"search.category.indexterms", "ignore":"", "inline":"", "standards":"DITA", "tags":"", "xpath":"//indexterm[not(parent::indexterm)]", "xpath_end":"indexterm"},{"attribute":"", "id":"search.category.figure.title", "ignore":"", "inline":"", "standards":"DITA", "tags":"", "xpath":"//fig/title", "xpath_end":"title"},{"attribute":"", "id":"search.category.table.title", "ignore":"", "inline":"", "standards":"DITA,S1000D", "tags":"", "xpath":"//table/title", "xpath_end":"title"},{"attribute":"", "id":"examplename", "ignore":"", "inline":"", "standards":"DITA", "tags":"", "xpath":"//ben", "xpath_end":"ben"}]}]}
Failed
  • XML: <result message="Not Found" messageKey="Not Found" status="FAIL" statusCode="404" />
  • JSON: {"statusCode":404,"messageKey":"Not Found", "message":"Not Found", "status":"FAIL", "info":[]}

Permissions

"Use application"

Example

Request:

GET http://example.corp:8080/LiveContent/v2/searchindex

Response:

<configuration><indexes indexed="true" indexed_audit="true"><index attribute="" id="search.category.indexterms" ignore="" inline="" standards="DITA" tags="" xpath="//indexterm[not(parent::indexterm)]" xpath_end="indexterm"/><index attribute="" id="search.category.figure.title" ignore="" inline="" standards="DITA" tags="" xpath="//fig/title" xpath_end="title"/><index attribute="" id="search.category.table.title" ignore="" inline="" standards="DITA,S1000D" tags="" xpath="//table/title" xpath_end="title"/><index attribute="" id="examplename" ignore="" inline="" standards="DITA" tags="" xpath="//ben" xpath_end="ben"/></indexes></configuration>