查询用户任务信息列表

POST

/v1.0/project/users/{userId}/tasks/search

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

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

接口功能介绍

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

权限

要调用此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	系统内部服务错误。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.dingtalk.com/v1.0/project/users//tasks/search?roleTypes=String&tql=String&nextToken=String&maxResults=String' \
--header 'x-acs-dingtalk-access-token;'

响应示例

{
    "result": [
        {
            "taskId": "string",
            "content": "string",
            "note": "string",
            "projectId": "string",
            "ancestorIds": [
                "string"
            ],
            "parentTaskId": "string",
            "taskflowStatusId": "string",
            "taskListId": "string",
            "taskStageId": "string",
            "tagIds": [
                "string"
            ],
            "creatorId": "string",
            "executorId": "string",
            "involveMembers": [
                "string"
            ],
            "priority": 0,
            "storyPoint": "string",
            "recurrence": [
                "string"
            ],
            "isDone": true,
            "isArchived": true,
            "visible": "string",
            "uniqueId": "string",
            "startDate": "string",
            "dueDate": "string",
            "accomplishTime": "string",
            "created": "string",
            "updated": "string",
            "scenarioFieldConfigId": "string",
            "sprintId": "string",
            "customFields": [
                {
                    "customFieldId": "string",
                    "type": "string",
                    "value": [
                        {
                            "customFieldValueId": "string",
                            "title": "string",
                            "metaString": "string"
                        }
                    ]
                }
            ]
        }
    ],
    "requestId": "string",
    "nextToken": "string"
}

请求参数

Path 参数

userId

string

必需

操作者userId。

Query 参数

roleTypes

string

必需

用户的任务角色。

说明
creator、executor、involveMember 中的一个或多个，多个以英文逗号拼接。例如：creator,executor。

示例值:

String

tql

string

可选

tql内容，详情参见任务筛选TQL使用说明。

示例值:

String

nextToken

string

可选

分页标，从上一次请求结果中获取。

说明
nextToken传入后，返回参数为空，则表示数据已全部查询完毕。

示例值:

String

maxResults

string

可选

每页返回最大数量。

说明
默认10，最大100。

示例值:

String

Header 参数

x-acs-dingtalk-access-token

string

必需

调用该接口的访问凭证。

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

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

返回响应

🟢200成功

application/json

Body

result

array [object {28}]

任务详情集合。

必需

taskId

string

任务ID。

可选

content

string

任务标题。

可选

note

string

任务备注。

可选

projectId

string

项目ID。

可选

ancestorIds

array[string]

祖先任务ID。

可选

parentTaskId

string

父任务ID。

可选

taskflowStatusId

string

任务状态ID。

可选

taskListId

string

任务分组ID。

可选

taskStageId

string

任务列ID。

可选

tagIds

array[string]

标签ID。

可选

creatorId

string

创建人ID。

可选

executorId

string

执行人ID。

可选

involveMembers

array[string]

参与者ID。

可选

priority

integer

可选

任务优先级： -10：较低 0：普通 1：紧急 2：非常紧急

storyPoint

string

可选

StoryPoint。

recurrence

array[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 [object {3}]

自定义字段值集合。

可选

requestId

string

必需

请求 ID，请求异常时可提供此 ID，进行问题排查。

nextToken

string

必需

分页游标。说明 nextToken传入后，返回参数为空，则表示数据已全部查询完毕。

修改于 2024-01-15 04:17:34

查询任务工作流

查询项目中的任务

查询用户任务信息列表

接口功能介绍#

权限#

错误码#

请求参数

返回响应

接口功能介绍

权限

错误码