# 观远数据开放平台 ## Docs - 根目录 > 开发指南 [Token 鉴权](https://api.guandata.com/apidoc/docs-site/345092/700/doc-338136.md): - 根目录 > 开发指南 [常见问题](https://api.guandata.com/apidoc/docs-site/345092/700/doc-338171.md): ## API Docs - 根目录 > 用户 [批量创建用户](https://api.guandata.com/apidoc/docs-site/345092/700/api-3470503.md): 注意： - 根目录 > 用户 [批量删除用户](https://api.guandata.com/apidoc/docs-site/345092/700/api-3470509.md): 这里需要注意的是，若要删除的用户还有资源未转移，则该用户不能被删除，在response中会返回哪些用户没有被成功删除。 - 根目录 > 用户 [批量修改用户属性](https://api.guandata.com/apidoc/docs-site/345092/700/api-3470510.md): 注意： - 根目录 > 用户 [批量查询用户是否存在](https://api.guandata.com/apidoc/docs-site/345092/700/api-3470511.md): - 根目录 > 用户 [获取用户列表](https://api.guandata.com/apidoc/docs-site/345092/700/api-3470512.md): - 根目录 > 用户 [修改指定用户状态](https://api.guandata.com/apidoc/docs-site/345092/700/api-3470513.md): - 根目录 > 用户 [通过指定的用户的loginid查询对应的uid](https://api.guandata.com/apidoc/docs-site/345092/700/api-3470514.md): - 根目录 > 用户 [将用户添加至用户组](https://api.guandata.com/apidoc/docs-site/345092/700/api-3470522.md): - 根目录 > 用户 [将用户从用户组删除](https://api.guandata.com/apidoc/docs-site/345092/700/api-3470523.md): - 根目录 > 用户 [获取指定用户组下直接挂载的用户列表](https://api.guandata.com/apidoc/docs-site/345092/700/api-3470524.md): - 根目录 > 用户 [获取指定用户直接所属的用户组列表 ](https://api.guandata.com/apidoc/docs-site/345092/700/api-3470525.md): - 根目录 > 用户 [用户统一登出 ](https://api.guandata.com/apidoc/docs-site/345092/700/api-3470526.md): - 根目录 > 用户 [通过用户属性值查询用户列表](https://api.guandata.com/apidoc/docs-site/345092/700/api-3471340.md): - 根目录 > 用户 [通过指定用户的loginid登录](https://api.guandata.com/apidoc/docs-site/345092/700/api-3471341.md): - 根目录 > 用户组 [批量创建用户组](https://api.guandata.com/apidoc/docs-site/345092/700/api-3470527.md): 若请求中有用户组的externalParentGroupId在当前用户组以及请求userGroups中都不存在，或者用户组父子关系逻辑成环，都将导致本次用户组创建失败（全部都不创建）。 - 根目录 > 用户组 [批量修改用户组](https://api.guandata.com/apidoc/docs-site/345092/700/api-3470528.md): - 根目录 > 用户组 [删除指定用户组](https://api.guandata.com/apidoc/docs-site/345092/700/api-3470529.md): - 根目录 > 用户组 [获取用户组列表](https://api.guandata.com/apidoc/docs-site/345092/700/api-3470530.md): - 根目录 > 角色 [查询某一用户的角色信息](https://api.guandata.com/apidoc/docs-site/345092/700/api-3470597.md): 注意： 一次只能查询一个用户；如果输入多个用户loginId，只会返回第一个用户的角色查询结果，所以请勿输入多个用户loginId。 - 根目录 > 角色 [为某一用户增添自定义角色](https://api.guandata.com/apidoc/docs-site/345092/700/api-3470598.md): - 根目录 > 角色 [为某一用户解绑自定义角色](https://api.guandata.com/apidoc/docs-site/345092/700/api-3470599.md): - 根目录 > 数据集 [使用parquet文件更新数据集](https://api.guandata.com/apidoc/docs-site/345092/700/api-3470542.md): 根据语雀文档：https://guandata.yuque.com/productspace/productknowledge/lk9dce - 根目录 > 数据集 [获取数据集列表](https://api.guandata.com/apidoc/docs-site/345092/700/api-3470607.md): 注意：该接口会返回所有数据集，且无分页设计。 - 根目录 > 数据集 [搜索数据集列表](https://api.guandata.com/apidoc/docs-site/345092/700/api-3470608.md): - 根目录 > 数据集 [查询特定数据集的数据结构](https://api.guandata.com/apidoc/docs-site/345092/700/api-3470609.md): 注意：Body不可为空，至少需要填入两个花括号，否则会报错。 - 根目录 > 数据集 [批量修改数据集更新方式](https://api.guandata.com/apidoc/docs-site/345092/700/api-3470610.md): 目前仅支持批量更新数据集的文件夹路径或者数据集的属性更新，如果只需要更新路径位置，则只传递 propsInDetails 参数即可。 - 根目录 > 数据集 [获取指定数据集有使用权限的用户列表](https://api.guandata.com/apidoc/docs-site/345092/700/api-3470611.md): - 根目录 > 数据集 [上传数据](https://api.guandata.com/apidoc/docs-site/345092/700/api-3470613.md): - 根目录 > 数据集 [获取数据集下载授权Token](https://api.guandata.com/apidoc/docs-site/345092/700/api-3470614.md): 使用该接口调用的方式获得数据集授权token。由于该token是长期有效的，很多时候你可能并不需要在程序里反复获取，因此也可以在浏览器端登录系统后，输入以上接口地址获得授权token，并将token固化在您获取数据的程序内。 鉴于授权token是长期有效的，请注意数据安全，妥善保管。若发生token泄露，可调用以上接口，将action设置为reset进行重置。 - 根目录 > 数据集 [下载数据集数据](https://api.guandata.com/apidoc/docs-site/345092/700/api-3470615.md): 该api一次最多返回5万行数据，若数据集较大，请指定过滤条件。 - 根目录 > 数据集 [获取数据集数据](https://api.guandata.com/apidoc/docs-site/345092/700/api-3470616.md): 该api一次最多返回5万行数据，若数据集较大，请指定过滤条件。 - 根目录 > 数据集 [创建数据集](https://api.guandata.com/apidoc/docs-site/345092/700/api-3471018.md): 注意：当数据集类型为 Guan-Index 时，primaryKeyColumns不填为不去重，填写参数格式为：[“column1”, “column2”]，column 代表去重列名。 - 根目录 > 数据集 [更新数据集字段注释](https://api.guandata.com/apidoc/docs-site/345092/700/api-3471019.md): - 根目录 > 数据集 [触发数据集读取数据文件并更新](https://api.guandata.com/apidoc/docs-site/345092/700/api-3471020.md): 核心步骤： - 根目录 > 数据集 [通过 TaskID 查询数据集更新结果](https://api.guandata.com/apidoc/docs-site/345092/700/api-3471021.md): 如果任务执行完成，则 response.status 为 FINISHED，如果更新成功，则 response.result.status 为 FINISHED。 - 根目录 > 数据集 [修改数据集schema](https://api.guandata.com/apidoc/docs-site/345092/700/api-3471023.md): 支持数据集类型 - 根目录 > 数据集 [更新数据集](https://api.guandata.com/apidoc/docs-site/345092/700/api-3471025.md): - 根目录 > 数据集 [修改数据集字段别名](https://api.guandata.com/apidoc/docs-site/345092/700/api-3471026.md): 注意：ETL输出、卡片、视图、账户 不允许改别名。 - 根目录 > 仪表板 [获取页面列表](https://api.guandata.com/apidoc/docs-site/345092/700/api-3471037.md): - 根目录 > 仪表板 [根据页面名称关键词搜索页面](https://api.guandata.com/apidoc/docs-site/345092/700/api-3471038.md): - 根目录 > 仪表板 [获取指定页面有读权限的用户列表](https://api.guandata.com/apidoc/docs-site/345092/700/api-3471039.md): - 根目录 > 仪表板 [以树状结构获取页面列表](https://api.guandata.com/apidoc/docs-site/345092/700/api-3471040.md): - 根目录 > 仪表板 [以PDF或者图片模式导出仪表板](https://api.guandata.com/apidoc/docs-site/345092/700/api-3471041.md): 如果指定了具体的用户信息，将以特定的用户名义（数据权限）导出PDF或者图片。 - 根目录 > 仪表板 [获取仪表板导出文件](https://api.guandata.com/apidoc/docs-site/345092/700/api-3471042.md): 如果任务执行完成则会支持返回文件；如果没有顺利导出，任务结果为处理中状态。 - 根目录 > 订阅预警 [下载自定义渠道推送文件](https://api.guandata.com/apidoc/docs-site/345092/700/api-3470583.md): 下载自定义webhook渠道推送的文件 - 根目录 > 订阅预警 [启用/关闭订阅](https://api.guandata.com/apidoc/docs-site/345092/700/api-3471044.md): - 根目录 > 订阅预警 [启用/关闭预警](https://api.guandata.com/apidoc/docs-site/345092/700/api-3471045.md): - 根目录 > 卡片 [获取卡片数据](https://api.guandata.com/apidoc/docs-site/345092/700/api-3471043.md): - 根目录 > 权限 [获取指定用户能访问的页面列表](https://api.guandata.com/apidoc/docs-site/345092/700/api-3471046.md): - 根目录 > 权限 [获取指定用户能访问的数据集列表](https://api.guandata.com/apidoc/docs-site/345092/700/api-3471047.md): - 根目录 > 权限 [修改指定用户与各个页面的访问及归属关系](https://api.guandata.com/apidoc/docs-site/345092/700/api-3471048.md): pages中，pgId一般在观远页面获取，isOwner设为true表示将此用户设为这个页面的所有者，isReadable设为true表示将此用户设为这个页面的访问者，设置为false，则表示去掉用户对这个页面的相应权限；isExportable 表示是否可以导出（true表示可以导出；false表示不可以导出）。 - 根目录 > 权限 [修改指定用户与各个数据集的访问及归属关系](https://api.guandata.com/apidoc/docs-site/345092/700/api-3471049.md): datasets中，dsId一般在观远页面获取表示数据集Id，isOwner设为true表示将此用户设为这个数据集的所有者，isReadable设为true表示将此用户设为这个数据集的访问者，设置为false，则表示去掉用户对这个数据集的相应权限；isExportable 表示是否可以导出（true表明可以导出；false表明不可以导出）。 - 根目录 > 权限 [获取指定用户组能访问的页面列表](https://api.guandata.com/apidoc/docs-site/345092/700/api-3471050.md): - 根目录 > 权限 [获取指定用户组能访问的数据集列表](https://api.guandata.com/apidoc/docs-site/345092/700/api-3471051.md): - 根目录 > 权限 [修改指定用户组与各个页面的访问及归属关系](https://api.guandata.com/apidoc/docs-site/345092/700/api-3471052.md): - 根目录 > 权限 [修改指定用户组与各个数据集的访问及归属关系](https://api.guandata.com/apidoc/docs-site/345092/700/api-3471053.md): - 根目录 > 权限 [通用资源权限授权与解除](https://api.guandata.com/apidoc/docs-site/345092/700/api-3471054.md): 特别说明： - 根目录 > 资源操作 [将指定用户下辖有所有者权限的资源迁移至其他用户组或用户](https://api.guandata.com/apidoc/docs-site/345092/700/api-3470604.md): inheritorUIds与inheritorUgIds中至少包含一个参数。 - 根目录 > 资源操作 [将指定用户组下有所有者权限的资源迁移至其他用户组或用户](https://api.guandata.com/apidoc/docs-site/345092/700/api-3470605.md): inheritorUIds与inheritorUgIds中至少包含一个参数。 - 根目录 > 资源操作 [通用资源列表清单](https://api.guandata.com/apidoc/docs-site/345092/700/api-3470606.md): 特别说明【2024-10-1】： - 根目录 [用户登录](https://api.guandata.com/apidoc/docs-site/345092/700/api-3470502.md): 通过个人账号与密码模拟登录获取合法Token。