NSX-T Data Center REST API

AdditionalSearchParameters (type)

{
  "additionalProperties": false, 
  "description": "This object presents additional search capabilities over any API through free text query string. e.g. query=\"Web-VM-1\".", 
  "experimental": true, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "AdditionalSearchParameters", 
  "module_id": "PolicyRealizedState", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "dsl": {
      "description": "It's human readable and context-based query language for retreiving information from search indices. For example: Find router where ip is 10.10.1.10", 
      "required": false, 
      "title": "Search DSL (domain specific language) query", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "query": {
      "required": false, 
      "title": "Search query", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Represents search object that provides additional search capabilities", 
  "type": "object"
}