YesDev
HTTP/HTTPS
请求协议
YesDev / WebAPI / 需求更新，按需更新
需求更新，按需更新
接口地址：https://www.yesdev.cn/api/platform.php?s=Platform.PRD_Need.UpdateNeedLite
接口描述： 可以进行按需更新，更新需求的信息
接口参数
| 参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
|---|---|---|---|---|---|
| access_token | 字符串 | 可选 | 访问令牌，仅当开启签名验证时需要传递，生成令牌可使用App.Auth.ApplyToken接口 | ||
| app_key | 字符串 | 可选 | app_key，团队代码 | ||
| sign | 字符串 | 可选 | - | 动态签名，签名算法请联系我们技术客服获取 | |
| id | 整型 | 必须 | - | ID | |
| need_name | 字符串 | 可选 | - | 最大：200 | 需求名称 |
| need_check_status | 整型 | 可选 | - | 需求评审状态，0待评审1已评审2不需要评审 | |
| need_status | 整型 | 可选 | - | 需求状态，0需求中100设计中200排期中300研发中310待测试400测试中410待发布500已上线600已完成700挂起 | |
| product_category_id | 整型 | 可选 | - | 产品线ID | |
| product_category_version_id | 整型 | 可选 | 0 | 产品线版本id | |
| need_from | 字符串 | 可选 | - | 最大：200 | 需求方 |
| need_start_date | 字符串 | 可选 | - | 计划开始时间 | |
| need_finish_date | 字符串 | 可选 | - | 计划完成时间 | |
| need_content | 字符串 | 可选 | - | 需求内容 | |
| need_note | 字符串 | 可选 | - | 备注 | |
| note_content_remark | 字符串 | 可选 | - | 备注，支持富文本，辅助信息，用于消息推送,同时添加一条备注 | |
| need_level | 整型 | 可选 | - | 最大：4 | 优先级，0低1中2高3紧急 |
| charge_staff_id | 整型 | 可选 | - | 需求负责人员工ID | |
| test_charge_staff_id | 整型 | 可选 | - | 测试负责人员工ID | |
| version_nums | 字符串 | 可选 | 0 | 编辑时使用的版本号 | |
| outside_charge_name | 字符串 | 可选 | - | 最大：50 | 外部对接人 |
| prd_id | 字符串 | 可选 | - | 最大：50 | 需求关联prd |
| need_content_email | 字符串 | 可选 | - | 最大：50 | 需求内容通知 |
| project_id | 整型 | 可选 | - | 关联项目ID | |
| note_from_channel | 字符串 | 可选 | - | 备注来源 | |
| notice_staff_ids | 字符串 | 可选 | 通知成员消息 | ||
| need_plan_id | 字符串 | 可选 | - | 需求规划id | |
| is_delay_reminder | 整型 | 可选 | - | 是否延期 | |
| delay_reminder_day_nums | 整型 | 可选 | - | 延期天数 | |
| is_submit_test | 整型 | 可选 | 0 | 是提交测的，1是提交 0 不提交 | |
| custom_field_value | 数组JSON格式 | 可选 | - | 需求自定义字段，格式：{"系统KEY":"值","_CFKEY_1":"xxx"} |
返回字段
| 返回结果 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务器错误 |
| data | 对象或混合类型 | 业务数据，由各自接口指定，通常为对象 |
| data.is_updated | 整型 | 是否更新 |
| msg | 字符串 | 提示信息，失败时的错误提示 |
在线测试
| 参数 | 是否必须 | 值 |
|---|---|---|
| service | 必须 | |
| access_token | 可选 | |
| app_key | 可选 | |
| sign | 可选 | |
| id | 必须 | |
| 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 | 可选 | |
| note_content_remark | 可选 | |
| need_level | 可选 | |
| charge_staff_id | 可选 | |
| test_charge_staff_id | 可选 | |
| version_nums | 可选 | |
| outside_charge_name | 可选 | |
| prd_id | 可选 | |
| need_content_email | 可选 | |
| project_id | 可选 | |
| note_from_channel | 可选 | |
| notice_staff_ids | 可选 | |
| need_plan_id | 可选 | |
| is_delay_reminder | 可选 | |
| delay_reminder_day_nums | 可选 | |
| is_submit_test | 可选 | |
| custom_field_value | 可选 |
客户端请求示例
# 暂无示例，可添加示例文件：./src/view/docs/demos/Platform.PRD_Need.UpdateNeedLite.json错误列表
| 错误状态码 | 错误描述信息 |
|---|---|
| 400 | ret=400，客户端参数错误或非法请求 |
| 404 | 表示接口服务不存在 |
| 406 | ret=406，access_token令牌校验不通过 |
| 407 | ret=407，app_key权限不足，或未知应用 |
| 408 | ret=408，当前用户禁止使用，或用户未登录 |
| 410 | 权限不足 |
| 500 | 表示服务端内部错误 |
本文档生成时间：2024-05-09 20:47:41 联系我们开通接入OpenAPI