Dell EMC OpenManage Enterprise 3.9 RESTful API Guide

PDF

POST method for SearchService.Search

This method performs a search using the query string that you provide and returns links to the corresponding navigation pages.

Description

Searches for the query strings and returns the links to the navigation pages.

Privilege

VIEW

HTTP response codes

200

Example request body in OpenManage Enterprise

 
{
  "Count":8,
  "Skip":7,
  "QueryString": "device",
  "FilterType":
  [
    "tasks",
    "devices",
    "events",
    "archdocs",
    "helplinks",
    "warranties",
    "policies",
    "users",
    "logs"
  ]
}

Example request body in OME-Modular

{
 "Count":8,
 "Skip":7,
 "QueryString": "device",
 "FilterType":
 [
 "tasks",
 "events",
 "devices"
  "policies",
 "users",
 "logs"
 ]
}

Example response body

{
  "took": 87,
  "timed_out": false,
  "_shards": {
    "total": 1,
    "successful": 1,
    "failed": 0
  },
  "hits":{
    "total": 11,
    "max_score": 10,
    "hits": [
      {
        "_index": "OME-Modular",
        "_type": "tasks",
        "_id": "3864",
        "_score": 1,
        "_source": {
          "tskNm": "Device_Config_Task (1493523261197) - for Device with Id: 1864",
          "tskTyp": "Device Config Task",
          "tskStatus": "Task status is Failed",
          "tskDesc": "Device_Config_Task (1493523261197) - for Device with Id: 1864",
          "tskCreatedBy": "system",
          "tskId": "3864"
        }
      }
    ]
  }
}

Table 1. AttributesThis table lists the attributes that this method supports.
Attribute name	Description
QueryString	String to search.
FilterType	Indexes to be searched for the query string.
Took	Indicates the time that is taken for the search to be completed.
Timed_out	Indicates if the search timed out.
Source	The wrapper object that encapsulates the search results based on selected filter type. This example elaborates, attributes returned for document type Task that stores Task Name, Type, Status, Description, and so on. tskNm tskTyp tskStatus tskDesc tskCreatedBy tskId