文档中心
搜索
Ask AI
全部文档
文档中心开发者中心API 文档维度

维度

本文档说明维度组件对外开放的常用接口，适用于外部系统查询维度成员、按表达式取数，以及通过接口进行维度成员维护。

成员查询

表达式查询维度成员

用于通过维度表达式查询成员，适合按 Children、Descendant、Base 等表达式获取成员范围。

请求

项目

值

HTTP Method

POST

Path

https://xxxx.com/deepfos-server/dimension-server1-2/dimension/query/select-dimension-member-by-name-function

Request Body 字段

字段名

类型

必填

说明

folderId

String

否

维度所在目录 ID，与 path 二选一

reverse_order

String

否

返回顺序控制

path

String

否

维度所在路径，与 folderId 二选一

resultString

String

是

返回字段列表，多个字段用逗号分隔

dimensionMemberNames

String

是

维度表达式

outFormat

String

否

输出格式

useDefaultRoleScheme

Boolean

否

是否使用默认权限方案

rsName

String

否

权限方案名称

roleFolderId

String

否

权限方案目录 ID

rolePath

String

否

权限方案路径

rsMapping

Integer

否

权限映射方式

role

String

否

角色名称

rolegroup

String

否

角色组名称

ignoreIllegalMember

Boolean

否

是否忽略非法成员

duplicate

String

否

是否去重

multiEntityConfigSearchDTOList

Array

否

多实体配置参数

multiEntityConfigSearchDTOList[].year

String

否

年度

multiEntityConfigSearchDTOList[].period

String

否

期间

multiEntityConfigSearchDTOList[].scenario

String

否

场景

multiEntityConfigSearchDTOList[].version

String

否

版本

Request Body 示例

Copy
{
  "folderId": "100",
  "reverse_order": "0",
  "path": "/demo",
  "resultString": "name,description",
  "dimensionMemberNames": "Children(A,0)",
  "outFormat": "list",
  "useDefaultRoleScheme": true,
  "rsName": "",
  "roleFolderId": "",
  "rolePath": "",
  "rsMapping": 0,
  "role": "",
  "rolegroup": "",
  "ignoreIllegalMember": true,
  "duplicate": "0",
  "multiEntityConfigSearchDTOList": [
    {
      "year": "2024",
      "period": "P01",
      "scenario": "Actual",
      "version": "V1"
    }
  ]
}

响应

响应体字段

字段名

类型

说明

code

Integer

响应码

message

String

响应消息

data

Array

返回的成员列表

data[].name

String

成员名称

data[].description

String

成员描述

响应示例

Copy
{
  "code": 0,
  "message": "success",
  "data": [
    {
      "name": "A01",
      "description": "华东区"
    },
    {
      "name": "A02",
      "description": "华南区"
    }
  ]
}

成员保存

树形增量变更保存

用于树形视图下的成员新增、修改、删除、移动等增量维护场景，适合日常层级结构调整。

请求

项目

值

HTTP Method

POST

Path

https://xxxx.com/deepfos-server/dimension-server1-2/dimension-save/dimension-member-change-save

Request Body 字段

字段名

类型

必填

说明

dimensionInfo

Object

是

维度基础信息

dimensionInfo.name

String

是

维度名称

dimensionInfo.folderId

String

否

维度所在目录 ID

dimensionInfo.path

String

否

维度所在路径

dimensionInfo.isOnlyCheck

String

否

是否只校验不保存

dimensionMemberList

Array

是

变更成员列表

dimensionMemberList[].operation

String

是

操作类型，如 add、update、delete

dimensionMemberList[].originName

String

否

原成员名称，更新时传入

dimensionMemberList[].name

String

是

成员名称

dimensionMemberList[].parentName

String

否

父成员名称

dimensionMemberList[].description

String

否

成员描述

dimensionMemberList[].isBase

Boolean

否

是否叶子成员

dimensionMemberList[].isActive

Boolean

否

是否启用

Request Body 示例

Copy
{
  "dimensionInfo": {
    "name": "org",
    "folderId": "100",
    "path": "/demo",
    "isOnlyCheck": "0"
  },
  "dimensionMemberList": [
    {
      "operation": "add",
      "name": "A01",
      "parentName": "A",
      "description": "华北区组织",
      "isBase": true,
      "isActive": true
    },
    {
      "operation": "update",
      "originName": "A02",
      "name": "A02",
      "parentName": "A",
      "description": "更新后的描述"
    },
    {
      "operation": "delete",
      "name": "A03"
    }
  ]
}

响应

响应体字段

字段名

类型

说明

code

Integer

响应码

message

String

响应消息

data

Object

保存结果

data.success

Boolean

是否保存成功

data.changedCount

Integer

成功变更条数

data.failedCount

Integer

失败条数

响应示例

Copy
{
  "code": 0,
  "message": "success",
  "data": {
    "success": true,
    "changedCount": 3,
    "failedCount": 0
  }
}

表格保存维度成员信息

用于表格视图下的批量维护，支持全量和增量两种模式，适合批量导入、批量修订和整体重建场景。

请求

项目

值

HTTP Method

POST

Path

https://xxxx.com/deepfos-server/dimension-server1-2/dimension/member/save-dimension-member

Request Body 字段

字段名

类型

必填

说明

dimensionName

String

是

维度名称

folderId

String

否

维度所在目录 ID，与 path 二选一

path

String

否

维度所在路径，与 folderId 二选一

increment

String

是

保存模式，0 表示全量，1 表示增量

dimensionMemberList

Array

是

成员列表

dimensionMemberList[].parent_name

String

否

父成员名称

dimensionMemberList[].name

String

是

成员名称

dimensionMemberList[].aggweight

Number

否

聚合权重

dimensionMemberList[].sharedmember

Boolean

否

是否共享成员

dimensionMemberList[].description_zh_cn

String

否

中文描述

dimensionMemberList[].description_en

String

否

英文描述

dimensionMemberList[].ud1

String

否

自定义属性 1

dimensionMemberList[].ud2

String

否

自定义属性 2

Request Body 示例

Copy
{
  "dimensionName": "org",
  "folderId": "100",
  "path": "/demo",
  "increment": "1",
  "dimensionMemberList": [
    {
      "parent_name": "A",
      "name": "A01",
      "aggweight": 1.0,
      "sharedmember": false,
      "description_zh_cn": "华东区组织",
      "description_en": "East China Region",
      "ud1": "区域编码001",
      "ud2": "负责人张三"
    },
    {
      "parent_name": "A",
      "name": "A02",
      "aggweight": 1.0,
      "sharedmember": false,
      "description_zh_cn": "华南区组织",
      "description_en": "South China Region",
      "ud1": "区域编码002",
      "ud2": "负责人李四"
    }
  ]
}

响应

响应体字段

字段名

类型

说明

code

Integer

响应码

message

String

响应消息

data

Object

保存结果

data.success

Boolean

是否保存成功

data.dimensionName

String

维度名称

data.increment

Integer

实际保存模式

响应示例

Copy
{
  "code": 0,
  "message": "success",
  "data": {
    "success": true,
    "dimensionName": "org",
    "increment": 1
  }
}

关键字段说明

字段

说明

dimensionName

维度名称

increment

保存模式，0 表示全量，1 表示增量

dimensionMemberList

成员列表

name

成员编码或名称

parent_name

父成员编码或名称

ud1 ~ ud60

自定义属性字段

使用说明

保存接口选择建议

  • 如需处理新增、删除、移动、局部结构调整，建议使用：

    • https://xxxx.com/deepfos-server/dimension-server1-2/dimension-save/dimension-member-change-save

  • 如需批量导入、全量替换、批量增量更新，建议使用：

    • https://xxxx.com/deepfos-server/dimension-server1-2/dimension/member/save-dimension-member

查询接口选择建议

  • 查询表达式结果：

    • https://xxxx.com/deepfos-server/dimension-server1-2/dimension/query/select-dimension-member-by-name-function

对接提示

  • 维度存在层级关系时，建议保证父节点先于子节点处理。

  • 增量模式适合新增成员或局部修订，全量模式适合成员结构整体重建。

  • 如数据源无法保证父子顺序，建议在外部系统或同步流程中先完成排序后再提交。

  • 成员删除、移动、重挂接可能影响下游模型、报表及权限使用。

  • 如需更完整的治理能力，建议由外部维护模块承载审批、日志与发布控制，再同步至先胜云。

上一篇：变量
下一篇：财务模型
本页目录

回到顶部

咨询热线

400-821-9199

我们使用 ChatGPT，基于文档中心的内容以及对话上下文回答您的问题。

ctrl+Enter to send

© 2022 先胜云. All Rights Reserved.