Skip to content

更新仪表盘部件

适用版本 >=v7.0.2603.20260326

标签多维表格

请求说明

字段
请求地址
配置域名+/openapi+/v7/dbsheet/{file_id}/dashboards/{dashboard_id}/web_extensions/update
HTTP 方法
POST
接口描述
签名方式
KSO-1(配置域名+/openapi不参与签名)
限频策略
权限要求
查询和管理多维表格(应用授权) kso.dbsheet.readwrite
查询和管理多维表格(用户授权) kso.dbsheet.readwrite

请求头 (Headers)

属性名类型是否必填描述可选值
X-Kso-Date
stringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT-
X-Kso-Authorization
stringKSO-1 签名值,详见《签名方法》-
Authorization
string授权凭证,格式为:Bearer {access_token}-

路径参数 (Path)

属性名类型是否必填描述可选值
file_id
string文件 ID-
dashboard_id
integer仪表盘 ID-

请求体(Body)

请求体格式: application/json

没有可用的数据

请求体示例

json
{
  "property_modify_list": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "statistics_module_setting": {
    "ascending": true,
    "clear_filter": true,
    "data_source_sheet_id": "string",
    "dimension_field_id": "string",
    "dimension_split_multiple": true,
    "filter_criterias_add_list": [
      {
        "criteria": {
          "op": "string",
          "values": [
            {
              "type": "string",
              "value": "string"
            }
          ]
        },
        "field_id": "string"
      }
    ],
    "filter_criterias_remove_list": [
      {
        "field_id": "string"
      }
    ],
    "filters_op": "string",
    "group_condition_field_id": "string",
    "group_limit_num": 0,
    "group_unit": "string",
    "only_count_dimension": true,
    "sort_by_row": true,
    "statistic_setting_add_list": [
      {
        "field_id": "string",
        "statistic_options": "string"
      }
    ],
    "statistic_setting_change_list": [
      {
        "new_fld_id": "string",
        "old_fld_id": "string",
        "statistic_options": "string"
      }
    ],
    "statistic_setting_remove_list": [
      {
        "field_id": "string"
      }
    ],
    "stats_limit_num": 0
  },
  "web_extension_key": "string"
}

响应体(Response)

HTTP状态码: 200
响应体格式: application/json

没有可用的数据

响应体示例

json
{
  "data": {
    "web_extension": {
      "data_source_type": "string",
      "plugin_config": "string",
      "properties": "string",
      "statistics_module": {
        "ascending": true,
        "data_source_sheet_id": "string",
        "dimension_field_id": "string",
        "group_field_id": "string",
        "id": "string",
        "only_count_dimension": true,
        "sort_by_row": true
      },
      "web_extension_key": "string",
      "web_extension_type": "string"
    }
  },
  "code": 0,
  "msg": "string"
}