组织管理
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
组织用户管理 | ||
AddUser![]() | 添加组织成员 | 查看文档去调试 |
deprecatedBatchAddFeishuUsers | 批量添加飞书用户 | 查看文档去调试 |
QueryUserList![]() | 查询组织成员列表信息 | 查看文档去调试 |
QueryUserInfoByUserId | 根据用户ID查询用户信息 | 查看文档去调试 |
QueryUserInfoByAccount![]() | 根据阿里云ID或阿里云账户名查询用户信息 | 查看文档去调试 |
UpdateUser | 更新组织下指定成员的信息 | 查看文档去调试 |
DeleteUser | 删除指定组织用户 | 查看文档去调试 |
组织用户组管理 | ||
CreateUserGroup | 新建用户组,可以指定父用户组 | 查看文档去调试 |
AddUserGroupMember | 将组织成员添加到指定的用户组 | 查看文档去调试 |
AddUserGroupMembers | 将用户批量添加到指定的用户组中 | 查看文档去调试 |
GetUserGroupInfo | 根据用户组名称关键字搜索用户组信息 | 查看文档去调试 |
ListByUserGroupId | 根据用户组ID批量查询用户组信息 | 查看文档去调试 |
ListUserGroupsByUserId | 根据用户的UserID,查询该用户所属的所有用户组信息 | 查看文档去调试 |
QueryUserGroupListByParentId | 获取指定父用户组下的子用户组信息 | 查看文档去调试 |
QueryUserGroupMember | 获取用户组下的成员列表信息 | 查看文档去调试 |
UpdateUserGroup | 更新组织下指定用户组的信息 | 查看文档去调试 |
DeleteUserGroup | 删除组织内的用户组 | 查看文档去调试 |
DeleteUserGroupMember | 删除指定用户组下的指定成员 | 查看文档去调试 |
DeleteUserGroupMembers | 指定用户批量退出用户组 | 查看文档去调试 |
WithdrawAllUserGroups | 使用户退出所有用户组,该过程不可逆,请谨慎操作 | 查看文档去调试 |
用户标签管理 | ||
AddUserTagMeta | 新增组织成员标签元信息 | 查看文档去调试 |
QueryUserTagMetaList | 查询组织内成员标签元信息列表 | 查看文档去调试 |
QueryUserTagValueList | 查询特定用户标签值列表 | 查看文档去调试 |
UpdateUserTagMeta | 用于更新组织成员标签元信息 | 查看文档去调试 |
UpdateUserTagValue | 更新组织成员标签值 | 查看文档去调试 |
DeleteUserTagMeta | 删除组织成员的标签元信息 | 查看文档去调试 |
角色管理 | ||
ListWorkspaceRoleUsers | 获取指定空间角色下的用户列表 | 查看文档去调试 |
QueryWorkspaceRoleConfig | 获取指定空间角色的配置 | 查看文档去调试 |
QueryOrganizationRoleConfig | 获取指定组织角色的配置 | 查看文档去调试 |
ListWorkspaceRoles | 获取空间角色列表 | 查看文档去调试 |
ListOrganizationRoles | 获取组织角色列表 | 查看文档去调试 |
ListOrganizationRoleUsers | 获取指定组织角色下的用户列表 | 查看文档去调试 |
权限管理
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
报表分享授权管理 | ||
AddShareReport | 添加数据作品的一个分享配置 | 查看文档去调试 |
QueryShareList | 查询作品被分享给哪些对象的列表,只返回仍然在有效期限内的分享配置 | 查看文档去调试 |
QuerySharesToUserList | 查询授权给用户的作品列表 | 查看文档去调试 |
CancelReportShare | 删除数据作品的一个分享授权 | 查看文档去调试 |
数据门户菜单授权管理 | ||
AuthorizeMenu | 数据门户菜单的批量授权,已经授权的会自动略过 | 查看文档去调试 |
ListPortalMenus | 获取具体数据门户下的分层菜单列表 | 查看文档去调试 |
ListPortalMenuAuthorization | 获取数据门户菜单的授权详情列表 | 查看文档去调试 |
ChangeVisibilityModel | 修改数据门户菜单的可见方式,是否仅授权可见 | 查看文档去调试 |
CancelAuthorizationMenu | 根据门户菜单ID,取消指定用户、用户组的授权记录 | 查看文档去调试 |
行级权限管理 | ||
SetDataLevelPermissionRuleConfig | 设置单条数据集行列权限配置信息(新增和更新) | 查看文档去调试 |
AddDataLevelPermissionRuleUsers | 针对单条行列权限规则增量添加选定的人群 | 查看文档去调试 |
AddDataLevelPermissionWhiteList | 修改指定数据集行列权限的白名单 | 查看文档去调试 |
QueryDatasetSwitchInfo | 获取指定数据集的行级权限开关状态 | 查看文档去调试 |
ListCubeDataLevelPermissionConfig | 获取指定数据集的行列权限配置列表 | 查看文档去调试 |
ListDataLevelPermissionWhiteList | 根据行列权限种类,获取数据集行列权限的白名单列表 | 查看文档去调试 |
UpdateDataLevelPermissionStatus | 更新数据集行列权限开关状态 | 查看文档去调试 |
SetDataLevelPermissionExtraConfig | 设置行列权限的额外配置 | 查看文档去调试 |
SetDataLevelPermissionWhiteList | 设置指定行级权限的白名单列表 | 查看文档去调试 |
DeleteDataLevelRuleConfig | 删除单条行列权限规则 | 查看文档去调试 |
DeleteDataLevelPermissionRuleUsers | 针对单条行列权限规则删除选定的人群 | 查看文档去调试 |
开放审批 | ||
QueryApprovalInfo | 根据审批人获取相应的审批流信息 | 查看文档去调试 |
ResultCallback | 自定义审批流回调接口,用户自行对Quick BI的审批流进行处理 | 查看文档去调试 |
资源管理
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
报表资源管理 | ||
QueryWorksByOrganization![]() | 查询整个组织下的所有作品,可指定作品类型 | 查看文档去调试 |
QueryWorksByWorkspace![]() | 查询组织下某个工作空间下的所有作品,可指定作品类型 | 查看文档去调试 |
QueryReadableResourcesListByUserId | 查询用户有权查看的作品列表,包含空间下与分享授权的报表 | 查看文档去调试 |
CheckReadable | 查询用户对数据作品(仪表板、电子表格等)是否有权限查看 | 查看文档去调试 |
QueryEmbeddedInfo | 获取组织下的嵌入配置,包括最大嵌入数和已经嵌入数等 | 查看文档去调试 |
QueryEmbeddedStatus | 查询某个报表是否已经开通嵌入 | 查看文档去调试 |
QueryWorks | 查询指定数据作品信息 | 查看文档去调试 |
QueryWorksBloodRelationship![]() | 获取数据作品的血缘关系,包括各组件引用的数据集以及查询字段信息。目前仅支持的数据作品包含仪表板、电子表格、自助取数 | 查看文档去调试 |
QueryComponentPerformance | 查询组件性能日志 | 查看文档去调试 |
QueryReportPerformance | 查询报表性能日志 | 查看文档去调试 |
GetWorksEmbedList | 查询已嵌入报表列表 | 查看文档去调试 |
UpdateEmbeddedStatus | 更改报表的嵌入状态,开通嵌入、或者关闭嵌入 | 查看文档去调试 |
数据集资源管理 | ||
DataSetBlood | 查询引用指定数据集下的作品信息 | 查看文档去调试 |
DataSourceBlood | 查询引用指定数据源下的数据集信息 | 查看文档去调试 |
ListApiDatasource | 查询API数据源列表 | 查看文档去调试 |
QueryDatasetInfo![]() | 查询指定数据集的信息 | 查看文档去调试 |
QueryDatasetDetailInfo![]() | 查询指定数据集的详情,包括所属数据源、目录、以及数据集模型 | 查看文档去调试 |
QueryDatasetList | 查询指定工作空间的数据集列表,按照创建时间倒序排列 | 查看文档去调试 |
QueryCubePerformance | 查询数据集性能日志 | 查看文档去调试 |
QueryCubeOptimization | 查询数据集优化建议 | 查看文档去调试 |
ModifyApiDatasourceParameters | 修改指定API数据源的配置 | 查看文档去调试 |
AllotDatasetAccelerationTask | 触发数据集Quick引擎的采集加速 | 查看文档去调试 |
ListDataSource | 查询指定空间下的所有数据源 | 查看文档去调试 |
GetDataSourceConnectionInfo | 获取数据源信息 | 查看文档去调试 |
工作空间管理 | ||
AddUserToWorkspace | 添加成员到指定工作空间 | 查看文档去调试 |
AddWorkspaceUsers | 批量添加成员到工作空间 | 查看文档去调试 |
QueryWorkspaceUserList | 查询指定工作空间下的成员列表信息 | 查看文档去调试 |
QueryOrganizationWorkspaceList | 获取当前组织下的工作空间列表信息 | 查看文档去调试 |
QueryUserRoleInfoInWorkspace | 获取指定工作空间成员的预置空间角色信息 | 查看文档去调试 |
UpdateWorkspaceUsersRole | 批量更新工作空间成员的角色信息,已有角色会被覆盖 | 查看文档去调试 |
UpdateWorkspaceUserRole | 修改工作空间下指定成员的角色,已有的角色会被覆盖 | 查看文档去调试 |
DeleteUserFromWorkspace | 删除指定工作空间的成员 | 查看文档去调试 |
收藏管理 | ||
SaveFavorites | 添加用户的收藏数据作品 | 查看文档去调试 |
ListCollections | 获取用户收藏的作品列表 | 查看文档去调试 |
CancelCollection | 取消用户收藏的数据作品 | 查看文档去调试 |
首页管理 | ||
ListFavoriteReports | 获取指定用户在首页看板中展示的收藏作品列表 | 查看文档去调试 |
ListRecentViewReports | 获取指定用户在首页看板中展示的常看和足迹列表 | 查看文档去调试 |
ListSharedReports | 获取指定用户在首页看板中展示的被授权的作品列表 | 查看文档去调试 |
订阅管理 | ||
ManualRunMailTask | 手动执行订阅的邮件任务 | 查看文档去调试 |
GetMailTaskStatus | 查看组织内邮件任务运行状态(实时状态非最终状态) | 查看文档去调试 |
智能问数
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
智能问数嵌入 | ||
CreateTicket4Copilot | 用于生成智能小Q嵌入Ticket | 查看文档去调试 |
QueryCopilotEmbedConfig | 获取开通小Q嵌入的配置列表 | 查看文档去调试 |
QueryDataRange | 获取嵌入配置界面的数据范围目录列表 | 查看文档去调试 |
ModifyCopilotEmbedConfig | 修改智能问数嵌入配置 | 查看文档去调试 |
智能问数管理 | ||
SmartqQueryAbility | 智能问数查询 | 查看文档去调试 |
SmartqAuthorize | 批量管理智能问数的授权 | 查看文档去调试 |
QueryLlmCubeWithThemeListByUserId | 查看用户有哪些数据集和分析主题的问数授权 | 查看文档去调试 |
SmartqAuthTransfer | 将指定用户的问数权限同步给其他用户 | 查看文档去调试 |
QuerySmartqPermissionByCubeId | 查看用户是否有某个智能问数数据集权限 | 查看文档去调试 |
QueryDatasetSmartqStatus | 查看数据集是否开通智能问数 | 查看文档去调试 |