查询项目中的任务

调用本接口，可根据指定条件查询项目中的任务。

例如，测试项目内的所有任务如下图所示，调用本接口可根据不同筛选条件查询项目中的任务信息。

权限

要调用此API，需要以下权限之一。

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	项目应用任务读权限	API Explorer
第三方企业应用	支持	项目应用任务读权限	API Explorer
第三方个人应用	暂不支持	项目应用任务读权限	暂不支持

错误码

HttpCode	错误码	错误信息	说明
400	user.not.exist	user not exist	用户在当前企业中不存在
400	org.not.exist	org not exist	当前企业在Teambition中不存在
500	server.error	system error	系统内部服务错误

{ "totalCount": 0, "nextToken": "string", "result": [ { "taskId": "string", "content": "string", "involveMembers": [ "string" ], "projectId": "string", "executorId": "string", "creatorId": "string", "isDeleted": true, "labels": "string", "created": "string", "updated": "string", "scenariofieldconfigId": "string", "customfields": [ "string" ], "note": "string", "startDate": "string", "dueDate": "string", "priority": 0, "taskflowstatusId": "string", "isDone": true, "isArchived": true, "visible": "string", "tagIds": "string", "stageId": "string", "sprintId": "string", "accomplished": "string", "storyPoint": 0, "progress": 0, "ancestorIds": [ "string" ] } ] }

请求参数

Path 参数

userId

string

必需

操作者userId。

projectId

string

必需

项目ID。

说明

目前需要从项目链接中获取该参数值，获取步骤：进入项目 > 右上角单击菜单 > 复制链接。

得到的项目链接示例：https://www.teambition.com/project/62c794xxxxx ，project下一级路径的值就是项目ID。

Query 参数

nextToken

string

可选

分页游标。

如果是首次调用，该参数不传。

如果是非首次调用，该参数传上次接口返回的nextToken。

示例值:

String

maxResults

string

可选

每页返回最大数量。默认10，最大500。

示例值:

Integer

query

string

可选

查询条件。

企业内部应用，可参考任务筛选TQL说明。

第三方企业应用，可参考任务筛选TQL说明。

示例值:

String

Header 参数

x-acs-dingtalk-access-token

string

必需

调用该接口的访问凭证。

企业内部应用，调用获取企业内部应用的accessToken接口获取。

第三方企业应用，调用获取第三方应用授权企业的accessToken接口获取。

返回响应

🟢200成功

application/json

Body

totalCount

integer

任务总条数。

必需

nextToken

string

分页游标。

必需

result

array [object {27}]

返回的任务列表。

必需

taskId

string

任务ID。

可选

content

string

任务标题。

可选

involveMembers

array[string]

可选

任务参与者userId。

projectId

string

项目ID。

可选

executorId

string

可选

执行者userId。

creatorId

string

可选

创建者userId。

isDeleted

boolean

可选

是否已删除。 true：已删除 false：未删除

labels

string

任务自定义标识。

可选

created

string

可选

创建时间，iso8601格式，例如：2022-07-29T14:55Z。

updated

string

可选

更新时间，iso8601格式，例如：2022-07-29T14:55Z。

scenariofieldconfigId

string

任务类型ID。

可选

customfields

array[string]

自定义字段ID。

可选

note

string

备注。

可选

startDate

string

可选

任务开始时间，iso8601格式，例如：2022-07-29T14:55Z。

dueDate

string

可选

任务截止时间，iso8601格式，例如：2022-07-29T14:55Z。

priority

integer

任务优先级。

可选

taskflowstatusId

string

任务状态ID。

可选

isDone

boolean

可选

任务是否已完成。 true：已完成 false：未完成

isArchived

boolean

可选

是否归档，即是否移动到回收站。 true：已归档 false：未归档

visible

string

可选

任务的可见性规则。 involves：仅任务参与者可见 members：项目成员可见

tagIds

string

标签ID列表。

可选

stageId

string

任务列表ID。

可选

sprintId

string

可选

任务迭代ID，项目应用中开启迭代应用，可添加任务的迭代信息。

accomplished

string

可选

任务完成时间，iso8601格式，例如：2022-07-29T14:55Z。

storyPoint

integer

任务估算的工作量。

可选

progress

integer

任务进度。

可选

ancestorIds

array[string]

父任务ID。

可选

查询项目中的任务

权限#

错误码#

请求参数

返回响应

权限

错误码