腾讯云 BI 数据结构

ApiDatasourceConfig

API数据源连接配置

被如下接口引用：CreateDataTable。

名称	类型	必选	描述
FieldsJsonData	String	否	API数据源解析结果注意：此字段可能返回 null，表示取不到有效值。示例值：1
ConnectionType	Integer	否	连接类型1:直连 2:抽取注意：此字段可能返回 null，表示取不到有效值。示例值：1
FrequencyConfig	FrequencyConfig	否	抽取频率配置注意：此字段可能返回 null，表示取不到有效值。
Url	String	否	请求URL 注意：此字段可能返回 null，表示取不到有效值。示例值：1
RequestMethod	Integer	否	1:GET 2:POST 注意：此字段可能返回 null，表示取不到有效值。示例值：1
RequestHeader	String	否	请求头注意：此字段可能返回 null，表示取不到有效值。示例值：1
RequestParams	String	否	请求参数注意：此字段可能返回 null，表示取不到有效值。示例值：1
RequestBody	String	否	请求体注意：此字段可能返回 null，表示取不到有效值。示例值：1
UserName	String	否	用户名注意：此字段可能返回 null，表示取不到有效值。示例值：name
Password	String	否	密码注意：此字段可能返回 null，表示取不到有效值。示例值：passwd
AuthorizationType	Integer	否	1: 无鉴权 2:BASIC_AUTH 注意：此字段可能返回 null，表示取不到有效值。示例值：1
TableId	Integer	否	表id 注意：此字段可能返回 null，表示取不到有效值。示例值：1
JsonPathDbNameMap	String	否	路径DbName映射注意：此字段可能返回 null，表示取不到有效值。示例值：1
AuthApi	String	否	鉴权API 注意：此字段可能返回 null，表示取不到有效值。示例值：1
AppKey	String	否	应用Key 注意：此字段可能返回 null，表示取不到有效值。示例值：1
AppSecret	String	否	应用密钥注意：此字段可能返回 null，表示取不到有效值。示例值：1
SecretKey	String	否	数据密钥Key 注意：此字段可能返回 null，表示取不到有效值。示例值：1
SecretIv	String	否	数据密钥初始化向量注意：此字段可能返回 null，表示取不到有效值。示例值：1

ApiKeyAuthApplyVO

创建ApiKey接口出参

被如下接口引用：CreateAuthApiKey, DescribeAuthApiKeyInfo, DescribeAuthApiKeyList, ModifyAuthApiKey。

名称	类型	描述
Id	Integer	id 注意：此字段可能返回 null，表示取不到有效值。示例值：10001009
CorpId	String	企业id 注意：此字段可能返回 null，表示取不到有效值。示例值：700000231283
ApiKey	String	apiKey 注意：此字段可能返回 null，表示取不到有效值。示例值：5e1e693f6e13497691fece0373d3e88c
DefaultUser	String	默认用户注意：此字段可能返回 null，表示取不到有效值。示例值：700000231283
CreatedUser	String	创建人注意：此字段可能返回 null，表示取不到有效值。示例值：700000280185
CreatedAt	String	创建时间注意：此字段可能返回 null，表示取不到有效值。示例值：2025-10-16 16:51:38
UpdatedUser	String	更新人注意：此字段可能返回 null，表示取不到有效值。示例值：700000280185
UpdatedAt	String	更新时间注意：此字段可能返回 null，表示取不到有效值。示例值：2025-10-16 16:51:38

ApiKeyAuthApplyVOList

ApiKey列表

被如下接口引用：DescribeAuthApiKeyList。

名称	类型	描述
Total	Integer	总数注意：此字段可能返回 null，表示取不到有效值。示例值：1
TotalPages	Integer	页数注意：此字段可能返回 null，表示取不到有效值。示例值：1
List	Array of ApiKeyAuthApplyVO	列表数据注意：此字段可能返回 null，表示取不到有效值。

ApplyEmbedTokenInfo

申请Token延期

被如下接口引用：ApplyEmbedInterval。

名称	类型	描述
Result	Boolean	申请结果注意：此字段可能返回 null，表示取不到有效值。示例值：false

BaseStateAction

列表查询返回的每条记录的操作属性

被如下接口引用：DescribeDatasourceList。

名称	类型	必选	描述
ShowEdit	Boolean	否	编辑是否可见注意：此字段可能返回 null，表示取不到有效值。示例值：true
IsEdit	Boolean	否	编辑是否可点击注意：此字段可能返回 null，表示取不到有效值。示例值：true
EditText	String	否	编辑按钮的文本注意：此字段可能返回 null，表示取不到有效值。示例值：编辑
EditTips	String	否	编辑不可用时的提示文本注意：此字段可能返回 null，表示取不到有效值。示例值：编辑提示
ShowDel	Boolean	否	删除是否可见注意：此字段可能返回 null，表示取不到有效值。示例值：true
IsDel	Boolean	否	删除是否可点击注意：此字段可能返回 null，表示取不到有效值。示例值：true
DelText	String	否	删除按钮的文本注意：此字段可能返回 null，表示取不到有效值。示例值：删除
DelTips	String	否	删除不可用时的提示文本注意：此字段可能返回 null，表示取不到有效值。示例值：删除提示
ShowCopy	Boolean	否	复制是否可见注意：此字段可能返回 null，表示取不到有效值。示例值：true
ShowView	Boolean	否	是否可见注意：此字段可能返回 null，表示取不到有效值。示例值：true
ShowRename	Boolean	否	是否可重命名注意：此字段可能返回 null，表示取不到有效值。示例值：true

CorpUserListData

企业用户列表

被如下接口引用：DescribeUserProjectList。

名称	类型	描述
List	Array of UserIdAndUserName	列表注意：此字段可能返回 null，表示取不到有效值。示例值：1
Total	Integer	总数示例值：1
TotalPages	Integer	页数示例值：1

CreateTagTableVO

创建标签表出参

被如下接口引用：CreateTagTable。

名称	类型	描述
Id	Integer	标签表id 注意：此字段可能返回 null，表示取不到有效值。

Data

数据

被如下接口引用：CreateProject。

名称	类型	描述
Id	Integer	项目Id 示例值：1
EditUrl	String	url 注意：此字段可能返回 null，表示取不到有效值。示例值：http://

DataId

数据ID

被如下接口引用：CreateCorpTag, CreateUserRole, CreateUserRoleProject。

名称	类型	描述
Id	Integer	数据id 注意：此字段可能返回 null，表示取不到有效值。示例值：1

DatasourceInfo

数据源详情

被如下接口引用：DescribeDatasourceList。

名称	类型	描述
Id	Integer	数据库ID 示例值：1
DbName	String	数据库名称示例值：1
ServiceType	String	域类型，1、腾讯云，2、本地注意：此字段可能返回 null，表示取不到有效值。示例值：1
SourceName	String	数据库别名示例值：1
DbType	String	数据库驱动示例值：1
DbHost	String	HOST 示例值：1
DbPort	Integer	端口示例值：1
DbUser	String	用户名示例值：1
Charset	String	数据库编码示例值：1
CreatedAt	String	创建时间示例值：1
UpdatedAt	String	修改时间示例值：1
CreatedUser	String	创建人注意：此字段可能返回 null，表示取不到有效值。示例值：1
Catalog	String	catalog值注意：此字段可能返回 null，表示取不到有效值。示例值：presto catalog
ConnectType	String	连接类型注意：此字段可能返回 null，表示取不到有效值。示例值：JDBC
ProjectId	String	项目id 注意：此字段可能返回 null，表示取不到有效值。示例值：1101
Desc	String	数据源描述注意：此字段可能返回 null，表示取不到有效值。示例值：数据源建表信息
Status	String	数据源状态注意：此字段可能返回 null，表示取不到有效值。示例值：SUCESS
SourcePlat	String	来源平台注意：此字段可能返回 null，表示取不到有效值。示例值：1
ExtraParam	String	扩展参数注意：此字段可能返回 null，表示取不到有效值。示例值：{"xx":"sasd"}
AddInfo	String	额外信息注意：此字段可能返回 null，表示取不到有效值。示例值：1
ProjectName	String	项目名字注意：此字段可能返回 null，表示取不到有效值。示例值：bi项目
EngineType	String	引擎类型注意：此字段可能返回 null，表示取不到有效值。示例值：1
Manager	String	数据源负责人注意：此字段可能返回 null，表示取不到有效值。示例值：1
OperatorWhitelist	String	特定操作人员白名单注意：此字段可能返回 null，表示取不到有效值。示例值：1
VpcId	String	数据源的vpc信息注意：此字段可能返回 null，表示取不到有效值。示例值：1
UniqVpcId	String	数据源的uniqVpc信息注意：此字段可能返回 null，表示取不到有效值。示例值：11
RegionId	String	数据源的地域信息注意：此字段可能返回 null，表示取不到有效值。示例值：gz
StateAction	BaseStateAction	操作属性注意：此字段可能返回 null，表示取不到有效值。示例值：add
UpdatedUser	String	更新人注意：此字段可能返回 null，表示取不到有效值。示例值：zhangsan
PermissionList	Array of PermissionGroup	权限列表注意：此字段可能返回 null，表示取不到有效值。
AuthList	Array of String	权限值列表注意：此字段可能返回 null，表示取不到有效值。示例值：["bi_datasource_read","bi_datasource_write"]
DataOrigin	String	第三方数据源标识注意：此字段可能返回 null，表示取不到有效值。示例值：1
DataOriginProjectId	String	第三方项目id 注意：此字段可能返回 null，表示取不到有效值。示例值：1101
DataOriginDatasourceId	String	第三方数据源id 注意：此字段可能返回 null，表示取不到有效值。示例值：110101
ClusterId	String	集群id 注意：此字段可能返回 null，表示取不到有效值。示例值：1
DbTypeName	String	数据源名称注意：此字段可能返回 null，表示取不到有效值。示例值：Mysql
UseVPC	Boolean	开启vpc 注意：此字段可能返回 null，表示取不到有效值。示例值：true
Owner	String	所属人ID 注意：此字段可能返回 null，表示取不到有效值。示例值：test_user
OwnerName	String	所属人名称注意：此字段可能返回 null，表示取不到有效值。示例值：测试用户
Schema	String	数据库schema 注意：此字段可能返回 null，表示取不到有效值。示例值：DB2INST1
DbVersion	String	数据库版本注意：此字段可能返回 null，表示取不到有效值。示例值：11.5

DatasourceInfoData

数据源详情列表

被如下接口引用：DescribeDatasourceList。

名称	类型	描述
List	Array of DatasourceInfo	数据源详情列表注意：此字段可能返回 null，表示取不到有效值。示例值：{"Id": 1}
Total	Integer	总数注意：此字段可能返回 null，表示取不到有效值。示例值：1
TotalPages	Integer	总页数注意：此字段可能返回 null，表示取不到有效值。示例值：1

DescribeUserGroupMemberPageListContainer

查询页面列表

被如下接口引用：DescribeUserGroupMemberList, QueryUserGroupMember。

名称	类型	描述
List	Array of UserGroupMemberVO	列表数据集合注意：此字段可能返回 null，表示取不到有效值。
Total	Integer	总数注意：此字段可能返回 null，表示取不到有效值。
TotalPages	Integer	总页数注意：此字段可能返回 null，表示取不到有效值。

EditTagVO

同步标签数据出参

被如下接口引用：EditCorpTag。

名称	类型	描述
TranId	String	事务id 注意：此字段可能返回 null，表示取不到有效值。
TranStatus	Integer	事务状态注意：此字段可能返回 null，表示取不到有效值。
Id	Integer	标签信息注意：此字段可能返回 null，表示取不到有效值。

EmbedTokenInfo

报表嵌出数据结构-强鉴权

被如下接口引用：CreateEmbedToken。

名称	类型	描述
Id	Integer	信息标识注意：此字段可能返回 null，表示取不到有效值。示例值：1
BIToken	String	令牌注意：此字段可能返回 null，表示取不到有效值。示例值：1
ProjectId	String	项目Id 注意：此字段可能返回 null，表示取不到有效值。示例值：1
CreatedUser	String	创建人注意：此字段可能返回 null，表示取不到有效值。示例值：1
CreatedAt	String	创建时间注意：此字段可能返回 null，表示取不到有效值。示例值：1
UpdatedUser	String	更新人注意：此字段可能返回 null，表示取不到有效值。示例值：1
UpdatedAt	String	更新时间注意：此字段可能返回 null，表示取不到有效值。示例值：1
PageId	String	页面Id 注意：此字段可能返回 null，表示取不到有效值。示例值：1
ExtraParam	String	备用注意：此字段可能返回 null，表示取不到有效值。示例值：{"xxx":"sas"}
Scope	String	嵌出类型注意：此字段可能返回 null，表示取不到有效值。示例值：page
ExpireTime	Integer	过期时间，分钟为单位，最大240 注意：此字段可能返回 null，表示取不到有效值。示例值：1
UserCorpId	String	使用者企业Id(仅用于多用户) 注意：此字段可能返回 null，表示取不到有效值。示例值：1101
UserId	String	使用者Id(仅用于多用户) 注意：此字段可能返回 null，表示取不到有效值。示例值：12012
TicketNum	Integer	访问次数限制，限制范围1-99999，为空则不设置访问次数限制注意：此字段可能返回 null，表示取不到有效值。示例值：1
GlobalParam	String	全局参数注意：此字段可能返回 null，表示取不到有效值。示例值：1
Intention	String	embed表示页面看板嵌出，chatBIEmbed表示ChatBI嵌出注意：此字段可能返回 null，表示取不到有效值。示例值：share
TokenType	Integer	100 无绑定用户 200 单用户单token 300 单用户多token 注意：此字段可能返回 null，表示取不到有效值。示例值：100
TokenNum	Integer	token 数注意：此字段可能返回 null，表示取不到有效值。示例值：11
SingleUserMultiToken	Boolean	是否单用户多token 注意：此字段可能返回 null，表示取不到有效值。示例值：true
ConfigParam	String	嵌出显示配置，目前为ChatBI嵌出场景用，TableFilter表示数据表列表过滤，SqlView表示sql查看功能注意：此字段可能返回 null，表示取不到有效值。示例值：{"ChatBIConfigList":[{"ConfigType":"TableFilter","ConfigDetails":{"Values":["26513"]}},{"ConfigType":"SqlView","ConfigDetails":{"Enabled":false}}]}

EmptyValue

空值展示样式配置值结构

被如下接口引用：CreateDataTable, DescribeSourceFieldList。

名称	类型	必选	描述
Type	String	否	空值展示样式类型注意：此字段可能返回 null，表示取不到有效值。示例值：custom
Custom	String	否	空值展示样式类型对应具体的展示字符串注意：此字段可能返回 null，表示取不到有效值。示例值：null

EmptyValueConfig

空值展示样式配置结构

被如下接口引用：CreateDataTable, DescribeSourceFieldList。

名称	类型	必选	描述
Number	EmptyValue	否	数值类字段空值样式配置注意：此字段可能返回 null，表示取不到有效值。
String	EmptyValue	否	字符串字段空置样式配置注意：此字段可能返回 null，表示取不到有效值。

ErrorInfo

自定义错误信息对象

被如下接口引用：ApplyEmbedInterval, ClearEmbedToken, CreateAuthApiKey, CreateCorpTag, CreateDataTable, CreateDatasource, CreateDatasourceCloud, CreateEmbedToken, CreatePermissionRanks, CreateProject, CreateTagTable, CreateUserGroup, CreateUserGroupMember, CreateUserRole, CreateUserRoleProject, DeleteAuthApiKey, DeleteDatasource, DeleteProject, DeleteUserGroup, DeleteUserGroupMember, DeleteUserRole, DeleteUserRoleProject, DescribeAuthApiKeyInfo, DescribeAuthApiKeyList, DescribeDatasourceList, DescribePageWidgetList, DescribePermissionRanksInfo, DescribePermissionRoleInfo, DescribePermissionStatusInfo, DescribeProjectInfo, DescribeProjectList, DescribeResourceUserGroupPageList, DescribeSourceFieldList, DescribeUserGroupInfo, DescribeUserGroupMemberList, DescribeUserGroupTreeList, DescribeUserProjectList, DescribeUserRoleList, DescribeUserRoleProjectList, EditCorpTag, ExportScreenPage, ModifyAuthApiKey, ModifyDatasource, ModifyDatasourceCloud, ModifyProject, ModifyResourceUser, ModifyResourceUserGroup, ModifyResourceUserGroupResource, ModifyTagTable, ModifyUserDetailInfo, ModifyUserGroup, ModifyUserRole, ModifyUserRoleProject, ModifyUserTag, QueryUserGroupMember。

名称	类型	描述
ErrorTip	String	错误说明字段注意：此字段可能返回 null，表示取不到有效值。示例值：错误提示
ErrorMessage	String	原始异常信息注意：此字段可能返回 null，表示取不到有效值。示例值：错误提示消息
ErrorLevel	String	错误等级字段 ERROR WARN INFO 注意：此字段可能返回 null，表示取不到有效值。示例值：INFO
DocLink	String	指引文档链接注意：此字段可能返回 null，表示取不到有效值。示例值：文档链接说明
FAQ	String	快速指引说明注意：此字段可能返回 null，表示取不到有效值。示例值：常见问题
ReservedField	String	预留字段1 注意：此字段可能返回 null，表示取不到有效值。示例值：1

FieldRemarkDTO

字段备注信息

被如下接口引用：CreateDataTable。

名称	类型	必选	描述
FieldName	String	否	字段名注意：此字段可能返回 null，表示取不到有效值。示例值：id
Comment	Array of String	否	字段备注列表注意：此字段可能返回 null，表示取不到有效值。示例值：["id1","id2"]

FrequencyConfig

定时任务执行频率配置

被如下接口引用：CreateDataTable。

名称	类型	必选	描述
Frequency	String	否	周期注意：此字段可能返回 null，表示取不到有效值。示例值：""
Dates	Array of Integer	否	日期注意：此字段可能返回 null，表示取不到有效值。
Time	String	否	时间注意：此字段可能返回 null，表示取不到有效值。
IntervalTime	Integer	否	间隔时间注意：此字段可能返回 null，表示取不到有效值。
IntervalTimeUnit	Integer	否	1:SECOND,2:MINUTE,3:HOUR,4:DAY 注意：此字段可能返回 null，表示取不到有效值。
Hours	Array of Integer	否	小时列表注意：此字段可能返回 null，表示取不到有效值。
Minute	Array of Integer	否	分钟列表注意：此字段可能返回 null，表示取不到有效值。

IdDTO

仅包含id的对象

被如下接口引用：CreateDataTable, CreateDatasource, CreateDatasourceCloud。

名称	类型	必选	描述
Id	Integer	是	请求id 注意：此字段可能返回 null，表示取不到有效值。示例值：1
AccessKey	String	否	key 注意：此字段可能返回 null，表示取不到有效值。示例值：AccessKey***AccessKey
ProjectId	Integer	否	id 注意：此字段可能返回 null，表示取不到有效值。示例值：1
TranId	String	否	事务id 注意：此字段可能返回 null，表示取不到有效值。示例值：TranId***TranId
TranStatus	Integer	否	事务状态枚举值： 1：处理中 2：处理成功 3：处理失败注意：此字段可能返回 null，表示取不到有效值。示例值：1

JoinRelation

多表关联原始表之间的关联信息

被如下接口引用：CreateDataTable。

名称	类型	必选	描述
JoinId	String	否	表关联关系id,前端使用注意：此字段可能返回 null，表示取不到有效值。示例值：abc
SourceTableNodeId	String	否	原表节点id 注意：此字段可能返回 null，表示取不到有效值。示例值：a
TargetTableNodeId	String	否	目标表节点id 注意：此字段可能返回 null，表示取不到有效值。示例值：b
JoinType	String	否	多表关联的关联类型注意：此字段可能返回 null，表示取不到有效值。示例值：inner
Fields	Array of JoinRelationField	否	多表关联的字段列表注意：此字段可能返回 null，表示取不到有效值。示例值：[]

JoinRelationField

多表关联原始表之间使用的关联字段信息

被如下接口引用：CreateDataTable。

名称	类型	必选	描述
FieldJoinId	String	否	字段关联关系id,前端使用注意：此字段可能返回 null，表示取不到有效值。示例值：abc
SourceField	TableField	否	原表字段注意：此字段可能返回 null，表示取不到有效值。示例值：{}
TargetField	TableField	否	目标表字段注意：此字段可能返回 null，表示取不到有效值。示例值：{}

JoinSourceTable

多表关联原始表信息

被如下接口引用：CreateDataTable。

名称	类型	必选	描述
TableNodeType	Integer	否	1:数据源原表,2:本地表,3:Excel表,4:API表注意：此字段可能返回 null，表示取不到有效值。示例值：1
TableNodeId	String	否	原始表节点Id 注意：此字段可能返回 null，表示取不到有效值。示例值：a
ParentId	String	否	父节点id 注意：此字段可能返回 null，表示取不到有效值。示例值：b
TableId	String	否	非必填, 数据源原表没有ID 注意：此字段可能返回 null，表示取不到有效值。示例值：1
TableName	String	否	必填,数据源原表用原始表名, 其他类型用BI的逻辑表名注意：此字段可能返回 null，表示取不到有效值。示例值：t_user
Fields	Array of TableField	否	原始表需要展示的字段列表注意：此字段可能返回 null，表示取不到有效值。示例值：[]
DatasourceId	Integer	否	数据源id 注意：此字段可能返回 null，表示取不到有效值。示例值：1
TableAlias	String	否	非必填,前端展示的数据源别名,excel建表需要注意：此字段可能返回 null，表示取不到有效值。示例值：a

ModifyTagTableVO

创建标签表出参

被如下接口引用：ModifyTagTable。

名称	类型	描述
Id	Integer	标签表id 注意：此字段可能返回 null，表示取不到有效值。

PageScreenListVO

页面截图列表

被如下接口引用：ExportScreenPage。

名称	类型	描述
PicType	String	图片导出类型。base64；url 注意：此字段可能返回 null，表示取不到有效值。示例值："base64"
List	Array of PageScreenVO	图片列表注意：此字段可能返回 null，表示取不到有效值。
TranId	String	异步事务id 注意：此字段可能返回 null，表示取不到有效值。示例值：TranId***TranId
TranStatus	Integer	事务状态 1: 处理中; 2: 处理成功; 3 处理失败(错误内容见外层Msg) 注意：此字段可能返回 null，表示取不到有效值。示例值：1

PageScreenVO

页面截图信息

被如下接口引用：ExportScreenPage。

名称	类型	描述
Content	String	截图base64或 url 注意：此字段可能返回 null，表示取不到有效值。示例值：{"widgetId": "mixLineBar_1","pageId":"1101"}
WidgetId	String	组件Id 注意：此字段可能返回 null，表示取不到有效值。示例值：mixLineBar_1

ParamCreateDTO

被如下接口引用：CreateDataTable, DescribeSourceFieldList。

名称	类型	必选	描述
ParamName	String	否	参数名注意：此字段可能返回 null，表示取不到有效值。示例值：1
DefaultValue	String	否	默认值注意：此字段可能返回 null，表示取不到有效值。
ParamType	String	否	参数类型，string/datetime/number 注意：此字段可能返回 null，表示取不到有效值。示例值：string/datetime/number
FormatRule	String	否	格式化类型，yyyy-MM-dd HH:mm:ss.SSS（只有时间必填）注意：此字段可能返回 null，表示取不到有效值。示例值：yyyy-MM-dd HH:mm:ss.SSS（只有时间必填）
ComplexType	String	否	复杂类型，格式化的另一种表达，例如YYYY-MM 注意：此字段可能返回 null，表示取不到有效值。示例值：可不填
Scope	String	否	作用域注意：此字段可能返回 null，表示取不到有效值。

PermissionComponent

商业版本权限单元

被如下接口引用：DescribeDatasourceList。

名称	类型	必选	描述
ModuleId	String	否	权限值注意：此字段可能返回 null，表示取不到有效值。示例值：bi_datasource_read
IncludeType	String	否	可用性枚举值： usable：可用 visible：可见 disabled：不可用 hidden：隐藏默认值：disabled 注意：此字段可能返回 null，表示取不到有效值。示例值：disabled
UpgradeVersionType	String	否	目标升级版本注意：此字段可能返回 null，表示取不到有效值。示例值：v1
Tips	String	否	补充信息注意：此字段可能返回 null，表示取不到有效值。示例值：请升级到基础版或者专业版
TipsKey	String	否	补充信息的key值注意：此字段可能返回 null，表示取不到有效值。示例值：basic

PermissionGroup

商业化版本权限分组

被如下接口引用：DescribeDatasourceList。

名称	类型	必选	描述
ModuleGroup	String	否	分组名注意：此字段可能返回 null，表示取不到有效值。示例值：bi_datasource
Components	Array of PermissionComponent	否	权限列表注意：此字段可能返回 null，表示取不到有效值。

Project

项目信息描述

被如下接口引用：DescribeProjectInfo, DescribeProjectList。

名称	类型	描述
Id	Integer	项目ID 示例值：1
Logo	String	项目Logo 注意：此字段可能返回 null，表示取不到有效值。示例值：https://www.cloud.tencent***/logo.png
Name	String	项目名称注意：此字段可能返回 null，表示取不到有效值。示例值：项目名称
ColorCode	String	logo底色注意：此字段可能返回 null，表示取不到有效值。示例值：#ffffff
CreatedUser	String	创建人注意：此字段可能返回 null，表示取不到有效值。示例值：zhangsan
CreatedAt	String	创建时间注意：此字段可能返回 null，表示取不到有效值。示例值：zhangsan
MemberCount	Integer	成员个数注意：此字段可能返回 null，表示取不到有效值。示例值：1
PageCount	Integer	页面个数注意：此字段可能返回 null，表示取不到有效值。示例值：1
LastModifyName	String	最后修改报表、简报名称注意：此字段可能返回 null，表示取不到有效值。示例值：zhangsan
Source	String	"" 注意：此字段可能返回 null，表示取不到有效值。示例值：saas
Apply	Boolean	"" 注意：此字段可能返回 null，表示取不到有效值。示例值：false
UpdatedUser	String	"" 注意：此字段可能返回 null，表示取不到有效值。示例值：zhangsan
UpdatedAt	String	"" 注意：此字段可能返回 null，表示取不到有效值。示例值：zhangsan
CorpId	String	"" 注意：此字段可能返回 null，表示取不到有效值。示例值："corp123"
Mark	String	"" 注意：此字段可能返回 null，表示取不到有效值。示例值：备注
Seed	String	"" 注意：此字段可能返回 null，表示取不到有效值。示例值："x12738"
AuthList	Array of String	项目内权限列表注意：此字段可能返回 null，表示取不到有效值。示例值：["bi_project_read","bi_project_write"]
PanelScope	String	默认看板注意：此字段可能返回 null，表示取不到有效值。示例值：page
IsExternalManage	Boolean	是否被托管注意：此字段可能返回 null，表示取不到有效值。示例值：true
ManagePlatform	String	托管平台名称注意：此字段可能返回 null，表示取不到有效值。示例值：saas
ConfigList	Array of ProjectConfigList	定制化参数注意：此字段可能返回 null，表示取不到有效值。
CreatedUserName	String	创建人注意：此字段可能返回 null，表示取不到有效值。示例值：张三
Owner	String	所属人id 注意：此字段可能返回 null，表示取不到有效值。示例值：zhangsan
OwnerName	String	所属人注意：此字段可能返回 null，表示取不到有效值。示例值：张三
NormalCount	Integer	仪表盘页面数注意：此字段可能返回 null，表示取不到有效值。示例值：1
FreeCount	Integer	自由画布页面数注意：此字段可能返回 null，表示取不到有效值。示例值：1
AdhocCount	Integer	即席分析页面数注意：此字段可能返回 null，表示取不到有效值。示例值：1
BriefingCount	Integer	简报页面数注意：此字段可能返回 null，表示取不到有效值。示例值：1

ProjectConfigList

定制化查询

被如下接口引用：DescribeProjectInfo, DescribeProjectList。

名称	类型	必选	描述
ModuleGroup	String	否	模块组注意：此字段可能返回 null，表示取不到有效值。示例值：1
Components	Array of ProjectConfigResult	否	内容注意：此字段可能返回 null，表示取不到有效值。

ProjectConfigResult

定制化查询

被如下接口引用：DescribeProjectInfo, DescribeProjectList。

名称	类型	必选	描述
ModuleId	String	否	配置名称注意：此字段可能返回 null，表示取不到有效值。示例值：bi_datasource_read
IncludeType	String	否	配置方式枚举值： usable：可用 visible：可见 disabled：不可用 hidden：隐藏默认值：disabled 注意：此字段可能返回 null，表示取不到有效值。示例值：disabled
Params	String	否	额外参数注意：此字段可能返回 null，表示取不到有效值。示例值：{"xx":""}

名称

类型

必选

描述

ModuleId

String

否

配置名称

注意：此字段可能返回 null，表示取不到有效值。
示例值：bi_datasource_read

IncludeType

String

否

配置方式

枚举值：

usable：可用
visible：可见
disabled：不可用
hidden：隐藏

默认值：disabled

注意：此字段可能返回 null，表示取不到有效值。
示例值：disabled

Params

String

否

额外参数

注意：此字段可能返回 null，表示取不到有效值。
示例值：{"xx":""}

ProjectListData

项目列表数据

被如下接口引用：DescribeProjectList。

名称	类型	描述
List	Array of Project	数组注意：此字段可能返回 null，表示取不到有效值。
Total	Integer	总数注意：此字段可能返回 null，表示取不到有效值。示例值：1
TotalPages	Integer	1 注意：此字段可能返回 null，表示取不到有效值。示例值：1

RankInfo

行列权限内容

被如下接口引用：DescribePermissionRanksInfo。

名称	类型	必选	描述
Type	String	是	1 注意：此字段可能返回 null，表示取不到有效值。示例值：1
Mode	String	是	1 注意：此字段可能返回 null，表示取不到有效值。示例值：1
RulerInfo	String	是	`<br/>注意：此字段可能返回 null，表示取不到有效值。<br/>示例值：`
RoleId	Integer	是	1 注意：此字段可能返回 null，表示取不到有效值。示例值：11
RoleType	String	是	1 注意：此字段可能返回 null，表示取不到有效值。示例值：1
TableId	Integer	否	1 注意：此字段可能返回 null，表示取不到有效值。示例值：1
RowColumnConfigList	Array of RowColumnConfig	否	行列权限配置注意：此字段可能返回 null，表示取不到有效值。

ResourceDTO

资源权限信息

被如下接口引用：DescribeResourceUserGroupPageList, DescribeUserGroupTreeList。

名称	类型	必选	描述
ResourceName	String	否	资源名称注意：此字段可能返回 null，表示取不到有效值。示例值：test
ResourceValue	Boolean	否	是否启用注意：此字段可能返回 null，表示取不到有效值。示例值：true
CanChange	Boolean	否	能否变更注意：此字段可能返回 null，表示取不到有效值。示例值：true
Tips	String	否	提示注意：此字段可能返回 null，表示取不到有效值。示例值：tips

ResourceItem

资源

被如下接口引用：ModifyResourceUser, ModifyResourceUserGroup, ModifyResourceUserGroupResource。

名称	类型	必选	描述
ResourceName	String	否	资源名称注意：此字段可能返回 null，表示取不到有效值。示例值：PageView
ResourceValue	Boolean	否	资源值注意：此字段可能返回 null，表示取不到有效值。示例值：true
CanChange	Boolean	否	是否可变更注意：此字段可能返回 null，表示取不到有效值。示例值：true
Tips	String	否	提示信息注意：此字段可能返回 null，表示取不到有效值。示例值：继承自用户组

ResourceListDTO

操作的资源权限

被如下接口引用：ModifyResourceUserGroup。

名称	类型	必选	描述
EntityId	Integer	否	资源id 注意：此字段可能返回 null，表示取不到有效值。示例值：1
NodeType	Integer	否	资源类型注意：此字段可能返回 null，表示取不到有效值。示例值：1
ResourceList	Array of ResourceItem	否	资源权限注意：此字段可能返回 null，表示取不到有效值。

ResourceTagValue

资源权限标签过滤参数

被如下接口引用：DescribeResourceUserGroupPageList, DescribeUserGroupTreeList, QueryUserGroupMember。

名称	类型	必选	描述
Id	Integer	否	标签id
Name	String	否	标签名称
Values	Array of String	否	标签值列表

Role

角色

被如下接口引用：DescribePermissionRoleInfo。

名称	类型	描述
Id	Integer	角色ID 示例值：1
RoleName	String	角色名称示例值：1
CorpId	String	企业ID 示例值：1
RoleType	String	角色类型示例值：1
Scope	String	范围示例值：1
Description	String	描述示例值：1
CreatedAt	String	创建时间注意：此字段可能返回 null，表示取不到有效值。示例值：1
CreatedUser	String	创建人注意：此字段可能返回 null，表示取不到有效值。示例值：1
UpdatedAt	String	更新时间注意：此字段可能返回 null，表示取不到有效值。示例值：1
UpdatedUser	String	更新人注意：此字段可能返回 null，表示取不到有效值。示例值：1
ScopeType	Integer	是否为全局角色（0 不是， 1 是）注意：此字段可能返回 null，表示取不到有效值。示例值：1
CanChoose	Boolean	是否可被选注意：此字段可能返回 null，表示取不到有效值。示例值：true
ModuleCollection	String	角色key 注意：此字段可能返回 null，表示取不到有效值。示例值：1

RowColumnConfig

行列权限配置

被如下接口引用：CreatePermissionRanks, DescribePermissionRanksInfo。

名称	类型	必选	描述
RulerInfo	String	否	行列权限规则注意：此字段可能返回 null，表示取不到有效值。示例值：{"Logic":"and","Items":[]}
TagValueList	Array of RowColumnTagValue	否	标签值列表注意：此字段可能返回 null，表示取不到有效值。

RowColumnStatus

行列权限初始状态

被如下接口引用：DescribePermissionStatusInfo。

名称	类型	必选	描述
TableId	Integer	是	1 注意：此字段可能返回 null，表示取不到有效值。示例值：1
Type	String	是	1 注意：此字段可能返回 null，表示取不到有效值。示例值：1
Mode	String	是	1 注意：此字段可能返回 null，表示取不到有效值。示例值：1
OpenStatus	String	是	1 注意：此字段可能返回 null，表示取不到有效值。示例值：1
RoleType	String	是	1 注意：此字段可能返回 null，表示取不到有效值。示例值：1
RoleId	Integer	是	1 注意：此字段可能返回 null，表示取不到有效值。示例值：1

RowColumnTagValue

行列权限标签出入参

被如下接口引用：CreatePermissionRanks。

名称	类型	必选	描述
Id	Integer	否	标签id 注意：此字段可能返回 null，表示取不到有效值。示例值：1
Name	String	否	标签名称注意：此字段可能返回 null，表示取不到有效值。示例值：name
Values	Array of String	否	标签值列表注意：此字段可能返回 null，表示取不到有效值。示例值：["value1","value2"]

TableColumn

表的列数据抽象

被如下接口引用：DescribeSourceFieldList。

名称	类型	描述
DbName	String	列名字注意：此字段可能返回 null，表示取不到有效值。示例值：id
AliasName	String	列的别名注意：此字段可能返回 null，表示取不到有效值。示例值：id
DbType	String	列的类型注意：此字段可能返回 null，表示取不到有效值。示例值：NUMBER
FieldType	String	段类型注意：此字段可能返回 null，表示取不到有效值。示例值：number
Mark	String	备注注意：此字段可能返回 null，表示取不到有效值。示例值：id
ExcelName	String	excel名注意：此字段可能返回 null，表示取不到有效值。示例值：id
DictId	Integer	关联的字典表Id 注意：此字段可能返回 null，表示取不到有效值。示例值：0
DictName	String	关联的字典表表名注意：此字段可能返回 null，表示取不到有效值。示例值：id
TableNodeId	String	多表关联新增字段注意：此字段可能返回 null，表示取不到有效值。示例值：b
TableName	String	字段所属的表名注意：此字段可能返回 null，表示取不到有效值。示例值：demo
FieldComplexType	String	用户设置的带格式的目标复杂格式注意：此字段可能返回 null，表示取不到有效值。示例值：NUMBER
FormatRule	String	格式规则注意：此字段可能返回 null，表示取不到有效值。示例值：格式规则
IsFilter	Boolean	数据字段是否过滤空值注意：此字段可能返回 null，表示取不到有效值。示例值：false
CalcType	String	计算字段类型注意：此字段可能返回 null，表示取不到有效值。示例值：agg
CalcFormula	String	计算字段的公式内容注意：此字段可能返回 null，表示取不到有效值。示例值：agg
CalcDesc	String	计算字段的中文公式内容注意：此字段可能返回 null，表示取不到有效值。示例值：聚合
JsonPathName	String	Api数据源json路径名称注意：此字段可能返回 null，表示取不到有效值。示例值：json.json2
Granularity	String	地理类型标识注意：此字段可能返回 null，表示取不到有效值。示例值：province
GeoJsonId	Integer	自定义地图Id 注意：此字段可能返回 null，表示取不到有效值。示例值：1
EmptyValueConfig	EmptyValueConfig	空值展示样式配置注意：此字段可能返回 null，表示取不到有效值。
DbFieldName	String	原列名称注意：此字段可能返回 null，表示取不到有效值。示例值：id
IsCopyOperation	Boolean	是否是复制字段操作注意：此字段可能返回 null，表示取不到有效值。示例值：false
IsCopyFromNormal	Boolean	是否从普通字段复制注意：此字段可能返回 null，表示取不到有效值。示例值：false

TableColumnListData

表的全部列名数据列表

被如下接口引用：DescribeSourceFieldList。

名称	类型	描述
List	Array of TableColumn	表中的列的列表注意：此字段可能返回 null，表示取不到有效值。
TranId	String	异步事务id 注意：此字段可能返回 null，表示取不到有效值。
TranStatus	Integer	异步事务状态注意：此字段可能返回 null，表示取不到有效值。示例值：1

TableField

表字段描述

被如下接口引用：CreateDataTable。

名称	类型	必选	描述
DbName	String	是	db里的字段column名示例值：1
AliasName	String	是	bi展示名示例值：1
DbType	String	是	db里的字段类型示例值：1
FieldType	String	是	BI归类后的抽象字段类型,比如字符串,数字,时间示例值：1
FieldComplexType	String	否	字段组合计算公式后生成的复杂明细类型注意：此字段可能返回 null，表示取不到有效值。示例值：1
Mark	String	否	字段描述注意：此字段可能返回 null，表示取不到有效值。示例值：1
FormatRule	String	否	字段计算公式注意：此字段可能返回 null，表示取不到有效值。示例值：1
IsFilter	Boolean	否	数据字段是否过滤空值注意：此字段可能返回 null，表示取不到有效值。示例值：false
CalcType	String	否	计算字段类型注意：此字段可能返回 null，表示取不到有效值。示例值：BASIC
CalcFormula	String	否	计算字段的公式内容注意：此字段可能返回 null，表示取不到有效值。示例值：[A]+[B]
CalcDesc	String	否	计算字段的中文公式内容, 前端展示使用注意：此字段可能返回 null，表示取不到有效值。示例值：[分销额]+[利息]
DictId	Integer	否	关联字典表id 注意：此字段可能返回 null，表示取不到有效值。示例值：1
DictName	String	否	关联字典表名注意：此字段可能返回 null，表示取不到有效值。示例值：id
TableNodeId	String	否	非必填, 多表关联新增字段注意：此字段可能返回 null，表示取不到有效值。示例值：b
ExcelName	String	否	excel 注意：此字段可能返回 null，表示取不到有效值。示例值：excel表
TableName	String	否	非必填,多表关联新增字段,字段所属的表名注意：此字段可能返回 null，表示取不到有效值。示例值：demo
JsonPathName	String	否	api数据源路径名注意：此字段可能返回 null，表示取不到有效值。示例值：json
Granularity	String	否	地理字段标识注意：此字段可能返回 null，表示取不到有效值。示例值：province
GeoJsonId	Integer	否	地图id 注意：此字段可能返回 null，表示取不到有效值。示例值：1
EmptyValueConfig	EmptyValueConfig	否	空值展示样式配置注意：此字段可能返回 null，表示取不到有效值。
DbFieldName	String	否	原列名称注意：此字段可能返回 null，表示取不到有效值。示例值：id
IsCopyOperation	Boolean	否	是否是复制字段操作注意：此字段可能返回 null，表示取不到有效值。示例值：false
IsCopyFromNormal	Boolean	否	是否从普通字段复制注意：此字段可能返回 null，表示取不到有效值。示例值：false

UserGroupDTO

用户组

被如下接口引用：DescribeUserRoleList, DescribeUserRoleProjectList。

名称	类型	必选	描述
Id	Integer	否	id 注意：此字段可能返回 null，表示取不到有效值。示例值：1
GroupName	String	否	用户组名称注意：此字段可能返回 null，表示取不到有效值。示例值：云产品
ParentId	Integer	否	父节点id 注意：此字段可能返回 null，表示取不到有效值。示例值：1
IsDefault	Integer	否	是否为默认注意：此字段可能返回 null，表示取不到有效值。示例值：1
AdminUserId	String	否	管理员用户id 注意：此字段可能返回 null，表示取不到有效值。示例值：test_user
Description	String	否	描述注意：此字段可能返回 null，表示取不到有效值。示例值：描述
Location	Integer	否	定位注意：此字段可能返回 null，表示取不到有效值。示例值：1

UserGroupMemberVO

用户组成员VO出参

被如下接口引用：DescribeUserGroupMemberList, QueryUserGroupMember。

名称	类型	必选	描述
UserName	String	否	用户名注意：此字段可能返回 null，表示取不到有效值。示例值：用户名
UserId	String	否	用户id 注意：此字段可能返回 null，表示取不到有效值。示例值：124
CreatedBy	String	否	创建人注意：此字段可能返回 null，表示取不到有效值。示例值：124
CreatedOn	String	否	创建时间注意：此字段可能返回 null，表示取不到有效值。示例值：2025-06-10 12:00:00

UserGroupPageTreeVO

用户组权限树

被如下接口引用：DescribeResourceUserGroupPageList。

名称	类型	必选	描述
List	Array of UserGroupTreeVO	否	列表注意：此字段可能返回 null，表示取不到有效值。
Total	Integer	否	总数注意：此字段可能返回 null，表示取不到有效值。示例值：1
TotalPages	Integer	否	页数注意：此字段可能返回 null，表示取不到有效值。示例值：1

UserGroupTreeNodeDTO

用户组数节点

被如下接口引用：DescribeUserGroupTreeList, QueryUserGroupMember。

名称	类型	必选	描述
GroupId	Integer	否	用户组id 注意：此字段可能返回 null，表示取不到有效值。示例值：1
QueryChildNodes	Boolean	否	是否查询子节点注意：此字段可能返回 null，表示取不到有效值。示例值：true

UserGroupTreeVO

用户组权限树

被如下接口引用：DescribeResourceUserGroupPageList, DescribeUserGroupTreeList。

名称	类型	必选	描述
Id	Integer	否	当前实体ID 注意：此字段可能返回 null，表示取不到有效值。示例值：1
GroupName	String	否	用户组名称注意：此字段可能返回 null，表示取不到有效值。示例值：name
ParentId	Integer	否	父id 注意：此字段可能返回 null，表示取不到有效值。示例值：-1
ParentName	String	否	父节点名称注意：此字段可能返回 null，表示取不到有效值。示例值：p1
IsDefault	Integer	否	1 注意：此字段可能返回 null，表示取不到有效值。示例值：是否默认
AdminUserId	String	否	管理员账号id 注意：此字段可能返回 null，表示取不到有效值。示例值：admin
UserList	Array of UserVO	否	用户集合注意：此字段可能返回 null，表示取不到有效值。
Description	String	否	描述注意：此字段可能返回 null，表示取不到有效值。示例值：描述
Location	Integer	否	排序注意：此字段可能返回 null，表示取不到有效值。示例值：6
Children	Array of UserGroupTreeVO	否	孩子节点注意：此字段可能返回 null，表示取不到有效值。
HasChildren	Boolean	否	是否有孩子节点注意：此字段可能返回 null，表示取不到有效值。示例值：true
ResourceList	Array of ResourceDTO	否	资源集合注意：此字段可能返回 null，表示取不到有效值。

UserGroupUpdateDTO

用户组更新入参

被如下接口引用：ModifyUserGroup。

名称	类型	必选	描述
AdminUserId	String	否	组管理员示例值：subuin
Description	String	否	描述示例值：描述
GroupName	String	否	用户组名称示例值：用户组名称
Location	Integer	否	排序位置示例值：0
ParentId	Integer	否	父节点id 示例值：-1
Id	Integer	否	用户组id 示例值：12
ParentName	String	否	父节点名称示例值：名称

UserGroupUserInfoVO

用户组返回参数

被如下接口引用：CreateUserGroup, ModifyUserGroup。

名称	类型	必选	描述
UserId	String	否	用户id 注意：此字段可能返回 null，表示取不到有效值。示例值：用户id
UserName	String	否	用户名称注意：此字段可能返回 null，表示取不到有效值。示例值：用户名称

UserGroupVO

用户组返回参数

被如下接口引用：CreateUserGroup, ModifyUserGroup。

名称	类型	描述
Id	Integer	用户组id 注意：此字段可能返回 null，表示取不到有效值。示例值：1
GroupName	String	用户组名称注意：此字段可能返回 null，表示取不到有效值。示例值：用户组名称
ParentId	Integer	所属用户组id 注意：此字段可能返回 null，表示取不到有效值。示例值：-1
ParentName	String	所属用户组名称注意：此字段可能返回 null，表示取不到有效值。示例值：所属名称
IsDefault	Integer	是否默认用户组注意：此字段可能返回 null，表示取不到有效值。示例值：0
AdminUserId	String	用户组管理员注意：此字段可能返回 null，表示取不到有效值。示例值：用户组管理员
Description	String	描述注意：此字段可能返回 null，表示取不到有效值。示例值：描述
Location	Integer	排序位置注意：此字段可能返回 null，表示取不到有效值。示例值：0
UserList	Array of UserGroupUserInfoVO	用户信息注意：此字段可能返回 null，表示取不到有效值。

UserIdAndUserName

用户ID和用户名

被如下接口引用：DescribeUserProjectList。

名称	类型	必选	描述
UserId	String	否	用户ID 示例值：1101
UserName	String	否	用户名示例值：zhangsan
CorpId	String	否	企业ID 注意：此字段可能返回 null，表示取不到有效值。示例值：10201
Email	String	否	电子邮箱注意：此字段可能返回 null，表示取不到有效值。示例值：123***@qq.com
LastLogin	Timestamp ISO8601	否	最后一次登录时间注意：此字段可能返回 null，表示取不到有效值。示例值：2026-06-11T11:28:44+08:00
Status	Integer	否	用户状态枚举值： 1：启用 0：停用默认值：1 注意：此字段可能返回 null，表示取不到有效值。示例值：1
FirstModify	Integer	否	首次登录是否修改密码注意：此字段可能返回 null，表示取不到有效值。示例值：1
PhoneNumber	String	否	手机号码注意：此字段可能返回 null，表示取不到有效值。示例值：+861****797
AreaCode	String	否	手机区号注意：此字段可能返回 null，表示取不到有效值。示例值：bj
CreatedUser	String	否	创建人注意：此字段可能返回 null，表示取不到有效值。示例值：zhangsan
CreatedAt	Timestamp ISO8601	否	创建时间注意：此字段可能返回 null，表示取不到有效值。示例值：2026-06-11T11:28:44+08:00
UpdatedUser	String	否	修改人注意：此字段可能返回 null，表示取不到有效值。示例值：zhangsan
UpdatedAt	Timestamp ISO8601	否	更改时间注意：此字段可能返回 null，表示取不到有效值。示例值：2026-06-11T11:28:44+08:00
GlobalUserName	String	否	系统全局角色注意：此字段可能返回 null，表示取不到有效值。示例值：zhangsan
GlobalUserCode	String	否	系统全局角色编码注意：此字段可能返回 null，表示取不到有效值。示例值：sys_common_user
Mobile	String	否	手机号注意：此字段可能返回 null，表示取不到有效值。示例值：1329****797
AppId	String	否	1 注意：此字段可能返回 null，表示取不到有效值。示例值：1
AppUserId	String	否	1 注意：此字段可能返回 null，表示取不到有效值。示例值：1
AppUserAliasName	String	否	1 注意：此字段可能返回 null，表示取不到有效值。示例值：1
AppUserName	String	否	1 注意：此字段可能返回 null，表示取不到有效值。示例值：zhangsan
InValidateAppRange	Boolean	否	1 注意：此字段可能返回 null，表示取不到有效值。示例值：true
EmailActivationStatus	Integer	否	-1 免激活 0 未激活 1 已激活空代表待绑定注意：此字段可能返回 null，表示取不到有效值。示例值：1
Id	Integer	否	1 注意：此字段可能返回 null，表示取不到有效值。示例值：100001
LarkAppId	String	否	飞书应用ID 注意：此字段可能返回 null，表示取不到有效值。示例值：1
LarkUserId	String	否	飞书UserId 注意：此字段可能返回 null，表示取不到有效值。示例值：1001
LarkOpenId	String	否	飞书OpenId 注意：此字段可能返回 null，表示取不到有效值。示例值：ou_af9763**47b2d752
LarkUserName	String	否	飞书UserName 注意：此字段可能返回 null，表示取不到有效值。示例值：zhangsan

UserInfo

用户ID和用户名

被如下接口引用：CreateUserRole, CreateUserRoleProject。

名称	类型	必选	描述
UserId	String	否	用户ID 示例值：11010
UserName	String	否	用户名示例值：zhangsan
Email	String	否	邮箱注意：此字段可能返回 null，表示取不到有效值。示例值：123123***@qq.com
PhoneNumber	String	否	手机号注意：此字段可能返回 null，表示取不到有效值。示例值：+86213***323
AreaCode	String	否	手机号区号注意：此字段可能返回 null，表示取不到有效值。示例值：086
AppUserId	String	否	企微账号id 注意：此字段可能返回 null，表示取不到有效值。示例值：1101
AppUserName	String	否	企微账号名称注意：此字段可能返回 null，表示取不到有效值。示例值：zhangsan
LarkOpenId	String	否	飞书OpenId 注意：此字段可能返回 null，表示取不到有效值。示例值：ou_af9763**47b2d752

UserResourceDTO

用户资源入参

被如下接口引用：ModifyResourceUser, ModifyResourceUserGroupResource。

名称	类型	必选	描述
CorpId	String	否	企业id 注意：此字段可能返回 null，表示取不到有效值。
UserId	String	否	用户id 注意：此字段可能返回 null，表示取不到有效值。
UserName	String	否	用户名注意：此字段可能返回 null，表示取不到有效值。
ResourceList	Array of ResourceItem	否	资源列表注意：此字段可能返回 null，表示取不到有效值。

UserRoleListData

用户角色信息

被如下接口引用：DescribeUserRoleList, DescribeUserRoleProjectList。

名称	类型	描述
Total	Integer	总数注意：此字段可能返回 null，表示取不到有效值。示例值：1
TotalPages	Integer	总页数注意：此字段可能返回 null，表示取不到有效值。示例值：1
List	Array of UserRoleListDataUserRoleInfo	列表注意：此字段可能返回 null，表示取不到有效值。

UserRoleListDataRoleInfo

用户角色列表角色信息

被如下接口引用：DescribeUserRoleList, DescribeUserRoleProjectList。

名称	类型	描述
RoleName	String	角色名字注意：此字段可能返回 null，表示取不到有效值。示例值：项目管理员
RoleId	Integer	角色ID 注意：此字段可能返回 null，表示取不到有效值。示例值：1101
ProjectId	Integer	项目ID 注意：此字段可能返回 null，表示取不到有效值。示例值：1101
ProjectName	String	项目名字注意：此字段可能返回 null，表示取不到有效值。示例值：项目名称
ScopeType	Integer	是否为全局角色（0 不是 1 是）注意：此字段可能返回 null，表示取不到有效值。示例值：1
ModuleCollection	String	角色key 注意：此字段可能返回 null，表示取不到有效值。示例值：bi_datasource_read

UserRoleListDataUserRoleInfo

用户角色信息

被如下接口引用：DescribeUserRoleList, DescribeUserRoleProjectList。

名称	类型	描述
Id	Integer	业务ID 示例值：1
RoleList	Array of UserRoleListDataRoleInfo	角色列表注意：此字段可能返回 null，表示取不到有效值。
RoleIdList	Array of Integer	角色ID列表注意：此字段可能返回 null，表示取不到有效值。示例值：[1101,112210]
UserId	String	用户ID 示例值：1101
UserName	String	用户名示例值：zhangsan
CorpId	String	企业ID 示例值：12102
Email	String	邮箱注意：此字段可能返回 null，表示取不到有效值。示例值：123***@qq.com
CreatedUser	String	创建人注意：此字段可能返回 null，表示取不到有效值。示例值：zhangsan
CreatedAt	String	创建时间注意：此字段可能返回 null，表示取不到有效值。示例值：2024-10-23 21:32:45
UpdatedUser	String	更新人注意：此字段可能返回 null，表示取不到有效值。示例值：zhangsan1
UpdatedAt	String	更新时间注意：此字段可能返回 null，表示取不到有效值。示例值：2024-10-23 21:32:45
LastLogin	Timestamp ISO8601	最后一次登录时间注意：此字段可能返回 null，表示取不到有效值。示例值：zhangsan1
Status	Integer	账号状态注意：此字段可能返回 null，表示取不到有效值。示例值：1
PhoneNumber	String	手机号码注意：此字段可能返回 null，表示取不到有效值。示例值：+8631***321
AreaCode	String	手机号区号注意：此字段可能返回 null，表示取不到有效值。示例值：086
RootAccount	Boolean	是否为主账号注意：此字段可能返回 null，表示取不到有效值。示例值：true
CorpAdmin	Boolean	是否为企业管理员注意：此字段可能返回 null，表示取不到有效值。示例值：true
AppUserId	String	企微用户id 注意：此字段可能返回 null，表示取不到有效值。示例值：1101
AppUserAliasName	String	昵称注意：此字段可能返回 null，表示取不到有效值。示例值：zhangsan
AppUserName	String	应用用户名注意：此字段可能返回 null，表示取不到有效值。示例值：zhangsan
InValidateAppRange	Boolean	是否在可见范围内注意：此字段可能返回 null，表示取不到有效值。示例值：true
AppOpenUserId	String	用户openid 注意：此字段可能返回 null，表示取不到有效值。示例值：10012
EmailActivationStatus	Integer	邮箱激活状态注意：此字段可能返回 null，表示取不到有效值。示例值：0
UserGroupList	Array of UserGroupDTO	用户组信息注意：此字段可能返回 null，表示取不到有效值。示例值：[{"Id":1}]

UserTagInfo

用户标签信息

被如下接口引用：ModifyUserTag。

名称	类型	必选	描述
Id	Integer	否	标签ID 注意：此字段可能返回 null，表示取不到有效值。
Name	String	否	标签名注意：此字段可能返回 null，表示取不到有效值。
Value	String	否	标签值注意：此字段可能返回 null，表示取不到有效值。
IsExternalManage	Boolean	否	是否被托管注意：此字段可能返回 null，表示取不到有效值。
ManagePlatform	String	否	标签托管平台注意：此字段可能返回 null，表示取不到有效值。
ImportType	String	否	导入类型注意：此字段可能返回 null，表示取不到有效值。

UserVO

基础用户信息

被如下接口引用：DescribeResourceUserGroupPageList, DescribeUserGroupTreeList。

名称	类型	必选	描述
UserId	String	否	u1 注意：此字段可能返回 null，表示取不到有效值。示例值：用户id
UserName	String	否	zhang 注意：此字段可能返回 null，表示取不到有效值。示例值：用户名

WidgetListVO

页面组件信息

被如下接口引用：DescribePageWidgetList。

名称	类型	描述
CorpId	String	uin 注意：此字段可能返回 null，表示取不到有效值。示例值：110101
ProjectId	String	项目id 注意：此字段可能返回 null，表示取不到有效值。示例值：21012
PageId	String	页面id 注意：此字段可能返回 null，表示取不到有效值。示例值：1321
WidgetList	Array of WidgetVO	组件数组注意：此字段可能返回 null，表示取不到有效值。

WidgetVO

组件信息

被如下接口引用：DescribePageWidgetList。

名称	类型	描述
WidgetId	String	组件Id 注意：此字段可能返回 null，表示取不到有效值。示例值：bar_dsjusda
WidgetName	String	组件name 注意：此字段可能返回 null，表示取不到有效值。示例值：柱状图

数据结构

本页目录：

ApiDatasourceConfig

ApiKeyAuthApplyVO

ApiKeyAuthApplyVOList

ApplyEmbedTokenInfo

BaseStateAction

CorpUserListData

CreateTagTableVO

Data

DataId

DatasourceInfo

DatasourceInfoData

DescribeUserGroupMemberPageListContainer

EditTagVO

EmbedTokenInfo

EmptyValue

EmptyValueConfig

ErrorInfo

FieldRemarkDTO

FrequencyConfig

IdDTO

JoinRelation

JoinRelationField

JoinSourceTable

ModifyTagTableVO

PageScreenListVO

PageScreenVO

ParamCreateDTO

PermissionComponent

PermissionGroup

Project

ProjectConfigList

ProjectConfigResult

ProjectListData

RankInfo

ResourceDTO

ResourceItem

ResourceListDTO

ResourceTagValue

Role

RowColumnConfig

RowColumnStatus

RowColumnTagValue

TableColumn

TableColumnListData

TableField

UserGroupDTO

UserGroupMemberVO

UserGroupPageTreeVO

UserGroupTreeNodeDTO

UserGroupTreeVO

UserGroupUpdateDTO

UserGroupUserInfoVO

UserGroupVO

UserIdAndUserName

UserInfo

UserResourceDTO

UserRoleListData

UserRoleListDataRoleInfo

UserRoleListDataUserRoleInfo

UserTagInfo

UserVO

WidgetListVO

WidgetVO