NSX-T Data Center Global Manager REST API

UpgradeUnitAggregateInfoListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "UpgradeUnitAggregateInfoListRequestParameters", 
  "module_id": "Upgrade", 
  "properties": {
    "component_type": {
      "readonly": false, 
      "required": false, 
      "title": "Component type based on which upgrade units to be filtered", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "group_id": {
      "readonly": false, 
      "required": false, 
      "title": "Identifier of group based on which upgrade units to be filtered", 
      "type": "string"
    }, 
    "has_errors": {
      "default": false, 
      "readonly": false, 
      "required": false, 
      "title": "Flag to indicate whether to return only upgrade units with errors", 
      "type": "boolean"
    }, 
    "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"
    }, 
    "metadata": {
      "readonly": false, 
      "required": false, 
      "title": "Metadata about upgrade unit to filter on", 
      "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"
    }, 
    "selection_status": {
      "default": "ALL", 
      "enum": [
        "SELECTED", 
        "DESELECTED", 
        "ALL"
      ], 
      "required": false, 
      "title": "Flag to indicate whether to return only selected, only deselected or both type of upgrade units", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "upgrade_unit_display_name": {
      "description": "Display name of upgrade unit to filter the results on. String matching for the filter is case-insensitive.", 
      "readonly": false, 
      "required": false, 
      "title": "Display name of upgrade unit", 
      "type": "string"
    }
  }, 
  "type": "object"
}