Nutanix · Schema

ListMetadata

Request body for list operations supporting server-side filtering, sorting, and pagination.

Cloud ManagementHyperconvergedInfrastructureVirtualizationKubernetesDatabase

Properties

Name	Type	Description
kind	string	The entity kind to list.
offset	integer	Offset from the start of the entity list.
length	integer	The number of records to retrieve.
filter	string	The filter criteria in FIQL format.
sort_order	string	The sort order.
sort_attribute	string	The attribute to sort results by.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ListMetadata",
  "title": "ListMetadata",
  "type": "object",
  "description": "Request body for list operations supporting server-side filtering, sorting, and pagination.",
  "properties": {
    "kind": {
      "type": "string",
      "description": "The entity kind to list."
    },
    "offset": {
      "type": "integer",
      "description": "Offset from the start of the entity list.",
      "minimum": 0
    },
    "length": {
      "type": "integer",
      "description": "The number of records to retrieve.",
      "minimum": 1,
      "maximum": 500
    },
    "filter": {
      "type": "string",
      "description": "The filter criteria in FIQL format."
    },
    "sort_order": {
      "type": "string",
      "description": "The sort order.",
      "enum": [
        "ASCENDING",
        "DESCENDING"
      ]
    },
    "sort_attribute": {
      "type": "string",
      "description": "The attribute to sort results by."
    }
  }
}