公共维度

资源说明

公共维度用于在应用内复用一组通用的分析维度配置。可将多个数据集中的字段设置为同名的公共维度，便于统一筛选与下钻。

公共维度结构说明（CommonDimensionDto）

字段	类型	描述
name	STRING	公共维度名称，必填
description	STRING	公共维度描述
relatedDatasetFields	OBJECT 数组	关联到该公共维度的字段列表
relatedDatasetFields[].appId	LONG	应用 ID
relatedDatasetFields[].datasetId	LONG	数据集 ID
relatedDatasetFields[].fieldName	STRING	字段名

接口说明

获取应用内的公共维度列表

请求URL

GET /api/apps/{appId}/common-dimensions HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数

URL 参数

字段	类型	是否必须	说明
appId	LONG	是	应用 ID
name	STRING	否	按名称精确过滤（可选）

返回对象的格式说明

字段	类型	说明
version	STRING	当前系统版本哈希值
data	OBJECT 数组	公共维度列表，见上文“公共维度结构说明”

接口示例

Request

GET /api/apps/119287/common-dimensions?name=地区 HTTP/1.1
Accept: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

Response

HTTP/1.1 200 Ok
Content-Type: application/json

{
  "version": "version@9a5e106#6730f0d",
  "code": 0,
  "msg": "success",
  "data": [
    {
      "name": "地区",
      "relatedDatasetFields": [
        { "appId": 119287, "datasetId": 7, "fieldName": "省/自治区" },
        { "appId": 119287, "datasetId": 7, "fieldName": "城市" }
      ]
    }
  ]
}

创建应用内的公共维度

请求URL

POST /api/apps/{appId}/common-dimensions HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数

request body 请求体

见上文“公共维度结构说明（CommonDimensionDto）”。字段要求：name 必填。公共维度在本应用中不能存在。

返回对象的格式说明

字段	类型	说明
version	STRING	当前系统版本哈希值
data	OBJECT	公共维度对象（创建或更新后的结果）

接口示例

Request

POST /api/apps/119287/common-dimensions HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

// Request Body:
{
  "name": "地区",
  "relatedDatasetFields": [
    { "appId": 119287, "datasetId": 7, "fieldName": "省/自治区" },
    { "appId": 119287, "datasetId": 7, "fieldName": "城市" }
  ]
}

Response

HTTP/1.1 200 Ok
Content-Type: application/json

{
  "version": "version@9a5e106#6730f0d",
  "code": 0,
  "msg": "success",
  "data": {
    "name": "地区",
    "relatedDatasetFields": [
      { "appId": 119287, "datasetId": 7, "fieldName": "省/自治区" },
      { "appId": 119287, "datasetId": 7, "fieldName": "城市" }
    ]
  }
}

::::

更新应用内的公共维度

请求URL

PUT /api/apps/{appId}/common-dimensions HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

请求参数

request body 请求体

见上文“公共维度结构说明（CommonDimensionDto）”。字段要求：name 必填。公共维度在本应用中必须存在。

返回对象的格式说明

字段	类型	说明
version	STRING	当前系统版本哈希值
data	OBJECT	公共维度对象（创建或更新后的结果）

接口示例

Request

POST /api/apps/119287/common-dimensions HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

// Request Body:
{
  "name": "地区",
  "relatedDatasetFields": [
    { "appId": 119287, "datasetId": 7, "fieldName": "省/自治区" },
    { "appId": 119287, "datasetId": 7, "fieldName": "城市" }
  ]
}

Response

HTTP/1.1 200 Ok
Content-Type: application/json

{
  "version": "version@9a5e106#6730f0d",
  "code": 0,
  "msg": "success",
  "data": {
    "name": "地区",
    "relatedDatasetFields": [
      { "appId": 119287, "datasetId": 7, "fieldName": "省/自治区" },
      { "appId": 119287, "datasetId": 7, "fieldName": "城市" }
    ]
  }
}

删除应用内的公共维度

请求URL

DELETE /api/apps/{appId}/common-dimensions HTTP/1.1

请求参数

URL 参数

字段	类型	是否必须	说明
appId	LONG	是	应用 ID
name	STRING	是	要删除的公共维度名称

返回对象的格式说明

字段	类型	说明
version	STRING	当前系统版本哈希值
data	INTEGER	删除的关联字段条数（或受影响条数）

接口示例

Request

DELETE /api/apps/119287/common-dimensions?name=地区 HTTP/1.1
Content-Type: application/json
Cookie: csrf=183f1c4...; sid=26ee552d...; _USER_SESSION_ID=f2a01083...

Response

HTTP/1.1 200 Ok
Content-Type: application/json

{
  "version": "version@9a5e106#6730f0d",
  "code": 0,
  "msg": "success",
  "data": 2
}