YesDev / WebAPI / 需求导出

需求导出

接口描述: 需求导出

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

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
app_key字符串可选app_key,团队代码
sign字符串可选-动态签名,签名算法请联系我们技术客服获取
id字符串可选-需求ids,多个用逗号
project_id字符串可选-项目id,多个用英文逗号隔开
is_project_task_not_need整型可选0限定项目id时生效
need_name字符串可选-最大:200需求名称
product_category_id整型可选-产品线id
need_level字符串可选-优先级,0低1中2高3紧急
need_status字符串可选-需求状态,0需求中100设计中200排期中300研发中310待测试400测试中410待发布500已上线600已完成700挂起
need_check_status字符串可选-需求评审状态,0待评审1已评审2不需要评审,支持多选,用英文逗号分割
is_have_project_id整型可选-是否关联项目的,1是关联的
is_assign_staff整型可选-我的需求,是否是指派给我的 1是
is_created_by_me整型可选-是否是我创建的需求, 1是
is_follow整型可选0是否抄送
is_test_by_me整型可选0我是否测试的
is_delay整型可选0我已延期
not_page整型可选0不分页,默认0是分页
charge_staff_ids字符串可选-负责人员工ID,支持多选,用英文逗号分割
test_charge_staff_ids字符串可选-测试负责人员工ID,支持多选,用英文逗号分割
created_staff_ids字符串可选-创建人员工ID,支持多选,用英文逗号分割
start_start_time字符串可选-开始时间-START
end_start_time字符串可选-开始时间-END
start_finish_time字符串可选-开始完成时间
end_finish_time字符串可选-结束完成时间
need_delay_days字符串可选-需求已延期超过(天),0表示当天就延期
start_add_time字符串可选-开始添加时间
end_add_time字符串可选-结束添加时间
start_update_time字符串可选-系统更新时间开始
end_update_time字符串可选-系统更新时间结束
need_from字符串可选-需求方
page整型可选1最小:1当前页数
perpage整型可选10最小:1每页多少条
order_status整型可选0排序:0 id排序,1优先级 2计划完成时间 3创建时间 4需求进度 5最后更新 6计划开始时间
order_status_sort整型可选0排序:0降序 1升序
need_fields数组用,分割可选需要导出的字段,为空时导出全部字段。多个用英文逗号分割,例如:need_fields=id,name
export_all_page整型可选0导出全部页,默认0是分页
export_extra_ids字符串可选0额外ids
label_ids字符串可选-标签ids 逗号分隔

返回字段

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

在线测试   

参数是否必须
service 必须
access_token 可选
app_key 可选
sign 可选
id 可选
project_id 可选
is_project_task_not_need 可选
need_name 可选
product_category_id 可选
need_level 可选
need_status 可选
need_check_status 可选
is_have_project_id 可选
is_assign_staff 可选
is_created_by_me 可选
is_follow 可选
is_test_by_me 可选
is_delay 可选
not_page 可选
charge_staff_ids 可选
test_charge_staff_ids 可选
created_staff_ids 可选
start_start_time 可选
end_start_time 可选
start_finish_time 可选
end_finish_time 可选
need_delay_days 可选
start_add_time 可选
end_add_time 可选
start_update_time 可选
end_update_time 可选
need_from 可选
page 可选
perpage 可选
order_status 可选
order_status_sort 可选
need_fields 可选
export_all_page 可选
export_extra_ids 可选
label_ids 可选

客户端请求示例

# 暂无示例,可添加示例文件:./src/view/docs/demos/Platform.PRD_Need.GetNeedListExportData.json

错误列表

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

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