# 任务相关接口

# 新建任务接口

# 说明

新建任务，返回新建任务的编号

# 请求地址

http://pm.example.com/p/openapi/create_task

# 支持格式

JSON格式

# HTTP请求方式

POST

# 请求参数

字段	必选	类型及范围	说明	特殊规则
task	是	String	任务内容	父节点

task 节点

字段	必选	类型及范围	说明	特殊规则
name	是	String	任务名称
ownerAccountIdList	是	List<Integer>	责任人列表	集合数据
priority	是	Integer	优先级
categoryIdList	是	List<Integer>	任务分类	集合数据
startDate	是	Long	开始时间	时间戳
projectId	是	Integer	项目编号
iterationId	是	Integer	迭代编号
objectType	是	Integer	类型
endDate	否	Long	开始时间	时间
expectWorkTime	否	Integer	预计工时
releaseId	否	Integer	关联Release
subSystemId	否	Integer	关联子系统
attachmentUuidList	否	List<Integer>	附件UUID集合
associatedIdList	否	List<Integer>	关联任务编号集合
content	否	String	详细描述

# 调用示例

{
	"task": {
        "name": "OPENAPI",
        "ownerAccountIdList": [225],
        "status": 2669,
        "priority": 2029,
        "categoryIdList": [],
        "customFields": {},
        "startDate": 1568858817163,
        "endDate": null,
        "projectId": 150,
        "iterationId": null,
        "objectType": 1,
        "expectWorkTime": 20,
        "content": "<p>OPENAPI 任务</p>",
        "attachmentUuidList": [],
        "associatedIdList": []
	}
}

# 返回结果

{
	"code": 0, 
	"data":11563,
	"msg": "OK"
}

# 任务字段说明

任务类型（OBJECTTYPE）取值字段说明

取值	字面值
1	任务
2	缺陷
3	需求
4	测试计划
5	测试用例

# 获取任务详情接口

# 说明

通过任务UUID，获取任务详情数据

# 请求地址

http://pm.example.com/p/openapi/get_task

# 支持格式

JSON格式

# HTTP请求方式

POST

# 请求参数

字段	必选	类型及范围	说明	特殊规则
uuid	是	String	UUID	任务UUID

# 调用示例

{
    "uuid":"e621f360b2714b1db4e3bd9070a67fcd"
}

# 返回结果

{
	"code": 0,
	"data": {
		"task": {
			"associatedList": [],
			"attachmentList": [],
			"categoryIdList": [341],
			"companyId": 1,
			"content": "",
			"createAccountId": 184,
			"createAccountImageId": "41579af5fb9d4ccbbfb64bb9dde58ce9.jpg",
			"createAccountName": "",
			"createTime": 1568195932000,
			"customFields": {},
			"endDays": 0,
			"expectWorkTime": 0,
			"finishSubTaskCount": 0,
			"firstOwner": [210, 184],
			"id": 12383,
			"isCreateIndex": true,
			"isDelete": false,
			"isFinish": false,
			"iterationId": 79,
			"iterationName": "",
			"lastOwner": [210, 184],
			"name": "",
			"objectType": 1,
			"objectTypeName": "任务",
			"ownerAccountIdList": [210, 184],
			"ownerAccountList": [{
				"companyId": 1,
				"id": 210,
				"imageId": "9f27ce6256e0439ca5949e210af2bcf2.png",
				"name": "",
				"userName": ""
			}
			...],
			"parentId": 0,
			"priority": 162,
			"priorityColor": "#525564",
			"priorityName": "低",
			"prioritySortWeight": "1",
			"projectId": 14,
			"projectName": "",
			"projectUuid": "eded33f7f61d4e0e914bf225f75633b9",
			"releaseId": 0,
			"reopenCount": 0,
			"serialNo": "22127",
			"startDate": 1568131200000,
			"startDays": 7,
			"status": 193,
			"statusChangeLogList": [{
				"createAccountId": 210,
				"createAccountName": "",
				"createTime": 1568606398000,
				"enterTime": 1568606398000,
				"id": 8493,
				"oldStatus": 192,
				"oldStatusColor": "#525564",
				"oldStatusName": "未开始",
				"projectId": 14,
				"projectName": "",
				"status": 193,
				"statusColor": "#5BE7C4",
				"statusName": "进行中",
				"taskId": 12383,
				"taskName": "",
				"updateAccountId": 0,
				"updateTime": 1568606398000
			}
			...],
			"statusColor": "#5BE7C4",
			"statusName": "进行中",
			"statusType": 2,
			"subSystemId": 0,
			"subTaskCount": 0,
			"subTaskList": [],
			"taskDescriptionId": 12383,
			"updateAccountId": 210,
			"updateTime": 1568606398000,
			"uuid": "53673d041d6347a6b05bf45fcfad6d13",
			"workTime": 0,
			"workTimeLogList": []
		}
	},
	"msg": "OK"
}

# 任务字段说明

任务重要字段说明

字段	字面值
projectId	项目编号
iterationId	迭代编号
companyId	公司名称
objectType	类型
name	名称
serialNo	序列号
createAccountId	创建人
parentId	父任务
priority	优先级
startDate	开始时间
endDate	截止时间
expectWorkTime	预计工时
workTime	实际工时
subTaskCount	子任务数量
finishSubTaskCount	完成子任务数量
associatedList	关联任务ID列表
attachmentList	关联附件ID列表
categoryIdList	任务分类ID列表
statusChangeLogList	状态变更记录
testCaseList	测试用例列表
workTimeLogList	工时列表
subTaskList	子任务列表

# 修改任务接口

# 说明

更新任务

# 请求地址

http://pm.example.com/p/openapi/update_task

# 支持格式

JSON格式

# HTTP请求方式

POST

# 请求参数

字段	必选	类型及范围	说明	特殊规则
task	是	Object	任务信息	父节点

字段	必选	类型及范围	说明	特殊规则
updateFields	是	List<String>	字段集合	需修改的字段集合，该集合数据依赖于Task中修改信息

task 节点

字段	必选	类型及范围	说明	特殊规则
name	否	String	任务名称
ownerAccountIdList	否	List<Integer>	责任人列表	集合数据
priority	否	Integer	优先级
categoryIdList	否	List<Integer>	任务分类	集合数据
startDate	否	Long	开始时间	时间戳
projectId	否	Integer	项目编号
iterationId	否	Integer	迭代编号
objectType	否	Integer	类型	固定值1
endDate	否	Long	开始时间	时间
expectWorkTime	否	Integer	预计工时
releaseId	否	Integer	关联Release
subSystemId	否	Integer	关联子系统
attachmentUuidList	否	List<Integer>	附件UUID集合
associatedIdList	否	List<Integer>	关联任务编号集合
content	否	String	详细描述

# 调用示例

{
    "task":{
        "id":12455,
        "status":190
    },
    "updateFields":[
        "status"
    ]
}

# 返回结果

{
	"code": 0, 
	"msg": "OK"
}

# 获取任务列表接口

# 说明

返回符合查询条件的所有任务（分页显示，默认一页 10 条）

# 请求地址

http://pm.example.com/p/openapi/get_task_list

# 支持格式

JSON格式

# HTTP请求方式

POST

# 请求参数

字段	必选	类型及范围	说明	特殊规则
id	否	Integer	ID	ID 查询
companyId	否	Integer	公司ID
projectId	否	Integer	项目ID
iterationId	否	Integer	迭代ID
releaseId	否	Integer	关联release ID

# 调用示例

{
	"query": {
	    "companyId": 1
	}
}

# 返回结果

{
	"code": 0,
	"data": {
		"count": 325,
		"list": [{
			"categoryIdList": [340],
			"companyId": 1,
			"createAccountId": 3,
			"createAccountImageId": "bd9a90986b884f99b4d760a2461e9b03.png",
			"createAccountName": "",
			"createTime": 1568788724000,
			"customFields": {},
			"endDays": 0,
			"expectWorkTime": 0,
			"finishSubTaskCount": 0,
			"firstOwner": [3],
			"id": 12453,
			"isCreateIndex": true,
			"isDelete": false,
			"isFinish": false,
			"iterationId": 79,
			"iterationName": "七期",
			"lastOwner": [3],
			"name": "",
			"objectType": 1,
			"objectTypeName": "任务",
			"ownerAccountIdList": [3],
			"ownerAccountList": [{
				"companyId": 1,
				"id": 3,
				"imageId": "bd9a90986b884f99b4d760a2461e9b03.png",
				"name": "",
				"userName": ""
			}],
			"parentId": 0,
			"priority": 162,
			"priorityColor": "#525564",
			"priorityName": "低",
			"prioritySortWeight": "1",
			"projectId": 14,
			"projectName": "",
			"projectUuid": "eded33f7f61d4e0e914bf225f75633b9",
			"releaseId": 0,
			"reopenCount": 0,
			"serialNo": "22197",
			"startDate": 1568736000000,
			"startDays": 0,
			"status": 192,
			"statusColor": "#525564",
			"statusName": "未开始",
			"statusType": 1,
			"subSystemId": 0,
			"subTaskCount": 0,
			"taskDescriptionId": 12453,
			"updateAccountId": 0,
			"updateTime": 1568788724000,
			"uuid": "89723d970f90431cbf337ac3ec0bfbca",
			"workTime": 0
		}
		..]
	},
	"msg": "OK"
}

# 任务字段说明

任务重要字段说明

字段	字面值
id	任务ID
parentId	父ID
name	任务名称
categoryIdList	子分类ID集合
companyId	公司ID
createAccountId	创建用户ID
createAccountImageId	创建用户头像
createAccountName	创建用户名称
createTime	创建时间
customFields	自定义字段集合
endDays	剩余天数
expectWorkTime	预期工作时间
finishSubTaskCount	完成子任务计数
firstOwner	初始责任人
isCreateIndex	是否建立索引
isDelete	是否删除
isFinish	是否完成
iterationId	迭代ID
iterationName	迭代名称
lastOwner	上一个责任人
objectType	任务类型
objectTypeName	任务类型名称
ownerAccountIdList	责任人ID列表
priority	优先级
priorityColor	优先级颜色
priorityName	优先级名称
prioritySortWeight	优先级排序
projectId	项目ID
projectName	项目名称
projectUuid	项目UUID
releaseId	关联Release
reopenCount	重新打开次数
serialNo	序列号
startDate	开始时间
startDays	已用天数
status	状态
statusColor	状态颜色
statusName	状态名称
statusType	状态类型
subSystemId	关联子系统
subTaskCount	关联任务数
taskDescriptionId	详情ID
updateAccountId	更新人
updateTime	更新时间
uuid	UUID
workTime	实际工时
ownerAccountList	责任人列表

任务类型（OBJECTTYPE）取值字段说明

取值	字面值
1	任务
2	缺陷
3	需求
4	测试计划
5	测试用例

← 接入必读项目相关接口 →