GetSchema

[POST] .../v1/reportbuilder/getschema

Returns a report builder domain schema. Load fields, metrics, filters, options, templates, data sources and field combination rules for one report builder domain. Filters extend the shared FilterField contract with labels, option sources, display order and metric-source applicability. Use field, datatype, filter_type, multiple, operators and required to build inputs; datatype int represents 64-bit integer values and Date controls use Unix seconds. Required filters may also depend on selected metrics and fields; Validate returns the effective required_filters list. Option metadata includes execution_status, scope and numeric min_value/max_value. Use Validate availability to decide which controls to show for the current draft. The method returns the selected domain schema without creating a report request. The caller must have report-builder permission 759 and an account tariff with report builder enabled; missing body, denied access, unavailable tariff, missing domain, builder service connectivity errors or unsupported domains are returned as HTTP 200 ErrorResult.

Request Parameters

Request Example

{
  "domain": "Nomenclature"
}

Response Parameters

Response Example

{
  "ok": true,
  "result": {
    "schema_version": 1,
    "domain": {
      "code": "Nomenclature",
      "title_key": "report_builder_domain_nomenclature",
      "enabled": true
    },
    "fields": [
      {
        "code": "item.name",
        "title_key": "report_builder_field_item_name",
        "entity": "item",
        "entity_title_key": "app_item",
        "entity_title": "Nomenclature",
        "value_type": "string",
        "roles": [
          "row_group",
          "row_column"
        ]
      }
    ],
    "metrics": [
      {
        "code": "stock_balance.current_quantity",
        "title_key": "report_builder_metric_stock_balance_current_quantity",
        "metric_source": "StockBalance",
        "value_type": "decimal"
      }
    ],
    "filters": [
      {
        "field": "firm_id",
        "datatype": "int",
        "filter_type": "Reference",
        "multiple": false,
        "operators": [
          "Equal"
        ],
        "required": true
      }
    ]
  }
}