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

dingtalk.oapi.workspace.task.update (更新任务基础信息)

更新任务基础信息

公共参数

环境	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	可选	1111	微应用agentId
task	TaskUpdate	必须		请求入参
└ source_id String 可选 tb-sourceId 来源id └ is_recycled Boolean 可选 false 是否放入回收站 └ gmt_modified Date 可选 2020-01-14 14:39:51 修改时间 └ executor_userid String 可选 1111 执行者id（传null不更新，传空串则清空原值） └ subject String 可选测试任务标题 └ is_archived Boolean 可选 false 是否归档 └ modifier_userid String 可选 1111 更新者id └ description String 可选这是一条测试任务的描述描述（传null不更新，传空串则清空原值） └ priority Number 可选 1 优先级 └ parent_id String 可选 1 父任务id └ task_type_id Number 可选 1 任务类型id └ status_id Number 可选 1 工作流状态id └ status_stage Number 可选 1 状态阶段: 开始阶段(0)，进行阶段(1)，完成阶段(2) └ finish_date Date 可选 2020-01-14 14:39:51 完成时间（传null不更新，传Date(0)，即1970-01-01T08:00:00.000+08:00则清空原值） └ start_date Date 可选 2020-01-14 14:39:51 开始日期（传null不更新，传Date(0)，即1970-01-01T08:00:00.000+08:00则清空原值） └ task_type_category String 可选 req 任务类型分类:// 任务 TASK("task"), // 需求 REQ("req"), // 缺陷 BUG("bug"), // 风险 RISK("risk"), // 工作项 WORKITEM("workitem") └ plan_start_date Date 可选 2020-01-14 14:39:51 计划开始时间（传null不更新，传Date(0)，即1970-01-01T08:00:00.000+08:00则清空原值） └ plan_finish_date Date 可选 2020-01-14 14:39:51 计划结束时间（传null不更新，传Date(0)，即1970-01-01T08:00:00.000+08:00则清空原值） └ tracker_userids String [] 可选 ["userid1","userid2","userid3"] 任务参与者列表 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 跳转连接 └ corp_id String 可选 ding9ede76239cf28b12ffe93478753d9884 任务所属项目(虚拟企业），基于项目空间的项目 └ source String 可选 tb 任务来源source
operator_userid	String	可选	1111	操作者id
task_id	String	必须	1	任务ID

响应参数

名称	类型	示例值	描述
errcode	Number	0000	错误码
errmsg	String	参数错误	错误描述

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/workspace/task/update");
OapiWorkspaceTaskUpdateRequest req = new OapiWorkspaceTaskUpdateRequest();
req.setMicroappAgentId(1111L);
TaskUpdate obj1 = new TaskUpdate();
obj1.setSourceId("tb-sourceId");
obj1.setIsRecycled(false);
obj1.setGmtModified(StringUtils.parseDateTime("2020-01-14 14:39:51"));
obj1.setExecutorUserid("1111");
obj1.setSubject("测试任务");
obj1.setIsArchived(false);
obj1.setModifierUserid("1111");
obj1.setDescription("这是一条测试任务的描述");
obj1.setPriority(1L);
obj1.setParentId("1");
obj1.setTaskTypeId(1L);
obj1.setStatusId(1L);
obj1.setStatusStage(1L);
obj1.setFinishDate(StringUtils.parseDateTime("2020-01-14 14:39:51"));
obj1.setStartDate(StringUtils.parseDateTime("2020-01-14 14:39:51"));
obj1.setTaskTypeCategory("req");
obj1.setPlanStartDate(StringUtils.parseDateTime("2020-01-14 14:39:51"));
obj1.setPlanFinishDate(StringUtils.parseDateTime("2020-01-14 14:39:51"));
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");
obj2.setSystemProperty(obj3);
obj1.setExtension(obj2);
obj1.setCorpId("ding9ede76239cf28b12ffe93478753d9884");
obj1.setSource("tb");
req.setTask(obj1);
req.setOperatorUserid("1111");
req.setTaskId("1");
OapiWorkspaceTaskUpdateResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/workspace/task/update");
OapiWorkspaceTaskUpdateRequest req = new OapiWorkspaceTaskUpdateRequest();
req.MicroappAgentId = 1111L;
OapiWorkspaceTaskUpdateRequest.TaskUpdateDomain obj1 = new OapiWorkspaceTaskUpdateRequest.TaskUpdateDomain();
obj1.SourceId = "tb-sourceId";
obj1.IsRecycled = false;
obj1.GmtModified = DateTime.Parse(2020-01-14 14:39:51");
obj1.ExecutorUserid = "1111";
obj1.Subject = "测试任务";
obj1.IsArchived = false;
obj1.ModifierUserid = "1111";
obj1.Description = "这是一条测试任务的描述";
obj1.Priority = 1L;
obj1.ParentId = "1";
obj1.TaskTypeId = 1L;
obj1.StatusId = 1L;
obj1.StatusStage = 1L;
obj1.FinishDate = DateTime.Parse(2020-01-14 14:39:51");
obj1.StartDate = DateTime.Parse(2020-01-14 14:39:51");
obj1.TaskTypeCategory = "req";
obj1.PlanStartDate = DateTime.Parse(2020-01-14 14:39:51");
obj1.PlanFinishDate = DateTime.Parse(2020-01-14 14:39:51");
obj1.TrackerUserids = ""userid1","userid2","userid3"";
OapiWorkspaceTaskUpdateRequest.TaskExtensionDomain obj2 = new OapiWorkspaceTaskUpdateRequest.TaskExtensionDomain();
obj2.CommentCount = 3L;
obj2.FilePath = "http://xxx";
obj2.Other = "{\"key\":\"value\"}";
OapiWorkspaceTaskUpdateRequest.TaskSystemPropertyDomain obj3 = new OapiWorkspaceTaskUpdateRequest.TaskSystemPropertyDomain();
obj3.AppUrl = "http://xxx";
obj3.WebUrl = "http://xxx";
obj2.SystemProperty= obj3;
obj1.Extension= obj2;
obj1.CorpId = "ding9ede76239cf28b12ffe93478753d9884";
obj1.Source = "tb";
req.Task_ = obj1;
req.OperatorUserid = "1111";
req.TaskId = "1";
OapiWorkspaceTaskUpdateResponse 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 OapiWorkspaceTaskUpdateRequest;
$req->setMicroappAgentId("1111");
$task = new TaskUpdate;
$task->source_id="tb-sourceId";
$task->is_recycled="false";
$task->gmt_modified="2020-01-14 14:39:51";
$task->executor_userid="1111";
$task->subject="测试任务";
$task->is_archived="false";
$task->modifier_userid="1111";
$task->description="这是一条测试任务的描述";
$task->priority="1";
$task->parent_id="1";
$task->task_type_id="1";
$task->status_id="1";
$task->status_stage="1";
$task->finish_date="2020-01-14 14:39:51";
$task->start_date="2020-01-14 14:39:51";
$task->task_type_category="req";
$task->plan_start_date="2020-01-14 14:39:51";
$task->plan_finish_date="2020-01-14 14:39:51";
$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";
$extension->systemProperty = $systemProperty;
$task->extension = $extension;
$task->corp_id="ding9ede76239cf28b12ffe93478753d9884";
$task->source="tb";
$req->setTask($task);
$req->setOperatorUserid("1111");
$req->setTaskId("1");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/workspace/task/update");

curl -X POST "https://oapi.dingtalk.com/topapi/workspace/task/update" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=03ab3e0e-9c57-4222-a201-347ac80dd969' \
-d 'microapp_agent_id=1111' \
-d 'operator_userid=1111' \
-d 'task=null' \
-d 'task_id=1'

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

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

req.microapp_agent_id=1111
req.task=""
req.operator_userid="1111"
req.task_id="1"
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.update");
add_param(pRequest,"microapp_agent_id","1111");
add_param(pRequest,"task","数据结构JSON示例");
add_param(pRequest,"operator_userid","1111");
add_param(pRequest,"task_id","1");
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.update', {
	'microapp_agent_id':'1111',
	'task':'数据结构JSON示例',
	'operator_userid':'1111',
	'task_id':'1'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "errcode":0000,
    "errmsg":"参数错误"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.workspace.task.update (更新任务基础信息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ