GetSchema

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

Returns a report builder domain schema. Use this method to load fields, metrics, filters, options, templates, data sources and support rules for one report builder domain. 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 business errors.

Request Parameters

Name Type Required Description
domain String Required Report builder domain code, for example Nomenclature.

Request Example

{
  "domain": "Nomenclature"
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result ReportBuilderSchemaResult Result object.

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": [
      {
        "code": "firm_id",
        "value_type": "long",
        "operators": [
          "eq"
        ],
        "required_by_default": true
      }
    ]
  }
}