NSX-T Data Center Global Manager REST API

UpgradeCheckFailureListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "UpgradeCheckFailureListRequestParameters", 
  "module_id": "Upgrade", 
  "properties": {
    "component_type": {
      "description": "Component type on which upgrade check failures are to be filtered", 
      "readonly": false, 
      "required": false, 
      "title": "Component type", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "filter_text": {
      "description": "Text to filter the results on. The filter text is matched with origin name and failure message. String matching for the filter is case-insensitive.", 
      "readonly": false, 
      "required": false, 
      "title": "Filter text", 
      "type": "string"
    }, 
    "group_id": {
      "description": "Group id for filter to be applied.", 
      "readonly": false, 
      "required": false, 
      "title": "Filter on the group id", 
      "type": "string"
    }, 
    "group_name": {
      "description": "Group name for filter to be applied.", 
      "readonly": false, 
      "required": false, 
      "title": "Filter on the group name", 
      "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"
    }, 
    "needs_ack": {
      "description": "Filter based on if acknowledgement is required.", 
      "readonly": false, 
      "required": false, 
      "title": "Filter based on acknowledgement required", 
      "type": "boolean"
    }, 
    "origin_type": {
      "description": "Type of origin of pre/post-upgrade check failure", 
      "enum": [
        "COMPONENT", 
        "UPGRADE_UNIT"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Type of origin of failure", 
      "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"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "type": {
      "description": "Status of the pre/post-upgrade check to filter the results on", 
      "enum": [
        "FAILURE", 
        "WARNING"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Status of the upgrade check", 
      "type": "string"
    }, 
    "unit_id": {
      "description": "Unit id for filter to be applied.", 
      "readonly": false, 
      "required": false, 
      "title": "Filter on the unit id", 
      "type": "string"
    }, 
    "unit_name": {
      "description": "Unit name for filter to be applied.", 
      "readonly": false, 
      "required": false, 
      "title": "Filter on the unit name", 
      "type": "string"
    }
  }, 
  "type": "object"
}