YesDev / WebAPI / 智能获取项目的需求列表

智能获取项目的需求列表

接口描述: 可以获取项目的多种类型的需求列表,例如内部的需求列表、外部需求列表、协同需求列表。不同类型的请求,返回的字段会有所不同。

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

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
app_key字符串可选app_key,团队代码
sign字符串可选-动态签名,签名算法请联系我们技术客服获取
project_id整型必须-最小:1项目id
need_status数组用,分割可选需求状态,0需求中100设计中200排期中300研发中310待测试400测试中410待发布500已上线600已完成700挂起
need_list_type整型可选0项目需求列表类型,0全部,1内部项目需求列表,2外部需求列表,3外部协同需求列表
is_auto_tidy_up整型可选-自动收纳

返回字段

返回结果类型说明
ret整型状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误
data对象或混合类型业务数据,由各自接口指定,通常为对象
data.id整型需求ID
data.app_key字符串APPKEY
data.project_id整型项目ID
data.need_finish_date字符串完成时间
data.charge_staff_id整型负责人ID
data.need_name字符串需求名称
data.need_check_status整型审核状态
data.need_status整型需求状态
data.product_category_id整型产品线ID
data.need_level整型需求优先级
data.add_time字符串添加时间
data.staff_name字符串负责人姓名
data.outside_app_name字符串外部协作团队名称
data.need_status_name字符串需求状态说明
data.need_level_name字符串需求优先级说明
data.need_time_stat数组需求工时统计
msg字符串提示信息,失败时的错误提示

在线测试   

参数是否必须
service 必须
access_token 可选
app_key 可选
sign 可选
project_id 必须
need_status 可选
need_list_type 可选
is_auto_tidy_up 可选

客户端请求示例

{
    "ret": 200,
    "data": [
    {
        "id": 325,
        "app_key": "gc",
        "project_id": 167,
        "need_finish_date": "2021-06-15",
        "charge_staff_id": 89,
        "need_name": "送你一个需求",
        "need_check_status": 1,
        "need_status": 0,
        "product_category_id": 0,
        "need_level": 0,
        "admin_id": 1,
        "add_time": "2021-06-16 14:49:02",
        "staff_name": "test040622",
        "staff_title": "",
        "outside_app_name": null,
        "need_status_name": "需求中",
        "need_level_name": "低",
        "need_time_stat": []
    },
    {
        "id": 334,
        "app_key": "gc",
        "project_id": 167,
        "need_finish_date": "2021-06-25",
        "charge_staff_id": 116,
        "need_name": "主办方的需求",
        "need_check_status": 1,
        "need_status": 0,
        "product_category_id": 0,
        "need_level": 0,
        "admin_id": 1,
        "add_time": "2021-06-18 16:27:32",
        "staff_name": "test05181",
        "staff_title": "",
        "outside_app_name": null,
        "need_status_name": "需求中",
        "need_level_name": "低",
        "need_time_stat": []
    }
    ],
    "msg": ""
}

错误列表

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

本文档生成时间:2024-04-27 13:38:18 联系我们开通接入OpenAPI