ApplyEmbedTokenInfo
申请Token延期
被如下接口引用:ApplyEmbedInterval。
名称 | 类型 | 描述 |
---|---|---|
Result | Boolean | 申请结果 注意:此字段可能返回 null,表示取不到有效值。 示例值:false |
BaseStateAction
列表查询返回的每条记录的操作属性
被如下接口引用: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,表示取不到有效值。 |
CorpUserListData
企业用户列表
被如下接口引用:DescribeUserProjectList。
名称 | 类型 | 描述 |
---|---|---|
List | Array of UserIdAndUserName | 列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
Total | Integer | 总数 示例值:1 |
TotalPages | Integer | 页数 示例值:1 |
Data
数据
被如下接口引用:CreateProject。
名称 | 类型 | 描述 |
---|---|---|
Id | Integer | 项目Id 示例值:1 |
DataId
数据ID
被如下接口引用: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,表示取不到有效值。 示例值:test |
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,表示取不到有效值。 |
DatasourceInfoData
数据源详情列表
被如下接口引用:DescribeDatasourceList。
名称 | 类型 | 描述 |
---|---|---|
List | Array of DatasourceInfo | 数据源详情列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:{"Id": 1} |
Total | Integer | 总数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
TotalPages | Integer | 总页数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
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,表示取不到有效值。 示例值:"" |
Scope | String | 嵌出类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:"" |
ExpireTime | Integer | 过期时间,分钟为单位,最大240 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
UserCorpId | String | 使用者企业Id(仅用于多用户) 注意:此字段可能返回 null,表示取不到有效值。 示例值:"" |
UserId | String | 使用者Id(仅用于多用户) 注意:此字段可能返回 null,表示取不到有效值。 示例值:"" |
TicketNum | Integer | 访问次数限制,限制范围1-99999,为空则不设置访问次数限制 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
GlobalParam | String | 全局参数 注意:此字段可能返回 null,表示取不到有效值。 |
ErrorInfo
自定义错误信息对象
被如下接口引用:ApplyEmbedInterval, CreateDatasource, CreateDatasourceCloud, CreateEmbedToken, CreateProject, CreateUserRole, CreateUserRoleProject, DeleteDatasource, DeleteProject, DeleteUserRole, DeleteUserRoleProject, DescribeDatasourceList, DescribeProjectInfo, DescribeProjectList, DescribeUserProjectList, DescribeUserRoleList, DescribeUserRoleProjectList, ModifyDatasource, ModifyDatasourceCloud, ModifyProject, ModifyUserRole, ModifyUserRoleProject。
名称 | 类型 | 描述 |
---|---|---|
ErrorTip | String | 错误说明字段 注意:此字段可能返回 null,表示取不到有效值。 |
ErrorMessage | String | 原始异常信息 注意:此字段可能返回 null,表示取不到有效值。 |
ErrorLevel | String | 错误等级字段 ERROR WARN INFO 注意:此字段可能返回 null,表示取不到有效值。 |
DocLink | String | 指引文档链接 注意:此字段可能返回 null,表示取不到有效值。 |
FAQ | String | 快速指引说明 注意:此字段可能返回 null,表示取不到有效值。 |
ReservedField | String | 预留字段1 注意:此字段可能返回 null,表示取不到有效值。 |
IdDTO
仅包含id的对象
被如下接口引用:CreateDatasource, CreateDatasourceCloud。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Id | Integer | 是 | 请求id 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
AccessKey | String | 否 | key 注意:此字段可能返回 null,表示取不到有效值。 示例值:abc |
ProjectId | Integer | 否 | id 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
TranId | String | 否 | 事务id 注意:此字段可能返回 null,表示取不到有效值。 |
TranStatus | Integer | 否 | 事务状态 注意:此字段可能返回 null,表示取不到有效值。 |
PermissionComponent
商业版本权限单元
被如下接口引用:DescribeDatasourceList。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ModuleId | String | 否 | 权限值 注意:此字段可能返回 null,表示取不到有效值。 示例值:"" |
IncludeType | String | 否 | 可见/可用 注意:此字段可能返回 null,表示取不到有效值。 示例值:"" |
UpgradeVersionType | String | 否 | 目标升级版本 注意:此字段可能返回 null,表示取不到有效值。 示例值:"" |
Tips | String | 否 | 补充信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:"" |
TipsKey | String | 否 | 补充信息的key值 注意:此字段可能返回 null,表示取不到有效值。 示例值:"" |
PermissionGroup
商业化版本权限分组
被如下接口引用:DescribeDatasourceList。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ModuleGroup | String | 否 | 分组名 注意:此字段可能返回 null,表示取不到有效值。 示例值:"" |
Components | Array of PermissionComponent | 否 | 权限列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:null |
Project
项目信息描述
被如下接口引用:DescribeProjectInfo, DescribeProjectList。
名称 | 类型 | 描述 |
---|---|---|
Id | Integer | 项目ID 示例值:1 |
Logo | String | 项目Logo 注意:此字段可能返回 null,表示取不到有效值。 示例值:"" |
Name | String | 项目名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:"" |
ColorCode | String | logo底色 注意:此字段可能返回 null,表示取不到有效值。 示例值:"" |
CreatedUser | String | 创建人 注意:此字段可能返回 null,表示取不到有效值。 示例值:"" |
CreatedAt | String | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:"" |
MemberCount | Integer | 成员个数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
PageCount | Integer | 页面个数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
LastModifyName | String | 最后修改报表、简报名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:"" |
Source | String | "" 注意:此字段可能返回 null,表示取不到有效值。 示例值:"" |
Apply | Boolean | "" 注意:此字段可能返回 null,表示取不到有效值。 示例值:false |
UpdatedUser | String | "" 注意:此字段可能返回 null,表示取不到有效值。 示例值:"" |
UpdatedAt | String | "" 注意:此字段可能返回 null,表示取不到有效值。 示例值:"" |
CorpId | String | "" 注意:此字段可能返回 null,表示取不到有效值。 示例值:"corp123" |
Mark | String | "" 注意:此字段可能返回 null,表示取不到有效值。 示例值:"" |
Seed | String | "" 注意:此字段可能返回 null,表示取不到有效值。 示例值:"x12738" |
AuthList | Array of String | 项目内权限列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:"" |
PanelScope | String | 默认看板 注意:此字段可能返回 null,表示取不到有效值。 |
IsExternalManage | Boolean | 是否被托管 注意:此字段可能返回 null,表示取不到有效值。 |
ManagePlatform | String | 托管平台名称 注意:此字段可能返回 null,表示取不到有效值。 |
ConfigList | Array of ProjectConfigList | 定制化参数 注意:此字段可能返回 null,表示取不到有效值。 |
ProjectConfigList
定制化查询
被如下接口引用:DescribeProjectInfo, DescribeProjectList。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ModuleGroup | String | 否 | 模块组 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
Components | Array of ProjectConfigResult | 否 | 内容 注意:此字段可能返回 null,表示取不到有效值。 |
ProjectConfigResult
定制化查询
被如下接口引用:DescribeProjectInfo, DescribeProjectList。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ModuleId | String | 否 | 配置名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
IncludeType | String | 否 | 配置方式 注意:此字段可能返回 null,表示取不到有效值。 |
Params | String | 否 | 额外参数 注意:此字段可能返回 null,表示取不到有效值。 |
ProjectListData
项目列表数据
被如下接口引用:DescribeProjectList。
名称 | 类型 | 描述 |
---|---|---|
List | Array of Project | 数组 注意:此字段可能返回 null,表示取不到有效值。 |
Total | Integer | 总数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
TotalPages | Integer | 1 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
UserIdAndUserName
用户ID和用户名
被如下接口引用:CreateUserRole, CreateUserRoleProject, DescribeUserProjectList。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
UserId | String | 否 | 用户ID |
UserName | String | 否 | 用户名 |
CorpId | String | 否 | 企业ID 注意:此字段可能返回 null,表示取不到有效值。 |
String | 否 | 电子邮箱 注意:此字段可能返回 null,表示取不到有效值。 |
|
LastLogin | Timestamp ISO8601 | 否 | 最后一次登录时间 注意:此字段可能返回 null,表示取不到有效值。 |
Status | Integer | 否 | 停启用状态 注意:此字段可能返回 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,表示取不到有效值。 |
Mobile | String | 否 | 手机号 注意:此字段可能返回 null,表示取不到有效值。 |
AppId | String | 否 | 1 注意:此字段可能返回 null,表示取不到有效值。 |
AppUserId | String | 否 | 1 注意:此字段可能返回 null,表示取不到有效值。 |
AppUserAliasName | String | 否 | 1 注意:此字段可能返回 null,表示取不到有效值。 |
AppUserName | String | 否 | 1 注意:此字段可能返回 null,表示取不到有效值。 |
InValidateAppRange | Boolean | 否 | 1 注意:此字段可能返回 null,表示取不到有效值。 |
UserInfo
用户ID和用户名
被如下接口引用:CreateUserRole, CreateUserRoleProject。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
UserId | String | 否 | 用户ID 示例值:userID |
UserName | String | 否 | 用户名 示例值:UserName |
String | 否 | 邮箱 注意:此字段可能返回 null,表示取不到有效值。 示例值:Email |
|
PhoneNumber | String | 否 | 手机号 注意:此字段可能返回 null,表示取不到有效值。 示例值:123 |
AreaCode | String | 否 | 手机号区号 注意:此字段可能返回 null,表示取不到有效值。 示例值:086 |
AppUserId | String | 否 | 企微账号id 注意:此字段可能返回 null,表示取不到有效值。 |
AppUserName | String | 否 | 企微账号名称 注意:此字段可能返回 null,表示取不到有效值。 |
UserRoleListData
用户角色信息
被如下接口引用:DescribeUserRoleList, DescribeUserRoleProjectList。
名称 | 类型 | 描述 |
---|---|---|
Total | Integer | 总数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
TotalPages | Integer | 总页数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
List | Array of UserRoleListDataUserRoleInfo | 列表 注意:此字段可能返回 null,表示取不到有效值。 |
UserRoleListDataRoleInfo
用户角色列表角色信息
被如下接口引用:DescribeUserRoleList, DescribeUserRoleProjectList。
名称 | 类型 | 描述 |
---|---|---|
RoleName | String | 角色名字 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
RoleId | Integer | 角色ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
ProjectId | Integer | 项目ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
ProjectName | String | 项目名字 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
ScopeType | Integer | 是否为全局角色(0 不是 1 是) 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
ModuleCollection | String | 角色key 注意:此字段可能返回 null,表示取不到有效值。 |
UserRoleListDataUserRoleInfo
用户角色信息
被如下接口引用:DescribeUserRoleList, DescribeUserRoleProjectList。
名称 | 类型 | 描述 |
---|---|---|
Id | Integer | 业务ID 示例值:1 |
RoleList | Array of UserRoleListDataRoleInfo | 角色列表 注意:此字段可能返回 null,表示取不到有效值。 |
RoleIdList | Array of Integer | 角色ID列表 注意:此字段可能返回 null,表示取不到有效值。 |
UserId | String | 用户ID 示例值:1 |
UserName | String | 用户名 示例值:1 |
CorpId | String | 企业ID 示例值:1 |
String | 邮箱 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
|
CreatedUser | String | 创建人 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
CreatedAt | String | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
UpdatedUser | String | 更新人 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
UpdatedAt | String | 更新时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
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,表示取不到有效值。 |