YesDev / WebAPI / 获取产品需求原型列表

获取产品需求原型列表

接口描述: 获取产品需求原型列表

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

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
app_key字符串可选app_key,团队代码
sign字符串可选-动态签名,签名算法请联系我们技术客服获取
project_id整型可选-项目id
prd_name字符串可选-最大:100产品需求原型名称
product_category_id整型可选-产品线id
page整型可选1最小:1当前页数
perpage整型可选10最小:1每页多少条
is_not_page整型可选0不分页
is_not_relation_project整型可选0没关联项目的;0-否;1-是

返回字段

返回结果类型说明
ret整型状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误
data对象或混合类型业务数据,由各自接口指定,通常为对象
data.total整型总数
data.items数组列表
data.items[].id整型ID
data.items[].prd_name字符串名称标题
data.items[].update_time字符串更新时间
data.items[].add_time字符串添加时间
data.items[].prd_size整型大小
data.items[].prd_rights整型谁可以看,0公开1保护2私有
data.items[].prd_link字符串演示地址,长链接
data.items[].prd_link_short字符串演示地址,短链接
data.items[].prd_size_str字符串大小格式化后的显示,如:1.310 MB
data.items[].admin_id整型作者ID
data.items[].admin_name字符串作者名字
data.items[].product_category_id整型产品线ID
data.items[].product_category_name字符串产品线名称
msg字符串提示信息,失败时的错误提示

在线测试   

参数是否必须
service 必须
access_token 可选
app_key 可选
sign 可选
project_id 可选
prd_name 可选
product_category_id 可选
page 可选
perpage 可选
is_not_page 可选
is_not_relation_project 可选

客户端请求示例

{
    "ret": 200,
    "data": {
        "total": 2,
        "items": [
        {
            "id": 2,
            "prd_name": "test",
            "update_time": "2020-10-22 15:19:16",
            "add_time": "2020-10-22 15:19:16",
            "prd_size": 1373958,
            "prd_rights": 1,
            "prd_link": "http://www.yesinew.com/cloud/prd/cKBXr0X6fdU3gUU12/20200910%20PhalApi%E4%B8%93%E4%B8%9A%E7%89%88-%E5%95%86%E5%9F%8E%E7%89%88",
            "admin_id": 1,
            "admin_name": "admin(超级管理员)",
            "prd_link_short": "http://www.yesinew.com/prd-2.html",
            "prd_size_str": "1.310 MB"
        },
        {
            "id": 1,
            "prd_name": "test",
            "update_time": "2020-10-22 15:15:36",
            "add_time": "2020-10-22 15:15:36",
            "prd_size": 1373958,
            "prd_rights": 1,
            "prd_link": "http://www.yesinew.com/cloud/prd/3V2BIRGHnHHpFUhLQLu8E9gh4g/20200910%20PhalApi%E4%B8%93%E4%B8%9A%E7%89%88-%E5%95%86%E5%9F%8E%E7%89%88",
            "admin_id": 1,
            "admin_name": "admin(超级管理员)",
            "prd_link_short": "http://www.yesinew.com/prd-1.html",
            "prd_size_str": "1.310 MB"
        }
        ],
        "page": 1,
        "perpage": 2
    },
    "msg": ""
}

错误列表

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

本文档生成时间:2024-05-02 08:20:10 联系我们开通接入OpenAPI