NSX-T Data Center REST API

IpfixUpmProfileListParameters (type)

{
  "description": "Query parameters for IPFIX profile list", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "IpfixUpmProfileListParameters", 
  "module_id": "UpmIpfix", 
  "properties": {
    "applied_to_entity_id": {
      "description": "The entity ID works as a filter param. Entity ID and entity type should be both provided or not at a query.", 
      "readonly": false, 
      "required": false, 
      "title": "ID of Entity Applied with Profile", 
      "type": "string"
    }, 
    "applied_to_entity_type": {
      "$ref": "UpmEntityType, 
      "description": "The entity type works as a filter param. Enumerated value in UpmEntityType could be used here. Entity ID and entity type should be both provided or not at a query.", 
      "readonly": false, 
      "required": false, 
      "title": "Type of Entity Applied with Profile"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "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"
    }, 
    "profile_types": {
      "description": "An English comma-separated list of profile types. Enumerated value in IpfixUpmProfileType could be listed here as a filter param.", 
      "required": false, 
      "title": "IPFIX Profile Type List", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "IPFIX Profile List Parameters", 
  "type": "object"
}