{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/thomson-reuters/json-schema/thomson-reuters-report-options-with-filters-model-schema.json",
  "title": "ReportOptionsWithFiltersModel",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/thomson-reuters-reports-api-openapi.yml#/components/schemas/ReportOptionsWithFiltersModel",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "description": "The ID of the saved report to run.",
      "format": "int32"
    },
    "pdfFontSize": {
      "type": "integer",
      "description": "The font size to use when the output format is PDF.",
      "format": "int32"
    },
    "pdfHeaderIncludeName": {
      "type": "boolean",
      "description": "Indicates whether to include report name into PDF header."
    },
    "pdfHeaderIncludeDate": {
      "type": "boolean",
      "description": "Indicates whether to include date into PDF header."
    },
    "pdfHeaderIncludePageNumber": {
      "type": "boolean",
      "description": "Indicates whether to include page numbering into PDF header."
    },
    "pdfFooterIncludeName": {
      "type": "boolean",
      "description": "Indicates whether to include report name into PDF footer."
    },
    "pdfFooterIncludeDate": {
      "type": "boolean",
      "description": "Indicates whether to include date into PDF footer."
    },
    "pdfFooterIncludePageNumber": {
      "type": "boolean",
      "description": "Indicates whether to include page numbering into PDF footer."
    },
    "excelApplyRounding": {
      "type": "boolean",
      "description": "Indicates whether applied rounding currency values into Excel or not."
    },
    "pdfCustomHeader": {
      "type": [
        "string",
        "null"
      ],
      "description": "Text of the custom header for PDF. Can override report name, date or page number in headers."
    },
    "pdfCustomHeaderAlignment": {
      "description": "Alignment that can be used for cells",
      "$ref": "#/$defs/CustomLabelAlignment"
    },
    "pdfCustomFooter": {
      "type": [
        "string",
        "null"
      ],
      "description": "Text of the custom footer for PDF. Can override report name, date or page number in footers."
    },
    "pdfCustomFooterAlignment": {
      "description": "Alignment that can be used for cells",
      "$ref": "#/$defs/CustomLabelAlignment"
    },
    "pdfPageOrientation": {
      "description": "Page orientation for exported file",
      "$ref": "#/$defs/PageOrientation"
    },
    "pdfCommonCustomMargin": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The margin that set to all sides of pages\nIf some of the custom margins have been set, a common margin is set for all others sides",
      "format": "int32"
    },
    "pdfCustomLeftMargin": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The margins that can be set to the left of the page",
      "format": "int32"
    },
    "pdfCustomTopMargin": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The margins that can be set to the top of the page",
      "format": "int32"
    },
    "pdfCustomRightMargin": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The margins that can be set to the right of the page",
      "format": "int32"
    },
    "pdfCustomBottomMargin": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The margins that can be set to the bottom of the page",
      "format": "int32"
    },
    "pdfCustomCellAlignment": {
      "description": "Alignment that can be used for cells",
      "$ref": "#/$defs/CustomLabelAlignment"
    },
    "pdfHeaderFormat": {
      "description": "Header/footer format",
      "$ref": "#/$defs/HeaderFooterFormat"
    },
    "pdfFooterFormat": {
      "description": "Header/footer format",
      "$ref": "#/$defs/HeaderFooterFormat"
    },
    "csvDelimiter": {
      "$ref": "#/$defs/CSVDelimiter"
    },
    "filters": {
      "type": [
        "array",
        "null"
      ],
      "description": "The list of filters that should be updated\n            ",
      "items": {
        "$ref": "#/$defs/FilterModel"
      }
    },
    "advancedFilter": {
      "type": [
        "string",
        "null"
      ],
      "description": "Updated advanced filter that should be applied to the report"
    }
  },
  "$defs": {
    "CSVDelimiter": {
      "type": "string",
      "description": "",
      "x-enumNames": [
        "Null",
        "Comma",
        "Asterisk",
        "Pipe",
        "Tilde",
        "Semicolon"
      ],
      "enum": [
        "Null",
        "Comma",
        "Asterisk",
        "Pipe",
        "Tilde",
        "Semicolon"
      ]
    },
    "CustomLabelAlignment": {
      "type": "string",
      "description": "",
      "x-enumNames": [
        "Default",
        "Left",
        "Center",
        "Right"
      ],
      "enum": [
        "Default",
        "Left",
        "Center",
        "Right"
      ]
    },
    "FilterModel": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "filterId",
        "params"
      ],
      "properties": {
        "filterId": {
          "type": "string",
          "description": "Filter unique id",
          "minLength": 1
        },
        "params": {
          "type": "array",
          "description": "List of updated parameters for filter. \nUse filter-definitions/{id} endpoint in order to find description of each parameter. ",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "HeaderFooterFormat": {
      "type": "string",
      "description": "",
      "x-enumNames": [
        "Standard",
        "Branded"
      ],
      "enum": [
        "Standard",
        "Branded"
      ]
    },
    "PageOrientation": {
      "type": "string",
      "description": "",
      "x-enumNames": [
        "Landscape",
        "Portrait"
      ],
      "enum": [
        "Landscape",
        "Portrait"
      ]
    }
  }
}