YesDev / WebAPI / 获取项目详情

获取项目详情

接口描述: 获取项目详情

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

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
app_key字符串可选app_key,团队代码
sign字符串可选-动态签名,签名算法请联系我们技术客服获取
id整型必须-项目ID
is_record_staff_historical_update_version整型可选0是否后端保存该成员当前版本为最新版本

返回字段

返回结果类型说明
ret整型状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误
data对象或混合类型业务数据,由各自接口指定,通常为对象
data.id整型ID
data.project_name字符串项目名称
data.admin_id整型
data.project_type整型项目类型,0迭代需求1新产品2重构项目3故障修复 10内部项目,11协作项目
data.project_start_time字符串项目开始时间,如:2020-10-10,未设置时为null
data.project_end_time字符串项目结束时间,如:2020-10-10,未设置时为null
data.project_product_id整型所属产品ID
data.project_desc字符串项目描述
data.project_status整型项目状态,0规划中1进行中2已完成3挂起
data.add_time字符串创建时间
data.charge_staff_id整型项目负责人(员工ID)
data.charge_staff_name字符串项目负责人
data.project_product_name字符串所属产品名称
data.project_need_list数组项目需求列表
data.project_need_list[].outside_app_name字符串外部协作的团队名称,没有时为null或为空,20210625新增
data.project_need_list[].outside_staff_name字符串外部对接人姓名
data.外部对接人员工IDintproject_need_list[].outside_staff_id
data.nav_count对象导航数量统计
data.visit_mode整型访问模式,10内部项目,21协作项目-主办方,22协作项目-协作方
data.cur_app_key字符串当前团队代码
data.app_name字符串主办方的团队名称
data.outside_app_num整型外部协作团队数量
msg字符串提示信息,失败时的错误提示

在线测试   

参数是否必须
service 必须
access_token 可选
app_key 可选
sign 可选
id 必须
is_record_staff_historical_update_version 可选

客户端请求示例

{
    "ret": 200,
    "data": {
        "id": 167,
        "project_name": "外部协作项目示例",
        "admin_id": 1,
        "project_type": 11,
        "project_start_time": "2021-06-18",
        "project_end_time": "2021-06-29",
        "project_product_id": 9,
        "project_desc": "<p>项目背景:</p><p>作为外部协作项目的PRD示例。</p><p><br/></p><p>项目描述:</p><p><br/><br/></p>",
        "project_status": 0,
        "add_time": "2021-06-18 16:27:49",
        "app_key": "gc",
        "charge_staff_id": 13,
        "workgroup_id": 5,
        "top_time": 0,
        "sys_update_time": "2021-06-24 16:09:43",
        "created_staff_id": 13,
        "refuse_delete": 0,
        "from_channel": "top_button",
        "charge_staff_name": "司马光",
        "avatar": "",
        "project_product_name": "YesDev",
        "workgroup_name": "第1战队",
        "percent": 21,
        "all": 68,
        "doing": 22,
        "done": 14,
        "todo": 32,
        "app_name": "广州果创",
        "cur_app_key": "gc",
        "visit_mode": 21,
        "project_status_explain": "规划中",
        "project_need_list": [
        {
            "id": 335,
            "app_key": "gc",
            "project_id": 167,
            "need_finish_date": "2021-06-25",
            "charge_staff_id": 89,
            "need_name": "协作方A的需求",
            "need_check_status": 1,
            "need_status": 3,
            "product_category_id": 0,
            "need_level": 0,
            "admin_id": 1,
            "add_time": "2021-06-18 16:27:44",
            "staff_name": "test040622",
            "staff_title": "",
            "outside_app_name": null,
            "outside_staff_name": null,
            "outside_staff_id": 0,
            "need_status_name": "研发中",
            "need_level_name": "低",
            "need_time_stat": [],
            "need_check_status_name": "已评审"
        }
        ],
        "problem_count": {
            "problem_status_wait": 0,
            "problem_status_fixing": 2,
            "problem_status_reopen": 0,
            "problem_status_fixed": 1,
            "problem_status_delay": 2,
            "problem_status_ignore": 0,
            "problem_status_closed": 0,
            "problem_total": 5,
            "problem_finish": 2,
            "problem_percent": 40
        },
        "nav_count": {
            "project_percent": 21,
            "need_nums": 4,
            "task_nums": 8,
            "problem_nums": 5,
            "desc_update_nums": 0,
            "note_nums": 1,
            "url_nums": 1,
            "file_nums": 1
        }
    },
    "msg": ""
}

错误列表

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

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