SearchIndexResource Resource

Resource for maintenance of search indices

GET /index

List all required search indices

Request Parameters
name type description default constraints
page query Returned page, if paging is used. Paging starts with 1 1 int
pageSize query Page size for paging. If this is set to -1 no paging is used (all matching items are returned). Setting this to 0 will return no items. -1 int
q query Query string for filtering    
sort query Comma separated list of sorted attributes. Each attribute name may be prefixed with + for sorting in ascending order or - for sorting in descending order name  
Response Codes
code condition
200 Index list is returned.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions for index maintenance.
405 Feature elasticsearch is not activated.
Response Body
media type data type description
application/json IndexList (JSON) list response

Example

Request
GET /index
Accept: application/json
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "items" : [ { }, { } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "perms" : {
    "property1" : [ "edit", "view" ],
    "property2" : [ "edit", "edit" ]
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

PUT /index/{name}/rebuild

Schedule rebuilding of index

Request Parameters
name type description default constraints
name path index name    
drop query true, if the index shall be dropped first false boolean
Response Codes
code condition
200 Rebuilding of index {name} is scheduled.
404 Index {name} does not exist.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions for index maintenance.
405 Feature elasticsearch is not activated.
Response Body
media type data type description
application/json GenericResponse (JSON) generic response

Example

Request
PUT /index/{name}/rebuild
Accept: application/json
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}