API数据源连接配置
被如下接口引用：CreateDataTable。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| FieldsJsonData | String | 否 | API数据源解析结果 注意：此字段可能返回 null，表示取不到有效值。 |
| ConnectionType | Integer | 否 | 连接类型1:直连 2:抽取 注意：此字段可能返回 null，表示取不到有效值。 |
| FrequencyConfig | FrequencyConfig | 否 | 抽取频率配置 注意：此字段可能返回 null，表示取不到有效值。 |
| Url | String | 否 | 请求URL 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestMethod | Integer | 否 | 1:GET 2:POST 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestHeader | String | 否 | 请求头 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestParams | String | 否 | 请求参数 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestBody | String | 否 | 请求体 注意：此字段可能返回 null，表示取不到有效值。 |
| UserName | String | 否 | 用户名 注意：此字段可能返回 null，表示取不到有效值。 |
| Password | String | 否 | 密码 注意：此字段可能返回 null，表示取不到有效值。 |
| AuthorizationType | Integer | 否 | 1: 无鉴权 2:BASIC_AUTH 注意：此字段可能返回 null，表示取不到有效值。 |
| TableId | Integer | 否 | 表id 注意：此字段可能返回 null，表示取不到有效值。 |
| JsonPathDbNameMap | String | 否 | 路径DbName映射 注意：此字段可能返回 null，表示取不到有效值。 |
| AuthApi | String | 否 | 鉴权API 注意：此字段可能返回 null，表示取不到有效值。 |
| AppKey | String | 否 | 应用Key 注意：此字段可能返回 null，表示取不到有效值。 |
| AppSecret | String | 否 | 应用密钥 注意：此字段可能返回 null，表示取不到有效值。 |
| SecretKey | String | 否 | 数据密钥Key 注意：此字段可能返回 null，表示取不到有效值。 |
| SecretIv | String | 否 | 数据密钥初始化向量 注意：此字段可能返回 null，表示取不到有效值。 |
申请Token延期
被如下接口引用：ApplyEmbedInterval。
| 名称 | 类型 | 描述 |
|---|---|---|
| Result | Boolean | 申请结果 注意：此字段可能返回 null，表示取不到有效值。 |
列表查询返回的每条记录的操作属性
被如下接口引用：DescribeDatasourceList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ShowEdit | Boolean | 否 | 编辑是否可见 注意：此字段可能返回 null，表示取不到有效值。 |
| IsEdit | Boolean | 否 | 编辑是否可点击 注意：此字段可能返回 null，表示取不到有效值。 |
| EditText | String | 否 | 编辑按钮的文本 注意：此字段可能返回 null，表示取不到有效值。 |
| EditTips | String | 否 | 编辑不可用时的提示文本 注意：此字段可能返回 null，表示取不到有效值。 |
| ShowDel | Boolean | 否 | 删除是否可见 注意：此字段可能返回 null，表示取不到有效值。 |
| IsDel | Boolean | 否 | 删除是否可点击 注意：此字段可能返回 null，表示取不到有效值。 |
| DelText | String | 否 | 删除按钮的文本 注意：此字段可能返回 null，表示取不到有效值。 |
| DelTips | String | 否 | 删除不可用时的提示文本 注意：此字段可能返回 null，表示取不到有效值。 |
| ShowCopy | Boolean | 否 | 复制是否可见 注意：此字段可能返回 null，表示取不到有效值。 |
| ShowView | Boolean | 否 | 是否可见 注意：此字段可能返回 null，表示取不到有效值。 |
| ShowRename | Boolean | 否 | 是否可重命名 注意：此字段可能返回 null，表示取不到有效值。 |
企业用户列表
被如下接口引用：DescribeUserProjectList。
| 名称 | 类型 | 描述 |
|---|---|---|
| List | Array of UserIdAndUserName | 列表 注意：此字段可能返回 null，表示取不到有效值。 |
| Total | Integer | 总数 |
| TotalPages | Integer | 页数 |
数据
被如下接口引用：CreateProject。
| 名称 | 类型 | 描述 |
|---|---|---|
| Id | Integer | 项目Id |
| EditUrl | String | url 注意：此字段可能返回 null，表示取不到有效值。 |
数据ID
被如下接口引用：CreateUserRole, CreateUserRoleProject。
| 名称 | 类型 | 描述 |
|---|---|---|
| Id | Integer | 数据id 注意：此字段可能返回 null，表示取不到有效值。 |
数据源详情
被如下接口引用：DescribeDatasourceList。
| 名称 | 类型 | 描述 |
|---|---|---|
| Id | Integer | 数据库ID |
| DbName | String | 数据库名称 |
| ServiceType | String | 域类型，1、腾讯云，2、本地 注意：此字段可能返回 null，表示取不到有效值。 |
| SourceName | String | 数据库别名 |
| DbType | String | 数据库驱动 |
| DbHost | String | HOST |
| DbPort | Integer | 端口 |
| DbUser | String | 用户名 |
| Charset | String | 数据库编码 |
| CreatedAt | String | 创建时间 |
| UpdatedAt | String | 修改时间 |
| CreatedUser | String | 创建人 注意：此字段可能返回 null，表示取不到有效值。 |
| Catalog | String | catalog值 注意：此字段可能返回 null，表示取不到有效值。 |
| ConnectType | String | 连接类型 注意：此字段可能返回 null，表示取不到有效值。 |
| ProjectId | String | 项目id 注意：此字段可能返回 null，表示取不到有效值。 |
| Desc | String | 数据源描述 注意：此字段可能返回 null，表示取不到有效值。 |
| Status | String | 数据源状态 注意：此字段可能返回 null，表示取不到有效值。 |
| SourcePlat | String | 来源平台 注意：此字段可能返回 null，表示取不到有效值。 |
| ExtraParam | String | 扩展参数 注意：此字段可能返回 null，表示取不到有效值。 |
| AddInfo | String | 额外信息 注意：此字段可能返回 null，表示取不到有效值。 |
| ProjectName | String | 项目名字 注意：此字段可能返回 null，表示取不到有效值。 |
| EngineType | String | 引擎类型 注意：此字段可能返回 null，表示取不到有效值。 |
| Manager | String | 数据源负责人 注意：此字段可能返回 null，表示取不到有效值。 |
| OperatorWhitelist | String | 特定操作人员白名单 注意：此字段可能返回 null，表示取不到有效值。 |
| VpcId | String | 数据源的vpc信息 注意：此字段可能返回 null，表示取不到有效值。 |
| UniqVpcId | String | 数据源的uniqVpc信息 注意：此字段可能返回 null，表示取不到有效值。 |
| RegionId | String | 数据源的地域信息 注意：此字段可能返回 null，表示取不到有效值。 |
| StateAction | BaseStateAction | 操作属性 注意：此字段可能返回 null，表示取不到有效值。 |
| UpdatedUser | String | 更新人 注意：此字段可能返回 null，表示取不到有效值。 |
| PermissionList | Array of PermissionGroup | 权限列表 注意：此字段可能返回 null，表示取不到有效值。 |
| AuthList | Array of String | 权限值列表 注意：此字段可能返回 null，表示取不到有效值。 |
| DataOrigin | String | 第三方数据源标识 注意：此字段可能返回 null，表示取不到有效值。 |
| DataOriginProjectId | String | 第三方项目id 注意：此字段可能返回 null，表示取不到有效值。 |
| DataOriginDatasourceId | String | 第三方数据源id 注意：此字段可能返回 null，表示取不到有效值。 |
| ClusterId | String | 集群id 注意：此字段可能返回 null，表示取不到有效值。 |
| DbTypeName | String | 数据源名称 注意：此字段可能返回 null，表示取不到有效值。 |
| UseVPC | Boolean | 开启vpc 注意：此字段可能返回 null，表示取不到有效值。 |
| Owner | String | 所属人ID 注意：此字段可能返回 null，表示取不到有效值。 |
| OwnerName | String | 所属人名称 注意：此字段可能返回 null，表示取不到有效值。 |
| Schema | String | 数据库schema 注意：此字段可能返回 null，表示取不到有效值。 |
| DbVersion | String | 数据库版本 注意：此字段可能返回 null，表示取不到有效值。 |
数据源详情列表
被如下接口引用：DescribeDatasourceList。
| 名称 | 类型 | 描述 |
|---|---|---|
| List | Array of DatasourceInfo | 数据源详情列表 注意：此字段可能返回 null，表示取不到有效值。 |
| Total | Integer | 总数 注意：此字段可能返回 null，表示取不到有效值。 |
| TotalPages | Integer | 总页数 注意：此字段可能返回 null，表示取不到有效值。 |
报表嵌出数据结构-强鉴权
被如下接口引用：CreateEmbedToken。
| 名称 | 类型 | 描述 |
|---|---|---|
| Id | Integer | 信息标识 注意：此字段可能返回 null，表示取不到有效值。 |
| BIToken | String | 令牌 注意：此字段可能返回 null，表示取不到有效值。 |
| ProjectId | String | 项目Id 注意：此字段可能返回 null，表示取不到有效值。 |
| CreatedUser | String | 创建人 注意：此字段可能返回 null，表示取不到有效值。 |
| CreatedAt | String | 创建时间 注意：此字段可能返回 null，表示取不到有效值。 |
| UpdatedUser | String | 更新人 注意：此字段可能返回 null，表示取不到有效值。 |
| UpdatedAt | String | 更新时间 注意：此字段可能返回 null，表示取不到有效值。 |
| PageId | String | 页面Id 注意：此字段可能返回 null，表示取不到有效值。 |
| ExtraParam | String | 备用 注意：此字段可能返回 null，表示取不到有效值。 |
| Scope | String | 嵌出类型 注意：此字段可能返回 null，表示取不到有效值。 |
| ExpireTime | Integer | 过期时间，分钟为单位，最大240 注意：此字段可能返回 null，表示取不到有效值。 |
| UserCorpId | String | 使用者企业Id(仅用于多用户) 注意：此字段可能返回 null，表示取不到有效值。 |
| UserId | String | 使用者Id(仅用于多用户) 注意：此字段可能返回 null，表示取不到有效值。 |
| TicketNum | Integer | 访问次数限制，限制范围1-99999，为空则不设置访问次数限制 注意：此字段可能返回 null，表示取不到有效值。 |
| GlobalParam | String | 全局参数 注意：此字段可能返回 null，表示取不到有效值。 |
| Intention | String | embed表示页面看板嵌出，chatBIEmbed表示ChatBI嵌出 注意：此字段可能返回 null，表示取不到有效值。 |
| TokenType | Integer | 100 无绑定用户 200 单用户单token 300 单用户 多token 注意：此字段可能返回 null，表示取不到有效值。 |
| TokenNum | Integer | token 数 注意：此字段可能返回 null，表示取不到有效值。 |
| SingleUserMultiToken | Boolean | 是否单用户多token 注意：此字段可能返回 null，表示取不到有效值。 |
| ConfigParam | String | 嵌出显示配置，目前为ChatBI嵌出场景用，TableFilter表示数据表列表过滤，SqlView表示sql查看功能 注意：此字段可能返回 null，表示取不到有效值。 |
空值展示样式配置值结构
被如下接口引用：CreateDataTable, DescribeSourceFieldList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Type | String | 否 | 空值展示样式类型 注意：此字段可能返回 null，表示取不到有效值。 |
| Custom | String | 否 | 空值展示样式类型对应具体的展示字符串 注意：此字段可能返回 null，表示取不到有效值。 |
空值展示样式配置结构
被如下接口引用：CreateDataTable, DescribeSourceFieldList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Number | EmptyValue | 否 | 数值类字段空值样式配置 注意：此字段可能返回 null，表示取不到有效值。 |
| String | EmptyValue | 否 | 字符串字段空置样式配置 注意：此字段可能返回 null，表示取不到有效值。 |
自定义错误信息对象
被如下接口引用：ApplyEmbedInterval, ClearEmbedToken, CreateDataTable, CreateDatasource, CreateDatasourceCloud, CreateEmbedToken, CreatePermissionRanks, CreateProject, CreateUserRole, CreateUserRoleProject, DeleteDatasource, DeleteProject, DeleteUserRole, DeleteUserRoleProject, DescribeDatasourceList, DescribePageWidgetList, DescribeProjectInfo, DescribeProjectList, DescribeSourceFieldList, DescribeUserProjectList, DescribeUserRoleList, DescribeUserRoleProjectList, ExportScreenPage, ModifyDatasource, ModifyDatasourceCloud, ModifyProject, ModifyResourceUser, ModifyResourceUserGroupResource, ModifyUserRole, ModifyUserRoleProject。
| 名称 | 类型 | 描述 |
|---|---|---|
| ErrorTip | String | 错误说明字段 注意：此字段可能返回 null，表示取不到有效值。 |
| ErrorMessage | String | 原始异常信息 注意：此字段可能返回 null，表示取不到有效值。 |
| ErrorLevel | String | 错误等级字段 ERROR WARN INFO 注意：此字段可能返回 null，表示取不到有效值。 |
| DocLink | String | 指引文档链接 注意：此字段可能返回 null，表示取不到有效值。 |
| FAQ | String | 快速指引说明 注意：此字段可能返回 null，表示取不到有效值。 |
| ReservedField | String | 预留字段1 注意：此字段可能返回 null，表示取不到有效值。 |
字段备注信息
被如下接口引用：CreateDataTable。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| FieldName | String | 否 | 字段名 注意：此字段可能返回 null，表示取不到有效值。 |
| Comment | Array of String | 否 | 字段备注列表 注意：此字段可能返回 null，表示取不到有效值。 |
定时任务执行频率配置
被如下接口引用：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，表示取不到有效值。 |
仅包含id的对象
被如下接口引用：CreateDataTable, CreateDatasource, CreateDatasourceCloud。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Id | Integer | 是 | 请求id 注意：此字段可能返回 null，表示取不到有效值。 |
| AccessKey | String | 否 | key 注意：此字段可能返回 null，表示取不到有效值。 |
| ProjectId | Integer | 否 | id 注意：此字段可能返回 null，表示取不到有效值。 |
| TranId | String | 否 | 事务id 注意：此字段可能返回 null，表示取不到有效值。 |
| TranStatus | Integer | 否 | 事务状态 枚举值：
注意：此字段可能返回 null，表示取不到有效值。 |
多表关联原始表之间的关联信息
被如下接口引用：CreateDataTable。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| JoinId | String | 否 | 表关联关系id,前端使用 注意：此字段可能返回 null，表示取不到有效值。 |
| SourceTableNodeId | String | 否 | 原表节点id 注意：此字段可能返回 null，表示取不到有效值。 |
| TargetTableNodeId | String | 否 | 目标表节点id 注意：此字段可能返回 null，表示取不到有效值。 |
| JoinType | String | 否 | 多表关联的关联类型 注意：此字段可能返回 null，表示取不到有效值。 |
| Fields | Array of JoinRelationField | 否 | 多表关联的字段列表 注意：此字段可能返回 null，表示取不到有效值。 |
多表关联原始表之间使用的关联字段信息
被如下接口引用：CreateDataTable。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| FieldJoinId | String | 否 | 字段关联关系id,前端使用 注意：此字段可能返回 null，表示取不到有效值。 |
| SourceField | TableField | 否 | 原表字段 注意：此字段可能返回 null，表示取不到有效值。 |
| TargetField | TableField | 否 | 目标表字段 注意：此字段可能返回 null，表示取不到有效值。 |
多表关联原始表信息
被如下接口引用：CreateDataTable。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TableNodeType | Integer | 否 | 1:数据源原表,2:本地表,3:Excel表,4:API表 注意：此字段可能返回 null，表示取不到有效值。 |
| TableNodeId | String | 否 | 原始表节点Id 注意：此字段可能返回 null，表示取不到有效值。 |
| ParentId | String | 否 | 父节点id 注意：此字段可能返回 null，表示取不到有效值。 |
| TableId | String | 否 | 非必填, 数据源原表没有ID 注意：此字段可能返回 null，表示取不到有效值。 |
| TableName | String | 否 | 必填,数据源原表用原始表名, 其他类型用BI的逻辑表名 注意：此字段可能返回 null，表示取不到有效值。 |
| Fields | Array of TableField | 否 | 原始表需要展示的字段列表 注意：此字段可能返回 null，表示取不到有效值。 |
| DatasourceId | Integer | 否 | 数据源id 注意：此字段可能返回 null，表示取不到有效值。 |
| TableAlias | String | 否 | 非必填,前端展示的数据源别名,excel建表需要 注意：此字段可能返回 null，表示取不到有效值。 |
页面截图列表
被如下接口引用：ExportScreenPage。
| 名称 | 类型 | 描述 |
|---|---|---|
| PicType | String | 图片导出类型。base64；url 注意：此字段可能返回 null，表示取不到有效值。 |
| List | Array of PageScreenVO | 图片列表 注意：此字段可能返回 null，表示取不到有效值。 |
| TranId | String | 异步事务id 注意：此字段可能返回 null，表示取不到有效值。 |
| TranStatus | Integer | 事务状态 1: 处理中; 2: 处理成功; 3 处理失败(错误内容见外层Msg) 注意：此字段可能返回 null，表示取不到有效值。 |
页面截图信息
被如下接口引用：ExportScreenPage。
| 名称 | 类型 | 描述 |
|---|---|---|
| Content | String | 截图base64或 url 注意：此字段可能返回 null，表示取不到有效值。 |
| WidgetId | String | 组件Id 注意：此字段可能返回 null，表示取不到有效值。 |
1
被如下接口引用：CreateDataTable, DescribeSourceFieldList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ParamName | String | 否 | 参数名 注意：此字段可能返回 null，表示取不到有效值。 |
| DefaultValue | String | 否 | 默认值 注意：此字段可能返回 null，表示取不到有效值。 |
| ParamType | String | 否 | 参数类型，string/datetime/number 注意：此字段可能返回 null，表示取不到有效值。 |
| FormatRule | String | 否 | 格式化类型，yyyy-MM-dd HH:mm:ss.SSS（只有时间必填） 注意：此字段可能返回 null，表示取不到有效值。 |
| ComplexType | String | 否 | 复杂类型，格式化的另一种表达，例如YYYY-MM 注意：此字段可能返回 null，表示取不到有效值。 |
| Scope | String | 否 | 作用域 注意：此字段可能返回 null，表示取不到有效值。 |
商业版本权限单元
被如下接口引用：DescribeDatasourceList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ModuleId | String | 否 | 权限值 注意：此字段可能返回 null，表示取不到有效值。 |
| IncludeType | String | 否 | 可用性 枚举值：
默认值：disabled 注意：此字段可能返回 null，表示取不到有效值。 |
| UpgradeVersionType | String | 否 | 目标升级版本 注意：此字段可能返回 null，表示取不到有效值。 |
| Tips | String | 否 | 补充信息 注意：此字段可能返回 null，表示取不到有效值。 |
| TipsKey | String | 否 | 补充信息的key值 注意：此字段可能返回 null，表示取不到有效值。 |
商业化版本权限分组
被如下接口引用：DescribeDatasourceList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ModuleGroup | String | 否 | 分组名 注意：此字段可能返回 null，表示取不到有效值。 |
| Components | Array of PermissionComponent | 否 | 权限列表 注意：此字段可能返回 null，表示取不到有效值。 |
项目信息描述
被如下接口引用：DescribeProjectInfo, DescribeProjectList。
| 名称 | 类型 | 描述 |
|---|---|---|
| Id | Integer | 项目ID |
| Logo | String | 项目Logo 注意：此字段可能返回 null，表示取不到有效值。 |
| Name | String | 项目名称 注意：此字段可能返回 null，表示取不到有效值。 |
| ColorCode | String | logo底色 注意：此字段可能返回 null，表示取不到有效值。 |
| CreatedUser | String | 创建人 注意：此字段可能返回 null，表示取不到有效值。 |
| CreatedAt | String | 创建时间 注意：此字段可能返回 null，表示取不到有效值。 |
| MemberCount | Integer | 成员个数 注意：此字段可能返回 null，表示取不到有效值。 |
| PageCount | Integer | 页面个数 注意：此字段可能返回 null，表示取不到有效值。 |
| LastModifyName | String | 最后修改报表、简报名称 注意：此字段可能返回 null，表示取不到有效值。 |
| Source | String | "" 注意：此字段可能返回 null，表示取不到有效值。 |
| Apply | Boolean | "" 注意：此字段可能返回 null，表示取不到有效值。 |
| UpdatedUser | String | "" 注意：此字段可能返回 null，表示取不到有效值。 |
| UpdatedAt | String | "" 注意：此字段可能返回 null，表示取不到有效值。 |
| CorpId | String | "" 注意：此字段可能返回 null，表示取不到有效值。 |
| Mark | String | "" 注意：此字段可能返回 null，表示取不到有效值。 |
| Seed | String | "" 注意：此字段可能返回 null，表示取不到有效值。 |
| AuthList | Array of String | 项目内权限列表 注意：此字段可能返回 null，表示取不到有效值。 |
| PanelScope | String | 默认看板 注意：此字段可能返回 null，表示取不到有效值。 |
| IsExternalManage | Boolean | 是否被托管 注意：此字段可能返回 null，表示取不到有效值。 |
| ManagePlatform | String | 托管平台名称 注意：此字段可能返回 null，表示取不到有效值。 |
| ConfigList | Array of ProjectConfigList | 定制化参数 注意：此字段可能返回 null，表示取不到有效值。 |
| CreatedUserName | String | 创建人 注意：此字段可能返回 null，表示取不到有效值。 |
| Owner | String | 所属人id 注意：此字段可能返回 null，表示取不到有效值。 |
| OwnerName | String | 所属人 注意：此字段可能返回 null，表示取不到有效值。 |
| NormalCount | Integer | 仪表盘页面数 注意：此字段可能返回 null，表示取不到有效值。 |
| FreeCount | Integer | 自由画布页面数 注意：此字段可能返回 null，表示取不到有效值。 |
| AdhocCount | Integer | 即席分析页面数 注意：此字段可能返回 null，表示取不到有效值。 |
| BriefingCount | Integer | 简报页面数 注意：此字段可能返回 null，表示取不到有效值。 |
定制化查询
被如下接口引用：DescribeProjectInfo。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ModuleGroup | String | 否 | 模块组 注意：此字段可能返回 null，表示取不到有效值。 |
| Components | Array of ProjectConfigResult | 否 | 内容 注意：此字段可能返回 null，表示取不到有效值。 |
定制化查询
被如下接口引用：DescribeProjectInfo。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ModuleId | String | 否 | 配置名称 注意：此字段可能返回 null，表示取不到有效值。 |
| IncludeType | String | 否 | 配置方式 枚举值：
默认值：disabled 注意：此字段可能返回 null，表示取不到有效值。 |
| Params | String | 否 | 额外参数 注意：此字段可能返回 null，表示取不到有效值。 |
项目列表数据
被如下接口引用：DescribeProjectList。
| 名称 | 类型 | 描述 |
|---|---|---|
| List | Array of Project | 数组 注意：此字段可能返回 null，表示取不到有效值。 |
| Total | Integer | 总数 注意：此字段可能返回 null，表示取不到有效值。 |
| TotalPages | Integer | 1 注意：此字段可能返回 null，表示取不到有效值。 |
资源
被如下接口引用：ModifyResourceUser, ModifyResourceUserGroupResource。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ResourceName | String | 否 | 资源名称 注意：此字段可能返回 null，表示取不到有效值。 |
| ResourceValue | Boolean | 否 | 资源值 注意：此字段可能返回 null，表示取不到有效值。 |
| CanChange | Boolean | 否 | 是否可变更 注意：此字段可能返回 null，表示取不到有效值。 |
| Tips | String | 否 | 提示信息 注意：此字段可能返回 null，表示取不到有效值。 |
行列权限配置
被如下接口引用：CreatePermissionRanks。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| RulerInfo | String | 否 | 行列权限规则 注意：此字段可能返回 null，表示取不到有效值。 |
| TagValueList | Array of RowColumnTagValue | 否 | 标签值列表 注意：此字段可能返回 null，表示取不到有效值。 |
行列权限标签出入参
被如下接口引用：CreatePermissionRanks。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Id | Integer | 否 | 标签id 注意：此字段可能返回 null，表示取不到有效值。 |
| Name | String | 否 | 标签名称 注意：此字段可能返回 null，表示取不到有效值。 |
| Values | Array of String | 否 | 标签值列表 注意：此字段可能返回 null，表示取不到有效值。 |
表的列数据抽象
被如下接口引用：DescribeSourceFieldList。
| 名称 | 类型 | 描述 |
|---|---|---|
| DbName | String | 列名字 注意：此字段可能返回 null，表示取不到有效值。 |
| AliasName | String | 列的别名 注意：此字段可能返回 null，表示取不到有效值。 |
| DbType | String | 列的类型 注意：此字段可能返回 null，表示取不到有效值。 |
| FieldType | String | 段类型 注意：此字段可能返回 null，表示取不到有效值。 |
| Mark | String | 备注 注意：此字段可能返回 null，表示取不到有效值。 |
| ExcelName | String | excel名 注意：此字段可能返回 null，表示取不到有效值。 |
| DictId | Integer | 关联的字典表Id 注意：此字段可能返回 null，表示取不到有效值。 |
| DictName | String | 关联的字典表表名 注意：此字段可能返回 null，表示取不到有效值。 |
| TableNodeId | String | 多表关联新增字段 注意：此字段可能返回 null，表示取不到有效值。 |
| TableName | String | 字段所属的表名 注意：此字段可能返回 null，表示取不到有效值。 |
| FieldComplexType | String | 用户设置的带格式的目标复杂格式 注意：此字段可能返回 null，表示取不到有效值。 |
| FormatRule | String | 格式规则 注意：此字段可能返回 null，表示取不到有效值。 |
| IsFilter | Boolean | 数据字段是否过滤空值 注意：此字段可能返回 null，表示取不到有效值。 |
| CalcType | String | 计算字段类型 注意：此字段可能返回 null，表示取不到有效值。 |
| CalcFormula | String | 计算字段的公式内容 注意：此字段可能返回 null，表示取不到有效值。 |
| CalcDesc | String | 计算字段的中文公式内容 注意：此字段可能返回 null，表示取不到有效值。 |
| JsonPathName | String | Api数据源json路径名称 注意：此字段可能返回 null，表示取不到有效值。 |
| Granularity | String | 地理类型标识 注意：此字段可能返回 null，表示取不到有效值。 |
| GeoJsonId | Integer | 自定义地图Id 注意：此字段可能返回 null，表示取不到有效值。 |
| EmptyValueConfig | EmptyValueConfig | 空值展示样式配置 注意：此字段可能返回 null，表示取不到有效值。 |
| DbFieldName | String | 原列名称 注意：此字段可能返回 null，表示取不到有效值。 |
| IsCopyOperation | Boolean | 是否是复制字段操作 注意：此字段可能返回 null，表示取不到有效值。 |
| IsCopyFromNormal | Boolean | 是否从普通字段复制 注意：此字段可能返回 null，表示取不到有效值。 |
表的全部列名数据列表
被如下接口引用：DescribeSourceFieldList。
| 名称 | 类型 | 描述 |
|---|---|---|
| List | Array of TableColumn | 表中的列的列表 注意：此字段可能返回 null，表示取不到有效值。 |
| TranId | String | 异步事务id 注意：此字段可能返回 null，表示取不到有效值。 |
| TranStatus | Integer | 异步事务状态 注意：此字段可能返回 null，表示取不到有效值。 |
表字段描述
被如下接口引用：CreateDataTable。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| DbName | String | 是 | db里的字段column名 |
| AliasName | String | 是 | bi展示名 |
| DbType | String | 是 | db里的字段类型 |
| FieldType | String | 是 | BI归类后的抽象字段类型,比如字符串,数字,时间 |
| FieldComplexType | String | 否 | 字段组合计算公式后生成的复杂明细类型 注意：此字段可能返回 null，表示取不到有效值。 |
| Mark | String | 否 | 字段描述 注意：此字段可能返回 null，表示取不到有效值。 |
| FormatRule | String | 否 | 字段计算公式 注意：此字段可能返回 null，表示取不到有效值。 |
| IsFilter | Boolean | 否 | 数据字段是否过滤空值 注意：此字段可能返回 null，表示取不到有效值。 |
| CalcType | String | 否 | 计算字段类型 注意：此字段可能返回 null，表示取不到有效值。 |
| CalcFormula | String | 否 | 计算字段的公式内容 注意：此字段可能返回 null，表示取不到有效值。 |
| CalcDesc | String | 否 | 计算字段的中文公式内容, 前端展示使用 注意：此字段可能返回 null，表示取不到有效值。 |
| DictId | Integer | 否 | 关联字典表id 注意：此字段可能返回 null，表示取不到有效值。 |
| DictName | String | 否 | 关联字典表名 注意：此字段可能返回 null，表示取不到有效值。 |
| TableNodeId | String | 否 | 非必填, 多表关联新增字段 注意：此字段可能返回 null，表示取不到有效值。 |
| ExcelName | String | 否 | excel 注意：此字段可能返回 null，表示取不到有效值。 |
| TableName | String | 否 | 非必填,多表关联新增字段,字段所属的表名 注意：此字段可能返回 null，表示取不到有效值。 |
| JsonPathName | String | 否 | api数据源路径名 注意：此字段可能返回 null，表示取不到有效值。 |
| Granularity | String | 否 | 地理字段标识 注意：此字段可能返回 null，表示取不到有效值。 |
| GeoJsonId | Integer | 否 | 地图id 注意：此字段可能返回 null，表示取不到有效值。 |
| EmptyValueConfig | EmptyValueConfig | 否 | 空值展示样式配置 注意：此字段可能返回 null，表示取不到有效值。 |
| DbFieldName | String | 否 | 原列名称 注意：此字段可能返回 null，表示取不到有效值。 |
| IsCopyOperation | Boolean | 否 | 是否是复制字段操作 注意：此字段可能返回 null，表示取不到有效值。 |
| IsCopyFromNormal | Boolean | 否 | 是否从普通字段复制 注意：此字段可能返回 null，表示取不到有效值。 |
用户组
被如下接口引用：DescribeUserRoleList, DescribeUserRoleProjectList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Id | Integer | 否 | id 注意：此字段可能返回 null，表示取不到有效值。 |
| GroupName | String | 否 | 用户组名称 注意：此字段可能返回 null，表示取不到有效值。 |
| ParentId | Integer | 否 | 父节点id 注意：此字段可能返回 null，表示取不到有效值。 |
| IsDefault | Integer | 否 | 是否为默认 注意：此字段可能返回 null，表示取不到有效值。 |
| AdminUserId | String | 否 | 管理员用户id 注意：此字段可能返回 null，表示取不到有效值。 |
| Description | String | 否 | 描述 注意：此字段可能返回 null，表示取不到有效值。 |
| Location | Integer | 否 | 定位 注意：此字段可能返回 null，表示取不到有效值。 |
用户ID和用户名
被如下接口引用：DescribeUserProjectList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| UserId | String | 否 | 用户ID |
| UserName | String | 否 | 用户名 |
| CorpId | String | 否 | 企业ID 注意：此字段可能返回 null，表示取不到有效值。 |
| String | 否 | 电子邮箱 注意：此字段可能返回 null，表示取不到有效值。 |
|
| LastLogin | Timestamp ISO8601 | 否 | 最后一次登录时间 注意：此字段可能返回 null，表示取不到有效值。 |
| Status | Integer | 否 | 用户状态 枚举值：
默认值：1 注意：此字段可能返回 null，表示取不到有效值。 |
| FirstModify | Integer | 否 | 首次登录是否修改密码 注意：此字段可能返回 null，表示取不到有效值。 |
| PhoneNumber | String | 否 | 手机号码 注意：此字段可能返回 null，表示取不到有效值。 |
| AreaCode | String | 否 | 手机区号 注意：此字段可能返回 null，表示取不到有效值。 |
| CreatedUser | String | 否 | 创建人 注意：此字段可能返回 null，表示取不到有效值。 |
| CreatedAt | Timestamp ISO8601 | 否 | 创建时间 注意：此字段可能返回 null，表示取不到有效值。 |
| UpdatedUser | String | 否 | 修改人 注意：此字段可能返回 null，表示取不到有效值。 |
| UpdatedAt | Timestamp ISO8601 | 否 | 更改时间 注意：此字段可能返回 null，表示取不到有效值。 |
| GlobalUserName | String | 否 | 系统全局角色 注意：此字段可能返回 null，表示取不到有效值。 |
| GlobalUserCode | String | 否 | 系统全局角色编码 注意：此字段可能返回 null，表示取不到有效值。 |
| Mobile | String | 否 | 手机号 注意：此字段可能返回 null，表示取不到有效值。 |
| AppId | String | 否 | 1 注意：此字段可能返回 null，表示取不到有效值。 |
| AppUserId | String | 否 | 1 注意：此字段可能返回 null，表示取不到有效值。 |
| AppUserAliasName | String | 否 | 1 注意：此字段可能返回 null，表示取不到有效值。 |
| AppUserName | String | 否 | 1 注意：此字段可能返回 null，表示取不到有效值。 |
| InValidateAppRange | Boolean | 否 | 1 注意：此字段可能返回 null，表示取不到有效值。 |
| EmailActivationStatus | Integer | 否 | -1 免激活 0 未激活 1 已激活 空代表待绑定 注意：此字段可能返回 null，表示取不到有效值。 |
| Id | Integer | 否 | 1 注意：此字段可能返回 null，表示取不到有效值。 |
用户ID和用户名
被如下接口引用：CreateUserRole, CreateUserRoleProject。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| UserId | String | 否 | 用户ID |
| UserName | String | 否 | 用户名 |
| String | 否 | 邮箱 注意：此字段可能返回 null，表示取不到有效值。 |
|
| PhoneNumber | String | 否 | 手机号 注意：此字段可能返回 null，表示取不到有效值。 |
| AreaCode | String | 否 | 手机号区号 注意：此字段可能返回 null，表示取不到有效值。 |
| AppUserId | String | 否 | 企微账号id 注意：此字段可能返回 null，表示取不到有效值。 |
| AppUserName | String | 否 | 企微账号名称 注意：此字段可能返回 null，表示取不到有效值。 |
用户资源入参
被如下接口引用：ModifyResourceUser, ModifyResourceUserGroupResource。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| CorpId | String | 否 | 企业id 注意：此字段可能返回 null，表示取不到有效值。 |
| UserId | String | 否 | 用户id 注意：此字段可能返回 null，表示取不到有效值。 |
| UserName | String | 否 | 用户名 注意：此字段可能返回 null，表示取不到有效值。 |
| ResourceList | Array of ResourceItem | 否 | 资源列表 注意：此字段可能返回 null，表示取不到有效值。 |
用户角色信息
被如下接口引用：DescribeUserRoleList, DescribeUserRoleProjectList。
| 名称 | 类型 | 描述 |
|---|---|---|
| Total | Integer | 总数 注意：此字段可能返回 null，表示取不到有效值。 |
| TotalPages | Integer | 总页数 注意：此字段可能返回 null，表示取不到有效值。 |
| List | Array of UserRoleListDataUserRoleInfo | 列表 注意：此字段可能返回 null，表示取不到有效值。 |
用户角色列表角色信息
被如下接口引用：DescribeUserRoleList, DescribeUserRoleProjectList。
| 名称 | 类型 | 描述 |
|---|---|---|
| RoleName | String | 角色名字 注意：此字段可能返回 null，表示取不到有效值。 |
| RoleId | Integer | 角色ID 注意：此字段可能返回 null，表示取不到有效值。 |
| ProjectId | Integer | 项目ID 注意：此字段可能返回 null，表示取不到有效值。 |
| ProjectName | String | 项目名字 注意：此字段可能返回 null，表示取不到有效值。 |
| ScopeType | Integer | 是否为全局角色（0 不是 1 是） 注意：此字段可能返回 null，表示取不到有效值。 |
| ModuleCollection | String | 角色key 注意：此字段可能返回 null，表示取不到有效值。 |
用户角色信息
被如下接口引用：DescribeUserRoleList, DescribeUserRoleProjectList。
| 名称 | 类型 | 描述 |
|---|---|---|
| Id | Integer | 业务ID |
| RoleList | Array of UserRoleListDataRoleInfo | 角色列表 注意：此字段可能返回 null，表示取不到有效值。 |
| RoleIdList | Array of Integer | 角色ID列表 注意：此字段可能返回 null，表示取不到有效值。 |
| UserId | String | 用户ID |
| UserName | String | 用户名 |
| CorpId | String | 企业ID |
| String | 邮箱 注意：此字段可能返回 null，表示取不到有效值。 |
|
| CreatedUser | String | 创建人 注意：此字段可能返回 null，表示取不到有效值。 |
| CreatedAt | String | 创建时间 注意：此字段可能返回 null，表示取不到有效值。 |
| UpdatedUser | String | 更新人 注意：此字段可能返回 null，表示取不到有效值。 |
| UpdatedAt | String | 更新时间 注意：此字段可能返回 null，表示取不到有效值。 |
| LastLogin | Timestamp ISO8601 | 最后一次登录时间 注意：此字段可能返回 null，表示取不到有效值。 |
| Status | Integer | 账号状态 注意：此字段可能返回 null，表示取不到有效值。 |
| PhoneNumber | String | 手机号码 注意：此字段可能返回 null，表示取不到有效值。 |
| AreaCode | String | 手机号区号 注意：此字段可能返回 null，表示取不到有效值。 |
| RootAccount | Boolean | 是否为主账号 注意：此字段可能返回 null，表示取不到有效值。 |
| CorpAdmin | Boolean | 是否为企业管理员 注意：此字段可能返回 null，表示取不到有效值。 |
| AppUserId | String | 企微用户id 注意：此字段可能返回 null，表示取不到有效值。 |
| AppUserAliasName | String | 昵称 注意：此字段可能返回 null，表示取不到有效值。 |
| AppUserName | String | 应用用户名 注意：此字段可能返回 null，表示取不到有效值。 |
| InValidateAppRange | Boolean | 是否在可见范围内 注意：此字段可能返回 null，表示取不到有效值。 |
| AppOpenUserId | String | 用户openid 注意：此字段可能返回 null，表示取不到有效值。 |
| EmailActivationStatus | Integer | 邮箱激活状态 注意：此字段可能返回 null，表示取不到有效值。 |
| UserGroupList | Array of UserGroupDTO | 用户组信息 注意：此字段可能返回 null，表示取不到有效值。 |
页面组件信息
被如下接口引用：DescribePageWidgetList。
| 名称 | 类型 | 描述 |
|---|---|---|
| CorpId | String | uin 注意：此字段可能返回 null，表示取不到有效值。 |
| ProjectId | String | 项目id 注意：此字段可能返回 null，表示取不到有效值。 |
| PageId | String | 页面id 注意：此字段可能返回 null，表示取不到有效值。 |
| WidgetList | Array of WidgetVO | 组件数组 注意：此字段可能返回 null，表示取不到有效值。 |
组件信息
被如下接口引用：DescribePageWidgetList。
| 名称 | 类型 | 描述 |
|---|---|---|
| WidgetId | String | 组件Id 注意：此字段可能返回 null，表示取不到有效值。 |
| WidgetName | String | 组件name 注意：此字段可能返回 null，表示取不到有效值。 |
文档反馈