ReportGenerationConfigApiModel

{
  "$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-report-generation-config-api-model-schema.json",
  "title": "ReportGenerationConfigApiModel",
  "description": "Model for report generation configuration",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/palo-alto-networks-reports-api-openapi.yml#/components/schemas/ReportGenerationConfigApiModel",
  "properties": {
    "cloudType": {
      "description": "Cloud type",
      "enum": [
        "aws",
        "azure",
        "gcp",
        "alibaba_cloud",
        "oci"
      ],
      "type": "string"
    },
    "complianceStandardDeleted": {
      "description": "Compliance Standard Deleted",
      "readOnly": true,
      "type": "boolean"
    },
    "complianceStandardId": {
      "description": "Compliance standard ID",
      "format": "uuid",
      "readOnly": true,
      "type": "string"
    },
    "counts": {
      "allOf": [
        {
          "$ref": "#/$defs/ComplianceAggregateCount"
        },
        {
          "description": "Model for compliance aggregate count",
          "readOnly": true
        }
      ]
    },
    "createdBy": {
      "description": "User who created this report",
      "readOnly": true,
      "type": "string"
    },
    "createdOn": {
      "description": "Report created on this timestamp",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "id": {
      "description": "Report ID",
      "readOnly": true,
      "type": "string"
    },
    "lastModifiedBy": {
      "description": "Last modified by",
      "readOnly": true,
      "type": "string"
    },
    "lastModifiedOn": {
      "description": "Timestamp of last modification",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "lastScheduled": {
      "description": "Timestamp of last generated report",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "locale": {
      "description": "Locale of caller (e.g. en_us, jp). Default is en_us.",
      "type": "string"
    },
    "name": {
      "description": "Report name",
      "type": "string"
    },
    "nextSchedule": {
      "description": "Timestamp of next scheduled report",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "status": {
      "description": "Report generation status",
      "readOnly": true,
      "type": "string"
    },
    "target": {
      "allOf": [
        {
          "$ref": "#/$defs/ReportTargetModel"
        },
        {
          "description": "Report definition"
        }
      ]
    },
    "totalInstanceCount": {
      "description": "Total number of reports for the report ID",
      "format": "int32",
      "readOnly": true,
      "type": "integer"
    },
    "type": {
      "description": "Report type. Default is COMPLIANCE.",
      "enum": [
        "COMPLIANCE",
        "RIS",
        "INVENTORY_OVERVIEW",
        "INVENTORY_DETAIL"
      ],
      "type": "string"
    }
  },
  "required": [
    "cloudType",
    "name",
    "target"
  ],
  "type": "object",
  "$defs": {
    "AbsoluteTimeRangeConfigModel": {
      "allOf": [
        {
          "$ref": "#/$defs/TimeRangeConfigModel"
        },
        {
          "description": "Model for AbsoluteTimeRangeConfig",
          "properties": {
            "type": {
              "type": "string"
            },
            "value": {
              "allOf": [
                {
                  "$ref": "#/$defs/TimeModel"
                },
                {
                  "description": "Time range object"
                }
              ]
            }
          },
          "required": [
            "value"
          ],
          "type": "object"
        }
      ]
    },
    "ComplianceAggregateCount": {
      "description": "Model for compliance aggregate count",
      "properties": {
        "criticalSeverityFailed": {
          "description": "Number of critical-severity failures",
          "format": "int64",
          "readOnly": true,
          "type": "integer"
        },
        "failed": {
          "description": "Failed",
          "format": "int64",
          "readOnly": true,
          "type": "integer"
        },
        "highSeverityFailed": {
          "description": "Number of high-severity failures",
          "format": "int64",
          "readOnly": true,
          "type": "integer"
        },
        "informationalSeverityFailed": {
          "description": "Number of informational-severity failures",
          "format": "int64",
          "readOnly": true,
          "type": "integer"
        },
        "lowSeverityFailed": {
          "description": "Number of low-severity failures",
          "format": "int64",
          "readOnly": true,
          "type": "integer"
        },
        "mediumSeverityFailed": {
          "description": "Number of medium-severity failures",
          "format": "int64",
          "readOnly": true,
          "type": "integer"
        },
        "passed": {
          "description": "Passed",
          "format": "int64",
          "readOnly": true,
          "type": "integer"
        },
        "total": {
          "description": "Total",
          "format": "int64",
          "readOnly": true,
          "type": "integer"
        }
      },
      "type": "object"
    },
    "RelativeTimeDurationModel": {
      "description": "Model for RelativeTimeDuration",
      "properties": {
        "amount": {
          "description": "Number of time units",
          "format": "int32",
          "type": "integer"
        },
        "unit": {
          "description": "Time unit",
          "enum": [
            "minute",
            "hour",
            "day",
            "week",
            "month",
            "year"
          ],
          "type": "string"
        }
      },
      "type": "object"
    },
    "RelativeTimeRangeConfigModel": {
      "allOf": [
        {
          "$ref": "#/$defs/TimeRangeConfigModel"
        },
        {
          "description": "Model for RelativeTimeRangeConfig",
          "properties": {
            "relativeTimeType": {
              "description": "Direction in which to count time. Default = BACKWARD",
              "enum": [
                "BACKWARD",
                "FORWARD"
              ],
              "type": "string"
            },
            "type": {
              "type": "string"
            },
            "value": {
              "allOf": [
                {
                  "$ref": "#/$defs/RelativeTimeDurationModel"
                },
                {
                  "description": "Time range object"
                }
              ]
            }
          },
          "required": [
            "value"
          ],
          "type": "object"
        }
      ]
    },
    "ReportTargetModel": {
      "description": "Model for report target",
      "properties": {
        "accountGroups": {
          "description": "List of cloud account groups",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "accounts": {
          "description": "List of cloud accounts",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "complianceStandardIds": {
          "description": "List of compliance Standard IDs",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "compressionEnabled": {
          "description": "Business unit detailed report compression enabled",
          "type": "boolean"
        },
        "downloadNow": {
          "description": "True = download now",
          "type": "boolean"
        },
        "notificationTemplateId": {
          "description": "Notification template id",
          "readOnly": true,
          "type": "string"
        },
        "notifyTo": {
          "description": "List of email addresses to receive notification",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "regions": {
          "description": "List of regions",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "schedule": {
          "description": "Recurring report schedule in RRULE format",
          "type": "string"
        },
        "scheduleEnabled": {
          "description": "Report scheduling enabled",
          "type": "boolean"
        },
        "timeRange": {
          "allOf": [
            {
              "$ref": "#/$defs/TimeRangeConfigModel"
            },
            {
              "description": "Time range"
            }
          ]
        }
      },
      "required": [
        "timeRange"
      ],
      "type": "object"
    },
    "TimeModel": {
      "description": "Model for Time",
      "properties": {
        "endTime": {
          "description": "End timestamp",
          "format": "int64",
          "type": "integer"
        },
        "startTime": {
          "description": "Start timestamp",
          "format": "int64",
          "type": "integer"
        }
      },
      "type": "object"
    },
    "TimeRangeConfigModel": {
      "description": "See the [Time Range Model](/prisma-cloud/api/cspm/api-time-range-model) for details.\n",
      "oneOf": [
        {
          "$ref": "#/$defs/RelativeTimeRangeConfigModel"
        },
        {
          "$ref": "#/$defs/AbsoluteTimeRangeConfigModel"
        },
        {
          "$ref": "#/$defs/ToNowTimeRangeConfigModel"
        }
      ],
      "properties": {
        "type": {
          "description": "Time type",
          "type": "string"
        }
      },
      "required": [
        "type"
      ],
      "type": "object"
    },
    "ToNowTimeRangeConfigModel": {
      "allOf": [
        {
          "$ref": "#/$defs/TimeRangeConfigModel"
        },
        {
          "description": "Model for ToNowTimeRangeConfig",
          "properties": {
            "value": {
              "description": "Time range object",
              "enum": [
                "MINUTE",
                "HOUR",
                "DAY",
                "WEEK",
                "MONTH",
                "YEAR",
                "EPOCH",
                "LOGIN"
              ],
              "type": "string"
            }
          },
          "type": "object"
        }
      ]
    }
  }
}