ActionPlanApiRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/main/json-schema/palo-alto-networks-action-plan-api-request-schema.json",
  "title": "ActionPlanApiRequest",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/palo-alto-networks-action-plan-management-apis-api-openapi.yml#/components/schemas/ActionPlanApiRequest",
  "properties": {
    "limit": {
      "format": "int64",
      "type": "integer"
    },
    "nextPageToken": {
      "type": "string"
    },
    "filters": {
      "description": "List of filters that can be applied for the API",
      "type": "array",
      "items": {
        "$ref": "#/$defs/Filter"
      }
    },
    "sortBy": {
      "$ref": "#/$defs/SortBy"
    }
  },
  "$defs": {
    "ActionPlanFilter": {
      "enum": [
        "status",
        "assignee",
        "finding.type",
        "id",
        "business.criticality"
      ],
      "type": "string"
    },
    "Filter": {
      "type": "object",
      "properties": {
        "name": {
          "description": "Name of the allowed Filter types. Allowed names: [status, assignee, id, finding type, asset type, name]",
          "type": "string",
          "allOf": [
            {
              "$ref": "#/$defs/ActionPlanFilter"
            }
          ]
        },
        "operator": {
          "description": "Only allowed operator for the filter is '='",
          "type": "string"
        },
        "value": {
          "description": "Value for the applied filter",
          "type": "string"
        }
      }
    },
    "SortBy": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "allOf": [
            {
              "$ref": "#/$defs/SortField"
            }
          ]
        },
        "order": {
          "type": "string",
          "allOf": [
            {
              "$ref": "#/$defs/SortDirection"
            }
          ]
        }
      }
    },
    "SortDirection": {
      "enum": [
        "desc",
        "asc"
      ]
    },
    "SortField": {
      "enum": [
        "criticality",
        "alertCount",
        "assetCount"
      ]
    }
  }
}