文档中心 > API类目 > 钉钉API

dingtalk.oapi.workspace.task.create (新增基础任务信息)

新增基础任务信息

公共参数

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

名称	类型	是否必须	描述
access_token	String	是	钉钉提供的授权Token，想了解详情，ISV开发者请点击这里，企业开发者请点击这里。若有疑问，咨询邮箱dingding_open_dingtalk#list.alibaba-inc.com。

请求参数

名称	类型	是否必须	示例值	描述
microapp_agent_id	Number	可选	0	微应用agentId
task	TaskCreate	必须		请求入参
└ source_id String 必须 19023 此字段用于数据迁移的场景，表示任务在源系统中的唯一ID，ISV接入时必填，用于跳转至各自的任务详情页 └ is_recycled Boolean 可选 false 是否放入回收站 └ gmt_modified Date 可选 2020-01-15 09:40:20 修改时间 └ executor_userid String 可选 manager2342 执行者id, 传staffId（工号） └ subject String 必须测试任务任务标题 └ is_archived Boolean 可选 false 是否归档 └ creator_userid String 必须 manager2342 创建者id, 传staffId（工号） └ modifier_userid String 可选 manager2342 更新者id, 传staffId（工号） └ description String 可选这是一条测试任务的描述任务描述 └ priority Number 可选 10 优先级, 较低:10, 普通:20, 紧急:30, 非常紧急:40 └ gmt_create Date 可选 2020-01-15 09:40:20 创建时间 └ parent_id String 可选 task50afadafa568025a 父任务id └ task_type_id Number 可选 1 任务类型id，任务类型，可以不传 └ status_id Number 可选 1 状态id，工作流状态, 可以为空 └ status_stage Number 可选 1 状态阶段: 开始阶段(0)，进行阶段(1)，完成阶段(2) └ finish_date Date 可选 2020-01-15 09:40:20 任务实际完成时间 └ start_date Date 可选 2020-01-15 09:40:20 任务实际开始日期 └ corp_id String 可选 ding9ede76239cf28b12ffe93478753d9884 任务所属项目(虚拟企业），基于项目空间的项目 └ task_type_category String 可选 task 任务类型分类:// 任务 TASK("task"), // 需求 REQ("req"), // 缺陷 BUG("bug"), // 风险 RISK("risk"), // 工作项 WORKITEM("workitem") └ plan_start_date Date 可选 2020-01-15 09:40:20 任务计划开始时间 └ plan_finish_date Date 可选 2020-01-15 09:40:20 任务计划完成时间 └ tracker_userids String [] 可选 "userid1","userid2","userid3" 任务参与者列表, 传staffId（工号） extension TaskExtension 可选任务的扩展字段 └ comment_count Number 可选 3 评论数 └ file_path String 可选 http://xxx 附件地址 └ other String 可选 {"key":"value"} 用户可扩展的字段 systemProperty TaskSystemProperty 可选待办系统属性，主要包含接入方的详情页跳转链接 └ appUrl String 可选 http://xxx APP 跳转连接 └ webUrl String 可选 http://xxx web 跳转连接 └ groupId String 可选 111 来自的钉钉群 id └ source String 可选 tb 任务来源source
operator_userid	String	必须	manager2342	操作者id

响应参数

名称	类型	示例值	描述
result	Task		响应结果
└ gmt_create Date 2020-01-15 09:40:20 创建时间 └ modifier_userid String manager2342 更新者id, 传staffId（工号） └ creator_userid String manager2342 创建者id, 传staffId（工号） └ biz_tag String tb 业务标识 └ priority Number 10 优先级, 较低:10, 普通:20, 紧急:30, 非常紧急:40 └ description String 任务描述任务描述 └ finish_date Date 2020-01-15 09:40:20 完成时间 └ start_date Date 2020-01-15 09:40:20 开始时间 └ is_recycled Boolean false 是否放入回收站 └ is_archived Boolean false 是否归档 └ status_stage Number 1 状态阶段: 开始阶段(0)，进行阶段(1)，完成阶段(2) └ source_id String tb-1 此字段用于数据迁移的场景，表示任务在源系统中的唯一ID └ parent_id String 1 父任务id └ task_type_id Number 1 任务类型id，任务类型，可以不传 └ status_id Number 1 状态id，工作流状态, 可以为空 └ executor_userid String manager2342 执行者id, 传staffId（工号） └ subject String 测试任务标题 └ gmt_modified Date 2020-01-15 09:40:20 修改时间 └ belong_corp_id String 1111 归属企业id └ corp_id String ding77a7f8893894f0 任务所属项目(虚拟企业），基于项目空间的项目 └ task_id String 111 任务id └ task_type_category String req 任务类型分类:// 任务 TASK("task"), // 需求 REQ("req"), // 缺陷 BUG("bug"), // 风险 RISK("risk"), // 工作项 WORKITEM("workitem") └ plan_start_date Date 2020-01-15 09:40:20 任务计划开始时间 └ plan_finish_date Date 2020-01-15 09:40:20 任务计划完成时间 └ tracker_userids String [] ["userid1","userid2","userid3"] 任务参与者列表 extension TaskExtension {} 任务的扩展字段 └ comment_count Number 3 评论数量 └ file_path String 附件地址 └ other String {"key":"value"} 用户可扩展的字段 systemProperty TaskSystemProperty 待办系统属性，主要包含接入方的详情页跳转链接 └ groupId String 111 来自钉钉群 id └ appUrl String http://xxx APP 跳转连接 └ webUrl String http://xxx web 跳转连接 └ source String tb 任务来源source
errcode	Number	0000	错误码
errmsg	String	参数错误	错误描述

请求示例

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/workspace/task/create");
OapiWorkspaceTaskCreateRequest req = new OapiWorkspaceTaskCreateRequest();
req.setMicroappAgentId(0L);
TaskCreate obj1 = new TaskCreate();
obj1.setSourceId("19023");
obj1.setIsRecycled(false);
obj1.setGmtModified(StringUtils.parseDateTime("2020-01-15 09:40:20"));
obj1.setExecutorUserid("manager2342");
obj1.setSubject("测试任务");
obj1.setIsArchived(false);
obj1.setCreatorUserid("manager2342");
obj1.setModifierUserid("manager2342");
obj1.setDescription("这是一条测试任务的描述");
obj1.setPriority(10L);
obj1.setGmtCreate(StringUtils.parseDateTime("2020-01-15 09:40:20"));
obj1.setParentId("task50afadafa568025a");
obj1.setTaskTypeId(1L);
obj1.setStatusId(1L);
obj1.setStatusStage(1L);
obj1.setFinishDate(StringUtils.parseDateTime("2020-01-15 09:40:20"));
obj1.setStartDate(StringUtils.parseDateTime("2020-01-15 09:40:20"));
obj1.setCorpId("ding9ede76239cf28b12ffe93478753d9884");
obj1.setTaskTypeCategory("task");
obj1.setPlanStartDate(StringUtils.parseDateTime("2020-01-15 09:40:20"));
obj1.setPlanFinishDate(StringUtils.parseDateTime("2020-01-15 09:40:20"));
obj1.setTrackerUserids("\"userid1\",\"userid2\",\"userid3\"");
TaskExtension obj2 = new TaskExtension();
obj2.setCommentCount(3L);
obj2.setFilePath("http://xxx");
obj2.setOther("{\"key\":\"value\"}");
TaskSystemProperty obj3 = new TaskSystemProperty();
obj3.setAppUrl("http://xxx");
obj3.setWebUrl("http://xxx");
obj3.setGroupId("111");
obj2.setSystemProperty(obj3);
obj1.setExtension(obj2);
obj1.setSource("tb");
req.setTask(obj1);
req.setOperatorUserid("manager2342");
OapiWorkspaceTaskCreateResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/workspace/task/create");
OapiWorkspaceTaskCreateRequest req = new OapiWorkspaceTaskCreateRequest();
req.MicroappAgentId = 0L;
OapiWorkspaceTaskCreateRequest.TaskCreateDomain obj1 = new OapiWorkspaceTaskCreateRequest.TaskCreateDomain();
obj1.SourceId = "19023";
obj1.IsRecycled = false;
obj1.GmtModified = DateTime.Parse(2020-01-15 09:40:20");
obj1.ExecutorUserid = "manager2342";
obj1.Subject = "测试任务";
obj1.IsArchived = false;
obj1.CreatorUserid = "manager2342";
obj1.ModifierUserid = "manager2342";
obj1.Description = "这是一条测试任务的描述";
obj1.Priority = 10L;
obj1.GmtCreate = DateTime.Parse(2020-01-15 09:40:20");
obj1.ParentId = "task50afadafa568025a";
obj1.TaskTypeId = 1L;
obj1.StatusId = 1L;
obj1.StatusStage = 1L;
obj1.FinishDate = DateTime.Parse(2020-01-15 09:40:20");
obj1.StartDate = DateTime.Parse(2020-01-15 09:40:20");
obj1.CorpId = "ding9ede76239cf28b12ffe93478753d9884";
obj1.TaskTypeCategory = "task";
obj1.PlanStartDate = DateTime.Parse(2020-01-15 09:40:20");
obj1.PlanFinishDate = DateTime.Parse(2020-01-15 09:40:20");
obj1.TrackerUserids = "\"userid1\",\"userid2\",\"userid3\"";
OapiWorkspaceTaskCreateRequest.TaskExtensionDomain obj2 = new OapiWorkspaceTaskCreateRequest.TaskExtensionDomain();
obj2.CommentCount = 3L;
obj2.FilePath = "http://xxx";
obj2.Other = "{\"key\":\"value\"}";
OapiWorkspaceTaskCreateRequest.TaskSystemPropertyDomain obj3 = new OapiWorkspaceTaskCreateRequest.TaskSystemPropertyDomain();
obj3.AppUrl = "http://xxx";
obj3.WebUrl = "http://xxx";
obj3.GroupId = "111";
obj2.SystemProperty= obj3;
obj1.Extension= obj2;
obj1.Source = "tb";
req.Task_ = obj1;
req.OperatorUserid = "manager2342";
OapiWorkspaceTaskCreateResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiWorkspaceTaskCreateRequest;
$req->setMicroappAgentId("0");
$task = new TaskCreate;
$task->source_id="19023";
$task->is_recycled="false";
$task->gmt_modified="2020-01-15 09:40:20";
$task->executor_userid="manager2342";
$task->subject="测试任务";
$task->is_archived="false";
$task->creator_userid="manager2342";
$task->modifier_userid="manager2342";
$task->description="这是一条测试任务的描述";
$task->priority="10";
$task->gmt_create="2020-01-15 09:40:20";
$task->parent_id="task50afadafa568025a";
$task->task_type_id="1";
$task->status_id="1";
$task->status_stage="1";
$task->finish_date="2020-01-15 09:40:20";
$task->start_date="2020-01-15 09:40:20";
$task->corp_id="ding9ede76239cf28b12ffe93478753d9884";
$task->task_type_category="task";
$task->plan_start_date="2020-01-15 09:40:20";
$task->plan_finish_date="2020-01-15 09:40:20";
$task->tracker_userids="\"userid1\",\"userid2\",\"userid3\"";
$extension = new TaskExtension;
$extension->comment_count="3";
$extension->file_path="http://xxx";
$extension->other="{\"key\":\"value\"}";
$systemProperty = new TaskSystemProperty;
$systemProperty->appUrl="http://xxx";
$systemProperty->webUrl="http://xxx";
$systemProperty->groupId="111";
$extension->systemProperty = $systemProperty;
$task->extension = $extension;
$task->source="tb";
$req->setTask($task);
$req->setOperatorUserid("manager2342");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/workspace/task/create");

curl -X POST "https://oapi.dingtalk.com/topapi/workspace/task/create" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=eacec7fb-7256-4d94-8c66-9bbb38373c67' \
-d 'microapp_agent_id=0' \
-d 'operator_userid=manager2342' \
-d 'task=null'

# -*- coding: utf-8 -*-
import dingtalk.api

req=dingtalk.api.OapiWorkspaceTaskCreateRequest("https://oapi.dingtalk.com/topapi/workspace/task/create")

req.microapp_agent_id=0
req.task=""
req.operator_userid="manager2342"
try:
	resp= req.getResponse(access_token)
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"dingtalk.oapi.workspace.task.create");
add_param(pRequest,"microapp_agent_id","0");
add_param(pRequest,"task","数据结构JSON示例");
add_param(pRequest,"operator_userid","manager2342");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('dingtalk.oapi.workspace.task.create', {
	'microapp_agent_id':'0',
	'task':'数据结构JSON示例',
	'operator_userid':'manager2342'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "gmt_create":"2020-01-15 09:40:20",
        "modifier_userid":"manager2342",
        "creator_userid":"manager2342",
        "biz_tag":"tb",
        "priority":10,
        "description":"任务描述",
        "finish_date":"2020-01-15 09:40:20",
        "start_date":"2020-01-15 09:40:20",
        "is_recycled":false,
        "is_archived":false,
        "status_stage":1,
        "source_id":"tb-1",
        "parent_id":"1",
        "task_type_id":1,
        "status_id":1,
        "executor_userid":"manager2342",
        "subject":"测试任务",
        "gmt_modified":"2020-01-15 09:40:20",
        "belong_corp_id":"1111",
        "corp_id":"ding77a7f8893894f0",
        "task_id":"111",
        "task_type_category":"req",
        "plan_start_date":"2020-01-15 09:40:20",
        "plan_finish_date":"2020-01-15 09:40:20",
        "tracker_userids":{
            "string":[
                "[\"userid1\"",
                "\"userid2\"",
                "\"userid3\"]"
            ]
        },
        "extension":{
            "comment_count":3,
            "file_path":"",
            "other":"{\"key\":\"value\"}",
            "systemProperty":{
                "groupId":"111",
                "appUrl":"http:\/\/xxx",
                "webUrl":"http:\/\/xxx"
            }
        },
        "source":"tb"
    },
    "errcode":0000,
    "errmsg":"参数错误"
}

异常示例

JSON示例

{
	"errcode":88,
	"errmsg":"ding talk error"
}

错误码解释

错误码	错误描述	解决方案

API工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.workspace.task.create (新增基础任务信息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ