Crystal Reports · JSON Structure

Crystal Reports Report Parameter Structure

A parameter that can be set when running the report

Type: object Properties: 5
Business IntelligenceCrystal ReportsData AnalyticsEnterprise SoftwareReportingSAP

ReportParameter is a JSON Structure definition published by Crystal Reports, describing 5 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

name type prompt required default_value

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/crystal-reports/refs/heads/main/json-structure/crystal-reports-report-parameter-structure.json",
  "name": "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"
    }
  }
}