YesDev / Mobile\ / 添加新备注

添加新备注

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-动态签名,签名算法请联系我们技术客服获取
note_content字符串Required-min: 1备注,支持富文本
project_id整型Optional0项目ID
need_id整型Optional0需求ID
bug_id整型Optional0问题ID
problem_id整型Optional0问题ID
task_id整型Optional0任务id
test_case_id整型Optional0测试用例id
test_plan_id整型Optional0测试计划id
document_id整型Optional0文档id
from_channel字符串Optional来源,项目:detail_in_PROJECT,任务:detail_in_TASK
notice_staff_ids字符串Optional通知成员消息
customer_id整型Optional0客户ID

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.id整型新增的备注ID
msgstringmessage, usually error message

Test Online   

ParameterIs RequiredValue
service Required
access_token Optional
app_key Optional
sign Optional
note_content Required
project_id Optional
need_id Optional
bug_id Optional
problem_id Optional
task_id Optional
test_case_id Optional
test_plan_id Optional
document_id Optional
from_channel Optional
notice_staff_ids Optional
customer_id Optional

Client Request Demo

# 暂无示例,可添加示例文件:./src/view/docs/demos/Mobile.Notes_Note.CreateNewNote.json

Error List

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

Last generated at: 2026-05-31 08:17:00 联系我们开通接入OpenAPI