YesDev / WebAPI / 获取项目任务列表

获取项目任务列表

接口描述: 获取项目任务列表,可以获取多种项目类型的任务列表

HTTP/HTTPS
请求协议
GET/POST
请求方式
UTF-8
编码格式
JSON
返回格式

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
app_key字符串可选app_key,团队代码
sign字符串可选-动态签名,签名算法请联系我们技术客服获取
project_id整型必须-最小:1项目id
task_list_type整型可选0项目任务列表类型,0全部,1内部项目任务列表,2外部任务列表,3外部协同任务列表
task_status数组用,分割可选任务状态,0待办,1已开始,2已完成,多个用英文逗号分割
is_auto_tidy_up整型可选-自动收纳
is_show_need_task_list整型可选0需求任务形式展示
is_show_charge_task_list整型可选0负责人形式展示

返回字段

返回结果类型说明
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 可选

客户端请求示例

{
    "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": ""
}

错误列表

错误状态码错误描述信息
400ret=400,客户端参数错误或非法请求
404表示接口服务不存在
406ret=406,access_token令牌校验不通过
407ret=407,app_key权限不足,或未知应用
408ret=408,当前用户禁止使用,或用户未登录
410权限不足
500表示服务端内部错误

本文档生成时间:2024-04-27 19:47:21 联系我们开通接入OpenAPI