HTTP/HTTPS
请求协议
YesDev / WebAPI / 获取项目任务列表
获取项目任务列表
接口地址:http://test.www.yesdev.cn/api/platform.php?s=Platform.Tasks.SmartGetProjectTaskList
接口描述: 获取项目任务列表,可以获取多种项目类型的任务列表
接口参数
参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
---|---|---|---|---|---|
access_token | 字符串 | 可选 | 访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口 | ||
app_key | 字符串 | 可选 | app_key,团队代码 | ||
sign | 字符串 | 可选 | - | 动态签名,签名算法请联系我们技术客服获取 | |
project_id | 整型 | 必须 | - | 最小:1 | 项目id |
task_list_type | 整型 | 可选 | 0 | 项目任务列表类型,0全部,1内部项目任务列表,2外部任务列表,3外部协同任务列表 | |
task_status | 数组用,分割 | 可选 | 任务状态,多个用英文逗号分割 | ||
is_auto_tidy_up | 整型 | 可选 | - | 自动收纳 | |
is_show_need_task_list | 整型 | 可选 | 0 | 需求任务形式展示 | |
is_show_charge_task_list | 整型 | 可选 | 0 | 负责人形式展示 | |
is_milestone | 布尔型 | 可选 | - | 是否任务里程碑,0否1是 | |
is_task_delay | 布尔型 | 可选 | false | 是否只查遗留任务 |
返回字段
返回结果 | 类型 | 说明 |
---|---|---|
ret | 整型 | 状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误 |
data | 对象或混合类型 | 业务数据,由各自接口指定,通常为对象 |
data.task_list | 数组 | 任务列表 |
data.task_list[].id | 整型 | 任务ID |
data.task_list[].task_title | 字符串 | 任务标题 |
data.task_list[].task_type | 整型 | 任务类型 |
data.task_list[].task_time | 字符串 | 任务工时(H) |
data.task_list[].task_finish_time | 字符串 | 完成时间 |
data.task_list[].task_status | 整型 | 任务状态 |
data.task_list[].staff_id | 整型 | 员工ID |
data.task_list[].task_desc | 字符串 | 任务描述 |
data.task_list[].staff_name | 字符串 | 负责人姓名 |
data.task_list[].project_id | 整型 | 项目ID,没有时为null |
data.task_list[].need_id | 整型 | 需求ID,没有时为null |
data.task_list[].need_name | 字符串 | 需求名称,没有时为null |
data.task_list[].task_type_name | 字符串 | 任务类型说明 |
data.task_list[].task_status_name | 字符串 | 任务状态说明 |
data.task_list[].outside_app_key | 字符串 | 外部协作团队代码 |
data.task_list[].outside_app_name | 字符串 | 外部协作团队名称,没有时为null |
data.task_list[].outside_staff_name | 字符串 | 外部协作人姓名 |
data.task_list[].outside_staff_id | 字符串 | 外部协作员工ID |
msg | 字符串 | 提示信息,失败时的错误提示 |
在线测试
参数 | 是否必须 | 值 |
---|---|---|
service | 必须 | |
access_token | 可选 | |
app_key | 可选 | |
sign | 可选 | |
project_id | 必须 | |
task_list_type | 可选 | |
task_status | 可选 | |
is_auto_tidy_up | 可选 | |
is_show_need_task_list | 可选 | |
is_show_charge_task_list | 可选 | |
is_milestone | 可选 | |
is_task_delay | 可选 |
客户端请求示例
{
"ret": 200,
"data": {
"task_list": [
{
"id": 1083,
"task_title": "主办方的任务",
"task_type": 0,
"task_time": "32.0",
"task_finish_time": "2021-06-18",
"task_status": 0,
"staff_id": 13,
"task_desc": "",
"project_id": 167,
"staff_name": "司马光",
"staff_title": "",
"need_id": null,
"need_name": null,
"outside_app_name": null,
"outside_staff_name": null,
"outside_staff_id": 0,
"task_type_name": "其他",
"task_status_name": "TODO"
}
]
},
"msg": ""
}
错误列表
错误状态码 | 错误描述信息 |
---|---|
400 | ret=400,客户端参数错误或非法请求 |
404 | 表示接口服务不存在 |
406 | ret=406,access_token令牌校验不通过 |
407 | ret=407,app_key权限不足,或未知应用 |
408 | ret=408,当前用户禁止使用,或用户未登录 |
410 | 权限不足 |
500 | 表示服务端内部错误 |
本文档生成时间:2024-09-08 10:42:50 联系我们开通接入OpenAPI