查询用户任务信息列表新版SDK

更新于 2023-09-05

接口调用量说明钉钉标准版接口累计可调用次数为1万次/月，当前接口会消耗调用次数。若该调用量无法满足需求，你可升级钉钉专业版(Open API调用量50万次/月)或钉钉专属版(Open API调用量500万次/月)扩容调用次数。

调用本接口查询用户任务信息列表。

接口功能介绍

调用本接口，根据操作者的userId信息和用户的任务角色类型，查询所关联项目中的任务信息列表。

权限

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

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

请求方法

Header参数

名称	类型	是否必填	描述
x-acs-dingtalk-access-token	String	是	调用该接口的访问凭证。企业内部应用，调用获取企业内部应用的accessToken接口获取。第三方企业应用，调用获取第三方应用授权企业的accessToken接口获取。

名称

类型

是否必填

描述

x-acs-dingtalk-access-token

String

是

调用该接口的访问凭证。

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

Path参数

名称	类型	是否必填	描述
userId	String	是	操作者userId。

Query参数

名称	类型	是否必填	描述
roleTypes	String	是	用户的任务角色。说明 `creator`、`executor`、`involveMember` 中的一个或多个，多个以英文逗号拼接。例如：`creator,executor`。
tql	String	否	tql内容，详情参见任务筛选TQL使用说明。
nextToken	String	否	分页标，从上一次请求结果中获取。说明 nextToken传入后，返回参数为空，则表示数据已全部查询完毕。
maxResults	Integer	否	每页返回最大数量。说明默认10，最大100。

返回参数

名称	类型	描述
result	Array	任务详情集合。
taskId	String	任务ID。
content	String	任务标题。
note	String	任务备注。
projectId	String	项目ID。
ancestorIds	Array of String	祖先任务ID。
parentTaskId	String	父任务ID。
taskflowStatusId	String	任务状态ID。
taskListId	String	任务分组ID。
taskStageId	String	任务列ID。
tagIds	Array of String	标签ID。
creatorId	String	创建人ID。
executorId	String	执行人ID。
involveMembers	Array of String	参与者ID。
priority	Integer	任务优先级： -10：较低 0：普通 1：紧急 2：非常紧急
storyPoint	String	StoryPoint。
recurrence	Array of String	重复规则。
isDone	Boolean	是否任务已完成。
isArchived	Boolean	是否任务放入回收站。
visible	String	任务隐私性： involves：表达仅参与者可见 members：表达项目成员可见
uniqueId	String	任务数字ID。
startDate	String	任务开始时间(UTC)，格式：YYYY-MM-DDTHH:mm:ssZ（ISO 8601/RFC 3339）。说明转换成北京时间，需要在参数时间基础上加8小时。例如参数值为2022-06-20T00:00:00Z，表示的北京时间为2022-06-20 08:00:00。
dueDate	String	任务截止时间(UTC)，格式：YYYY-MM-DDTHH:mm:ssZ（ISO 8601/RFC 3339）。说明转换成北京时间，需要在参数时间基础上加8小时。例如参数值为2022-06-20T00:00:00Z，表示的北京时间为2022-06-20 08:00:00。
accomplishTime	String	任务完成时间(UTC)，格式：YYYY-MM-DDTHH:mm:ssZ（ISO 8601/RFC 3339）。说明转换成北京时间，需要在参数时间基础上加8小时。例如参数值为2022-06-20T00:00:00Z，表示的北京时间为2022-06-20 08:00:00。
created	String	创建时间(UTC)，格式：YYYY-MM-DDTHH:mm:ssZ（ISO 8601/RFC 3339）。说明转换成北京时间，需要在参数时间基础上加8小时。例如参数值为2022-06-20T00:00:00Z，表示的北京时间为2022-06-20 08:00:00。
updated	String	更新时间(UTC)，格式：YYYY-MM-DDTHH:mm:ssZ（ISO 8601/RFC 3339）。说明转换成北京时间，需要在参数时间基础上加8小时。例如参数值为2022-06-20T00:00:00Z，表示的北京时间为2022-06-20 08:00:00。
scenarioFieldConfigId	String	任务类型ID。
sprintId	String	迭代ID。
customFields	Array	自定义字段值集合。
customFieldId	String	自定义字段ID。
type	String	自定义字段类型。
value	Array	字段值集合。
customFieldValueId	String	字段值ID。
title	String	字段值内容。
metaString	String	字段值元属性。
requestId	String	请求 ID，请求异常时可提供此 ID，进行问题排查。
nextToken	String	分页游标。说明 nextToken传入后，返回参数为空，则表示数据已全部查询完毕。

示例

请求示例

HTTP

Java

Python

PHP

Node.js

返回示例

错误码

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

这篇文档是否有帮助？

本页内容