根据sourceId获取钉钉待办任务详情
GET
/v1.0/todo/users/{unionId}/tasks/sources/{sourceId}最后修改时间:: 2 年前
责任人: 未设置
说明
调用本接口根据业务来源sourceId获取钉钉待办任务详情信息及状态。
服务地址:api.dingtalk.com
权限
要调用此API,需要以下权限之一。
应用类型 | 是否支持 | 权限 | API Explorer调试 |
---|---|---|---|
企业内部应用 | 支持 | 待办应用中待办读权限 | API Explorer |
第三方企业应用 | 支持 | 待办应用中待办读权限 | API Explorer |
第三方个人应用 | 暂不支持 | 待办应用中待办读权限 | 暂不支持 |
错误码
HttpCode | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | todo.taskGet.paramError | todo.taskGet.paramError | 根据sourceId获取待办详情参数异常 |
500 | todo.taskGet.systemError | todo.taskGet.systemError | 根据sourceId获取待办详情系统异常 |
请求参数
Path 参数
unionId
string
必需
当前访问资源所归属用户的unionId,和创建者的unionId保持一致,可通过根据userid获取用户详情接口获取。
sourceId
string
必需
待办业务来源sourceId。sourceId为创建待办时传入的sourceId。
Header 参数
x-acs-dingtalk-access-token
string
必需
调用该接口的访问凭证。如何获取不同应用的凭证请参考访问凭证概述。
Body 参数application/json
object {0}
示例
{}
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
id
string
待办ID。
subject
string
待办标题。
description
string
待办描述。
startTime
integer
可选
开始时间,Unix时间戳,单位毫秒。
dueTime
integer
可选
截止时间,Unix时间戳,单位毫秒。
finishTime
integer
可选
完成时间,Unix时间戳,单位毫秒。
done
boolean
完成状态。
executorIds
array[string]
可选
执行者的unionId。
participantIds
array[string]
可选
参与者的unionId。
detailUrl
object
可选
自定义详情页跳转配置。
pcUrl
string
可选
PC端详情页url跳转地址。
appUrl
string
可选
APP端详情页url跳转地址。
sourceId
string
可选
业务系统侧的唯一标识ID,即业务ID。
source
string
业务来源。
createdTime
integer
可选
创建时间,Unix时间戳,单位毫秒。
modifiedTime
integer
可选
更新时间,Unix时间戳,单位毫秒。
creatorId
string
可选
创建者的unionId。
modifierId
string
可选
更新者的unionId。
tenantId
string
租户ID。
tenantType
string
可选
租户类型。user:个人org:企业group:群
bizTag
string
接入业务应用标识。
requestId
string
请求ID。
isOnlyShowExecutor
boolean
可选
待办是否仅展示在执行人的待办列表中。
priority
integer
可选
优先级,取值:10:较低20:普通30:紧急40:非常紧急
示例
{
"id": "string",
"subject": "string",
"description": "string",
"startTime": 0,
"dueTime": 0,
"finishTime": 0,
"done": true,
"executorIds": [
"string"
],
"participantIds": [
"string"
],
"detailUrl": {
"pcUrl": "string",
"appUrl": "string"
},
"sourceId": "string",
"source": "string",
"createdTime": 0,
"modifiedTime": 0,
"creatorId": "string",
"modifierId": "string",
"tenantId": "string",
"tenantType": "string",
"bizTag": "string",
"requestId": "string",
"isOnlyShowExecutor": true,
"priority": 0
}
最后修改时间: 2 年前