Crystal Reports · Schema

ReportParameter

A parameter that can be set when running the report

Business IntelligenceCrystal ReportsData AnalyticsEnterprise SoftwareReportingSAP

Properties

Name Type Description
name string Parameter name
type string Data type of the parameter
prompt string Prompt text shown to the user
required boolean Whether the parameter is required
default_value string Default value for the parameter
View JSON Schema on GitHub

JSON Schema

crystal-reports-report-parameter-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/crystal-reports/refs/heads/main/json-schema/crystal-reports-report-parameter-schema.json",
  "title": "ReportParameter",
  "description": "A parameter that can be set when running the report",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Parameter name",
      "example": "StartDate"
    },
    "type": {
      "type": "string",
      "description": "Data type of the parameter",
      "example": "Date"
    },
    "prompt": {
      "type": "string",
      "description": "Prompt text shown to the user",
      "example": "Enter the start date"
    },
    "required": {
      "type": "boolean",
      "description": "Whether the parameter is required",
      "example": true
    },
    "default_value": {
      "type": "string",
      "description": "Default value for the parameter",
      "example": "2023-01-01"
    }
  }
}