任务相关接口

列出所有任务 #

列出项目中所有任务。

请求 #

url: /project/{projectId}/task/all?accessToken={accessToken}&offset={offset}&limit={limit}

参数:

参数名 说明
projectId 项目ID
accessToken 访问令牌
offset 分页偏移
limit 单页记录条数

响应 #

成功返回200,失败返回500

响应结构:

属性 类型 说明
totalCount int 任务记录总数
taskList TaskInfo[] 任务列表

列出我的任务 #

列出所有指派给我的任务。

请求 #

url: /project/{projectId}/task/my?accessToken={accessToken}&state={state}

参数:

参数名 说明
projectId 项目ID
accessToken 访问令牌
state 任务状态(all:全部任务,closed:关闭的任务,unclose:未关闭任务)

响应 #

成功返回200,失败返回500。

响应为TaskInfo[]数组。

列出依赖工单 #

获取当前任务依赖的任务/缺陷列表。

请求 #

url: /project/{projectId}/task/record/{taskId}/depend?accessToken={accessToken}

参数:

参数名 说明
projectId 项目ID
taskId 任务ID
accessToken 访问令牌

响应 #

成功返回200,失败返回500。

响应结构:

属性 类型 说明
myDependList IssueInfo[] 我依赖的任务/缺陷
dependMeList IssueInfo[] 依赖我的任务/缺陷

列出任务相关事件 #

获取当前任务创建以来所有的事件。

请求 #

url: /project/{projectId}/task/record/{taskId}/events?accessToken={accessToken}

参数:

参数名 说明
projectId 项目ID
taskId 任务ID
accessToken 访问令牌

响应 #

成功返回200,失败返回500。

响应为事件列表。

事件结构: #

属性 类型 说明
eventId string 事件ID
userId string 用户ID
userDisplayName string 用户名称
eventType string 事件类型
refType string 事件引用类型
refId string 引用ID
eventData object 事件内容

列出子任务 #

获取当前任务对应的子任务列表

请求 #

url: /project/{projectId}/task/record/{taskId}/subTask?accessToken={accessToken}

参数:

参数名 说明
projectId 项目ID
taskId 任务ID
accessToken 访问令牌

响应 #

成功返回200,失败返回500。

返回是一个子任务列表

子任务结构 #

属性 类型 说明
subTaskId string 子任务ID
taskId string 任务ID
title string 子任务标题
createUserId string 创建人ID
createDisplayName string 创建人名称
done bool 是否完成
createTime long 创建时间
updateTime long 更新时间

便签方式显示任务 #

发送请求给客户端,成功后客户端会创建一个浮动页面用于显示任务。

请求 #

url: /project/{projectId}/task/record/{taskId}/shortNote?accessToken={accessToken}

参数:

参数名 说明
projectId 项目ID
taskId 任务ID
accessToken 访问令牌

响应 #

成功返回200,失败返回500。

显示任务详情 #

发送请求给客户端,成功后唤醒客户端并进入任务详情页面。

请求 #

url: /project/{projectId}/task/record/{taskId}/show?accessToken={accessToken}

参数:

参数名 说明
projectId 项目ID
taskId 任务ID
accessToken 访问令牌

响应 #

成功返回200,失败返回500。

通用结构 #

任务信息(TaskInfo) #

属性 类型 说明
taskId string 任务ID
title string 标题
state string 状态(plan:规划中,process:执行中,check:检查中,close:已关闭)
createUserId string 创建人ID
createDisplayName string 创建人名称
execUserId string 执行人ID
execDisplayName string 执行人名称
checkUserId string 检查人ID
checkDisplayName string 检查人名称
execAwardPoint int 执行奖励
checkAwardPoint int 检查奖励
createTime long 创建时间
updateTime long 更新时间
priority string 优先级(low:低,middle:中, high:高)

工单信息(IssueInfo) #

属性 类型 说明
issueId string 工单ID
issueType string 工单类型(task:任务,bug:缺陷)
title string 标题
state string 状态(plan:规划中,process:执行中,check:检查中,close:已关闭)
createUserId string 创建人ID
createDisplayName string 创建人名称
execUserId string 执行人ID
execDisplayName string 执行人名称
checkUserId string 检查人ID
checkDisplayName string 检查人名称
execAwardPoint int 执行奖励
checkAwardPoint int 检查奖励
createTime long 创建时间
updateTime long 更新时间