创建项目任务

POST

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

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

调用本接口，创建一个钉钉项目任务。

什么是项目任务

项目任务是在关联指定项目中创建的任务。

接口功能介绍

例如，有个项目名为文档跟进，如下图所示，目前没有任何任务。

调用本接口可以给员工小钉3创建一个文档跟进项目的任务。

接口调用成功后，文档跟进项目内显示的任务信息如下图所示。

自定义字段

项目创建者，在当前项目内任意任务中添加自定义字段，该项目内创建任务可使用自定义字段。

权限

要调用此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	%s	请参考ErrorMessage中的errorMessage内容

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.dingtalk.com/v1.0/project/users//tasks' \
--header 'x-acs-dingtalk-access-token;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "projectId" : "String",
  "content" : "String",
  "executorId" : "String",
  "dueDate" : "String",
  "note" : "String",
  "priority" : Integer,
  "customfields" : [ {
    "customfieldName" : "String",
    "customfieldId" : "String",
    "value" : [ {
      "title" : "String"
    } ]
  } ],
  "stageId" : "String",
  "parentTaskId" : "String",
  "scenariofieldconfigId" : "String",
  "startDate" : "String",
  "visible" : "String"
}'

响应示例

{
  "result": {
    "taskId": "string",
    "content": "string",
    "involveMembers": [
      "string"
    ],
    "projectId": "string",
    "executorId": "string",
    "creatorId": "string",
    "created": "string",
    "updated": "string",
    "note": "string",
    "dueDate": "string",
    "priority": 0,
    "customfields": [
      {
        "customfieldId": "string",
        "value": [
          {
            "title": "string"
          }
        ]
      }
    ]
  }
}

请求参数

Path 参数

userId

string

必需

操作者userId。

Header 参数

x-acs-dingtalk-access-token

string

必需

调用该接口的访问凭证。

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

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

Body 参数application/json

projectId

string

必需

项目id。说明目前需要从项目链接中获取该参数值，获取步骤：进入项目 > 右上角单击菜单 > 复制链接 得到的项目链接示例：https://www.teambition.com/project/62c794xxxxx，project下一级路径的值就是项目id。

content

string

任务标题。

必需

executorId

string

可选

任务执行者userId。

dueDate

string

可选

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

note

string

任务备注。

可选

customfields

array [object {3}]

可选

自定义字段列表。说明自定义字段目前只支持单选、多选、数字、文本和日期，其他类型暂不支持。

customfieldName

string

可选

自定义字段名称。说明该字段值需要与自定义字段名保持完全一致。

customfieldId

string

可选

自定义字段ID。说明自定义字段ID，暂未透出，目前该参数字段值不填即可。

value

array [object {1}]

自定义字段值列表。

可选

stageId

string

必需

任务列表ID。企业内部应用，可调用查询项目中的任务接口获取stageId。第三方企业应用，可调用查询项目中的任务接口获取stageId。

parentTaskId

string

必需

父任务id。企业内部应用，可调用查询项目中的任务接口获取taskId。第三方企业应用，可调用查询项目中的任务接口获取taskId。

scenariofieldconfigId

string

必需

任务类型id，任务类型比如：缺陷、需求。企业内部应用，可调用查询项目中的任务接口获取scenariofieldconfigId。第三方企业应用，可调用查询项目中的任务接口获取scenariofieldconfigId。

startDate

string

必需

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

visible

string

必需

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

示例

返回响应

🟢200成功

application/json

Body

result

object

返回结果对象。

必需

taskId

string

任务id。

必需

content

string

任务标题。

必需

involveMembers

array[string]

必需

参与者userId列表。

projectId

string

项目id。

必需

executorId

string

必需

任务执行者userId。

creatorId

string

必需

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

created

string

必需

updated

string

必需

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

note

string

任务备注。

必需

dueDate

string

必需

priority

integer

必需

任务优先级。 - 使用项目默认的优先级，如下图所示。优先级默认为以下。 - -10：较低，默认值。 - 0：普通 - 1：紧急 - 2：非常紧急

- 用户自定义优先级，如下图所示，新增一般紧急并调整优先级顺序等。该参数值以接口实际调用结果为准。优先级越高，数值越大。

customfields

array [object {2}]

自定义字段列表。

必需

修改于 2024-01-15 03:47:49

创建或更新项目概览中自定义字段值

删除任务

创建项目任务

什么是项目任务#

接口功能介绍#

自定义字段#

权限#

错误码#

请求参数

返回响应

什么是项目任务

接口功能介绍

自定义字段

权限

错误码