YesDev / Platform API / 需求更新,按需更新

需求更新,按需更新

API Description: 可以进行按需更新,更新需求的信息

HTTP/HTTPS
Protocol
GET/POST
Method
UTF-8
Charset
JSON
Format

API Parameters

Parameter NameTypeIs RequiredDefaultNoteDescription
access_token字符串Optional访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
app_key字符串Optionalapp_key,团队代码
sign字符串Optional-动态签名,签名算法请联系我们技术客服获取
id整型Required-ID
need_name字符串Optional-max: 500需求名称
need_check_status整型Optional-需求评审状态,0待评审1已评审2不需要评审
need_status整型Optional-需求状态,0需求中100设计中200排期中300研发中310待测试400测试中410待发布500已上线600已完成700挂起
product_category_id整型Optional-产品线ID
product_category_version_id整型Optional0产品线版本id
need_from字符串Optional-max: 200需求方
need_start_date字符串Optional-计划开始时间
need_finish_date字符串Optional-计划完成时间
need_content字符串Optional-需求内容
need_note字符串Optional-备注
note_content_remark字符串Optional-备注,支持富文本,辅助信息,用于消息推送,同时添加一条备注
need_level整型Optional-max: 4优先级,0低1中2高3紧急
charge_staff_id整型Optional-需求负责人员工ID
test_charge_staff_id整型Optional-测试负责人员工ID
version_nums字符串Optional0编辑时使用的版本号
outside_charge_name字符串Optional-max: 50外部对接人
prd_id字符串Optional-max: 50需求关联prd
need_content_email字符串Optional-max: 50需求内容通知
project_id整型Optional-关联项目ID
note_from_channel字符串Optional-备注来源
notice_staff_ids字符串Optional通知成员消息
need_plan_id字符串Optional-需求规划id
is_delay_reminder整型Optional-是否延期
delay_reminder_day_nums整型Optional-延期天数
is_submit_test整型Optional0是提交测的,1是提交 0 不提交
custom_field_value数组jsonOptional-需求自定义字段,格式:{"系统KEY":"值","_CFKEY_1":"xxx"}
need_parent_id整型Optional-父需求ID
need_weight整型Optional-min: 0需求权重

Return Field

Response ResultTypeDescription
retintstatus code, 200 is ok, 4xx is bad request, 5xx is server inside error
dataobject/mixedbusiness data, decided by API implementation
data.is_updated整型是否更新
msgstringmessage, usually error message

Test Online   

ParameterIs RequiredValue
service Required
access_token Optional
app_key Optional
sign Optional
id Required
need_name Optional
need_check_status Optional
need_status Optional
product_category_id Optional
product_category_version_id Optional
need_from Optional
need_start_date Optional
need_finish_date Optional
need_content Optional
need_note Optional
note_content_remark Optional
need_level Optional
charge_staff_id Optional
test_charge_staff_id Optional
version_nums Optional
outside_charge_name Optional
prd_id Optional
need_content_email Optional
project_id Optional
note_from_channel Optional
notice_staff_ids Optional
need_plan_id Optional
is_delay_reminder Optional
delay_reminder_day_nums Optional
is_submit_test Optional
custom_field_value Optional
need_parent_id Optional
need_weight Optional

Client Request Demo

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

Error List

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

Last generated at: 2025-08-03 17:30:16 联系我们开通接入OpenAPI