获取任务列表

POST

/v1.0/project/users/{userId}/projects/{projectId}/taskStages/search

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

调用本接口获取任务列表。

接口功能介绍

调用本接口，根据用户ID和项目ID，查询用户任务列表信息。示例如下：

权限

要调用此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//projects//taskStages/search?taskListId=String&query=String&maxResults=Integer&nextToken=String&taskStageIds=String' \
--header 'x-acs-dingtalk-access-token;'

响应示例

{
    "result": [
        {
            "taskStageId": "string",
            "name": "string",
            "description": "string",
            "projectId": "string",
            "taskListId": "string",
            "creatorId": "string",
            "created": "string",
            "updated": "string"
        }
    ],
    "totalCount": 0,
    "nextToken": "string"
}

请求参数

Path 参数

userId

string

必需

操作者userId。

projectId

string

必需

项目ID：

企业内部应用，可通过查询企业所有项目接口，获取返回参数projectId字段。

第三方企业应用，可通过查询企业所有项目接口，获取返回参数projectId字段。

Query 参数

taskListId

string

可选

任务分组ID：

企业内部应用，可调用查询任务分组接口，获取返回参数taskListId字段。
第三方企业应用，可调用查询任务分组接口，获取返回参数taskListId字段。

示例值:

String

query

string

任务列表名字。

可选

示例值:

String

maxResults

string

可选

每页返回最大数量。

说明
默认10，最大300。

示例值:

Integer

nextToken

string

可选

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

示例值:

String

taskStageIds

string

可选

任务列表 ID 集合。

说明
多个 ID 使用英文逗号分隔。

示例值:

String

Header 参数

x-acs-dingtalk-access-token

string

必需

调用该接口的访问凭证。

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

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

返回响应

🟢200成功

application/json

Body

result

array [object {8}]

任务列表列表。

必需

taskStageId

string

任务列表 ID。

可选

name

string

任务列表名称。

可选

description

string

任务列表描述。

可选

projectId

string

项目 ID。

可选

taskListId

string

任务分组 ID。

可选

creatorId

string

创建者用户 ID。

可选

created

string

可选

创建时间，格式：YYYY-MM-DDTHH:mm:ssZ（ISO 8601/RFC 3339）。说明转换成北京时间，需要在参数时间基础上加8小时。例如参数值为2022-06-20T00:00:00Z，表示的北京时间为2022-06-20 08:00:00。

updated

string

可选

更新时间，格式：YYYY-MM-DDTHH:mm:ssZ（ISO 8601/RFC 3339）。说明转换成北京时间，需要在参数时间基础上加8小时。例如参数值为2022-06-20T00:00:00Z，表示的北京时间为2022-06-20 08:00:00。

totalCount

integer

必需

nextToken

string

必需

分页标，供分页使用，下一页token。

修改于 2024-01-15 04:08:10

查询任务分组

查询任务工作流

获取任务列表

接口功能介绍#

权限#

错误码#

请求参数

返回响应

接口功能介绍

权限

错误码