API.md

API

身份验证(免登)

• 请求身份验证 ❌
• 获取登录用户身份 ❌
• 获取登录用户信息 ❌

用户

• 批量查询用户应用可见性 ❌
• 查询 IDMap ❌

企业

• 获取企业信息 ✔️
• 搜索企业自定义字段分类 ✔️
• 根据自定义字段分类统计自定义字段数 ✔️
• 搜索企业任务类型 ✔️

通讯录

成员

• 获取企业的管理员（含拥有者） ✔️
• 获取企业拥有者 ✔️
• 获取企业成员列表 ✔️
• 更新企业成员 ❌
• 启用企业成员账号 ❌
• 停用企业成员账号 ❌
• 删除企业成员 ❌
• 获取企业成员数量 ❌
• 批量获取企业成员 ❌
• 搜索企业成员 ❌

部门

• 获取企业部门列表 ✔️
• 获取部门成员列表 ✔️
• 获取用户加入的企业部门列表 ✔️

任务

• 更新自由任务标题 ❌
• 创建自由任务 ❌
• 查询自由任务详情 ❌
• 更新自由任务截止时间 ❌
• 更新自由任务执行者 ❌
• 更新自由任务参与者 ❌
• 更新自由任务完成态 ❌
• 更新自由任务备注 ❌
• 获取任务关联信息 ❌
• 创建任务关联 ❌
• 删除任务关联 ❌
• 更新自由任务优先级 ❌
• 查询项目任务 ✔️
• 归档任务(移入回收站) ❌
• 评论任务 ❌
• 更新任务标题 ❌
• 复制任务（仅支持工作流项目） ❌
• 创建任务 ✔️
• 根据字段InstanceId更新任务自定义字段值(弃用) ❌
• 更新任务自定义字段值 ❌
• 删除任务 ❌
• 更新任务截止时间 ❌
• 更新任务执行者 ❌
• 更新任务参与者 ❌
• 移动任务（仅支持工作流项目） ❌
• 更新任务备注 ❌
• 获取任务关联列表 ❌
• 更新任务优先级 ❌
• 查询任务详情 ✔️
• 更新任务开始时间 ❌
• 更新任务标签 ❌
• 更新任务状态 ❌
• 获取任务依赖 ❌
• 获取任务进展 ❌
• 列出任务动态 ❌
• 更新任务自定义字段值(弃用) ❌
• 更新任务进度 ❌
• 改变任务的父任务 ❌
• 更新任务列表 ❌
• 更新任务StoryPoint ❌
• 更新任务迭代 ❌
• 获取项目下甘特图基线 ❌
• 获取甘特图基线下的任务 ❌
• 创建任务进展 ❌
• 搜索用户的任务 ❌

工时

• 创建计划工时 ❌
• 获取单个计划工时详情 ❌
• 获取单个任务的计划工时列表 ❌
• 获取单个任务的计划工时总和 ❌
• 获取一定时间内订阅的指定用户的计划工时聚合数 ❌
• 创建实际工时 ❌
• 获取单个实际工时详情 ❌
• 获取单个任务的实际工时列表 ✔️
• 获取单个任务的实际工时总和 ❌
• 获取一定时间内订阅的指定用户的实际工时聚合数据 ❌
• 获取用户所有计划工时详情数据 ❌
• 获取用户所有实际工时详情数据 ✔️
• 更新计划工时单条记录 ❌
• 更新实际工时单条记录 ❌
• 删除实际工时单条记录 ❌
• 删除计划工时单条记录 ❌

项目

• 创建项目自定义字段 ❌
• 删除自定义字段，默认删除企业自定义字段，如果传递项目ID，则删除项目下自定义字段 ❌
• 搜索企业自定义字段 ❌
• 更新自定义字段，默认更新企业自定义字段，如果传递项目ID，则更新项目下自定义字段 ❌
• 查询企业优先级 ❌
• 安装项目应用 ❌
• 删除项目应用 ❌
• 查询项目应用列表 ❌
• 项目放入回收站 ❌
• 复制项目 ❌
• 从模版创建项目 ❌
• 创建项目 ❌
• 批量根据instanceId查询字段 ❌
• 搜索项目自定义字段 ❌
• 创建项目分组关联关系 ❌
• 删除项目分组关联关系 ❌
• 更新项目分组关联角色 ❌
• 创建项目成员(弃用) ❌
• 获取项目成员列表 ❌
• 修改项目成员的角色 ❌
• 获取项目关联列表 ❌
• 创建项目关联 ❌
• 删除项目关联 ❌
• 查看项目的项目分组 ❌
• 更新项目的项目分组 ❌
• 查询项目 ✔️
• 引入企业后台项目角色到项目 ❌
• 创建项目角色 ❌
• 移除项目角色 ❌
• 获取项目角色列表 ❌
• 修改项目角色的权限项 ❌
• 创建项目任务类型(提交项目ID), 创建企业任务类型 ❌
• 修改项目任务类型(提交项目ID), 修改企业任务类型的工作流 ❌
• 删除项目任务类型(提交项目ID), 删除企业任务类型 ❌
• 获取项目任务类型 ❌
• 创建或更新项目概览自定义字段 ❌
• 删除项目概览自定义字段 ❌
• 查询项目概览自定义字段列表 ❌
• 查询项目状态和状态历史 ❌
• 恢复归档项目 ❌
• 归档项目 ❌
• 搜索项目标签 ✔️
• 创建项目工作流 ❌
• 删除项目工作流 ❌
• 更新项目工作流 ❌
• 搜索项目工作流 ❌
• 创建项目工作流状态 ❌
• 删除项目工作流状态 ❌
• 更新项目工作流状态 ❌
• 更新项目工作流状态位置 ❌
• 更新项目工作流状态名字 ❌
• 更新项目工作流状态流转列表 ❌
• 搜索项目工作流状态 ❌
• 搜索任务分组 ❌
• 批量获取测试用例与归属分组的对应关系 ❌
• 更新项目级测试用例分组 ❌
• 创建项目级测试用例 ❌
• 获取测试用例 ❌
• 更新项目 ❌
• 搜索企业项目模版 ❌
• 创建测试计划分组 ❌
• 查询测试计划分组 ❌
• 获取测试计划分组列表 ❌
• 创建测试计划 ❌
• 查询测试计划 ❌
• 获取测试计划 ❌
• 根据ID获取任务类型信息V2 ❌
• 获取自定义字段V2 ❌
• 更新任务字段信息 ❌
• 获取用户参与项目 ❌
• 获取项目「默认任务提醒」列表 ❌
• 获取需求分类列表 ❌
• 创建项目成员 v2 ❌
• 获取项目成员角色（包含权限穿透角色） ❌
• 搜索任务列表 ❌
• 列出项目工作流状态流转执行角色列表 ❌
• 更新项目工作流状态流转角色列表 ❌
• 列出项目工作流状态流转校验列表 ❌
• 更新项目工作流状态流转校验列表 ❌
• 删除项目概览自定义字段(弃用) ❌
• 迭代搜索 ❌
• 完成迭代 ❌
• 创建迭代 ❌
• 删除迭代 ❌
• 迭代标签更新 ❌
• 迭代锁定 ❌
• 迭代操作限制更新 ❌
• 重新开始迭代 ❌
• 开始迭代 ❌
• 迭代更新 ❌
• 删除项目/企业的任务类型的字段 ❌
• 创建/修改 项目/企业的任务类型的字段 ❌
• 创建项目标签 ❌
• 创建项目状态 ❌
• 创建企业标签 ❌
• 搜索企业标签 ❌
• 删除项目成员 ❌
• 修改项目任务类型(提交项目ID), 修改企业任务类型 ❌
• 搜索层级字段选项 ❌
• 更新层级字段选项 ❌

项目分组

• 查询项目分组 ❌
• 创建项目分组 ❌
• 修改项目分组 ❌
• 删除项目分组 ❌

角色

• 创建企业后台项目角色 ❌
• 删除企业后台项目角色 ❌
• 获取企业后台项目角色 ❌
• 更新企业后台项目角色 ❌

名额

• 获取License名额分配列表 ❌

群聊

• 通过projectid查询关联的全员可见的群聊ids ❌
• 根据群聊cid获取绑定的项目projectid ❌

统计

• 按人维度汇总工时 ❌
• 计算项目总工时 ❌

模型说明

• 项目模型说明 ❌
• 任务模型说明 ❌
• 任务动态类型说明 ❌
• 项目角色权限项说明 ❌

webhook

• 获取webhook出口IP列表 ❌

持续集成

• 创建流水线源平台 ❌
• 根据名称查询流水线源平台 ❌
• 查询流水线源平台 ❌
• 更新流水线源平台 ❌
• 同步流水线信息 ❌
• 根据code查询流水线 ❌
• 同步流水线构建参数信息 ❌
• 同步构建信息 ❌

历史版本（不推荐）

不准备实现

代码管理

• 查询流水线源平台 ❌
• 创建流水线源平台 ❌
• 同步流水线信息 ❌
• 同步构建信息 ❌