YesDev / WebAPI / 获取外部协作项目列表

获取外部协作项目列表

接口描述: 获取外部协作项目列表

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

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
app_key字符串可选app_key,团队代码
sign字符串可选-动态签名,签名算法请联系我们技术客服获取
id整型可选-项目ID
project_name字符串可选-项目名称
page整型可选1当前页数
perpage整型可选50每页多少条

返回字段

返回结果类型说明
ret整型状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误
data对象或混合类型业务数据,由各自接口指定,通常为对象
data.projects数组项目列表
data.projects[].charge_staff_name数组项目负责人
data.projects[].project_type整型项目类型,11外部协作项目
data.projects[].need_list数组项目的需求列表
data.project[].need_list[].outside_app_name字符串外部协作的团队名称,没有时为null或为空,20210625新增
data.project[].need_list[].outside_charge_name字符串外部对接人姓名
data.projects[].all浮点型总工时
data.projects[].done浮点型已完成工时
data.projects[].percent浮点型完成进度
data.projects[].labels数组标签
data.projects[].labels[].name字符串标签名称
data.projects[].labels[].key字符串标签KEY
data.projects[].labels[].color字符串标签颜色
data.total整型总数
msg字符串提示信息,失败时的错误提示

在线测试   

参数是否必须
service 必须
access_token 可选
app_key 可选
sign 可选
id 可选
project_name 可选
page 可选
perpage 可选

客户端请求示例

{
    "ret": 200,
    "data": {
        "total": 1,
        "projects": [
        {
            "id": 167,
            "project_status": 0,
            "project_name": "外部协作项目示例",
            "project_type": 11,
            "project_start_time": "2021-06-18",
            "project_end_time": "2021-06-29",
            "project_product_id": 9,
            "add_time": "2021-07-02 16:37:57",
            "charge_staff_id": 13,
            "percent": 0,
            "all": 4,
            "doing": 0,
            "done": 0,
            "todo": 4,
            "charge_staff_name": "司马光",
            "app_name": "广州果创",
            "need_list": [
            {
                "id": 356,
                "app_key": "TQXGblyykIh",
                "project_id": 167,
                "need_finish_date": "2021-07-15",
                "charge_staff_id": 0,
                "need_name": "外部世界的需求",
                "need_check_status": 1,
                "need_status": 4,
                "product_category_id": 0,
                "need_level": 0,
                "admin_id": 246,
                "add_time": "2021-07-02 15:27:44",
                "staff_name": null,
                "staff_title": null,
                "app_name": "test全",
                "outside_app_name": null,
                "outside_charge_name": "0"
            },
            {
                "id": 336,
                "app_key": "gc",
                "project_id": 167,
                "need_finish_date": "2022-06-23",
                "charge_staff_id": 89,
                "need_name": "协作方B的需求",
                "need_check_status": 1,
                "need_status": 4,
                "product_category_id": 0,
                "need_level": 0,
                "admin_id": 1,
                "add_time": "2021-06-18 16:27:48",
                "staff_name": "test040622",
                "staff_title": "",
                "app_name": "广州果创",
                "outside_app_name": null,
                "outside_charge_name": "0"
            }
            ],
            "count": {
                "need_nums": 4,
                "wait_task_nums": 3,
                "wait_problem_nums": 2
            },
            "project_status_explain": "规划中",
            "labels": [],
            "follow_id": 0,
            "top_time": 0
        }
        ]
    },
    "msg": ""
}

错误列表

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

本文档生成时间:2024-04-27 15:11:58 联系我们开通接入OpenAPI