YesDev / WebAPI / 提需求

提需求

接口描述: 提需求

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

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
app_key字符串可选app_key,团队代码
sign字符串可选-动态签名,签名算法请联系我们技术客服获取
need_name字符串必须-最大:200需求名称
need_check_status整型可选0需求评审状态,0待评审1已评审2不需要评审
need_status整型可选0需求状态,0需求中100设计中200排期中300研发中310待测试400测试中410待发布500已上线600已完成700挂起
product_category_id整型可选0产品线ID
product_category_version_id整型可选0产品线版本id
need_from字符串可选最大:200需求方
need_start_date字符串可选-计划开始时间
need_finish_date字符串可选-计划完成时间
need_content字符串可选需求内容
need_note字符串可选备注
need_level整型可选0最大:4优先级,0低1中2高3紧急
charge_staff_id整型可选0需求负责人员工ID
prd_id整型可选0关联的prd
not_send_email整型可选0不发送邮件
project_id整型可选-绑定项目id
from_channel字符串可选
test_charge_staff_id整型可选0测试负责人ID
follow_staff_id字符串可选-抄送给的员工id,多个以英文逗号隔开
sop_id字符串可选-SOPid,多个以英文逗号隔开
label_ids数组用,分割可选标签ids 逗号分隔
custom_field_value数组JSON格式可选-需求自定义字段,格式:{"系统KEY":"值","_CFKEY_1":"xxx"}

返回字段

返回结果类型说明
ret整型状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误
data对象或混合类型业务数据,由各自接口指定,通常为对象
data.id整型新ID
msg字符串提示信息,失败时的错误提示

在线测试   

参数是否必须
service 必须
access_token 可选
app_key 可选
sign 可选
need_name 必须
need_check_status 可选
need_status 可选
product_category_id 可选
product_category_version_id 可选
need_from 可选
need_start_date 可选
need_finish_date 可选
need_content 可选
need_note 可选
need_level 可选
charge_staff_id 可选
prd_id 可选
not_send_email 可选
project_id 可选
from_channel 可选
test_charge_staff_id 可选
follow_staff_id 可选
sop_id 可选
label_ids 可选
custom_field_value 可选

客户端请求示例

{
    "ret": 200,
    "data": {
        "id": 1
    },
    "msg": ""
}

错误列表

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

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