HTTP/HTTPS
请求协议
YesDev / WebAPI / 添加或者更新模板
添加或者更新模板
接口地址:http://test.www.yesdev.cn/api/platform.php?s=Platform.Template_Template.AddOrUpdateTemplate
接口描述: 添加或者更新模板
接口参数
参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
---|---|---|---|---|---|
access_token | 字符串 | 可选 | 访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口 | ||
app_key | 字符串 | 可选 | app_key,团队代码 | ||
sign | 字符串 | 可选 | - | 动态签名,签名算法请联系我们技术客服获取 | |
module_type | 字符串 | 可选 | - | 哪个模块模板 1项目 2任务 3需求 4问题 5邮件模板 | |
module_type_string | 字符串 | 可选 | - | 用于区分的值 (文档偏好的话 需求的话 need_document technical_document 问题的话 bug improve hitch workorder 邮件模板 project_email project_week_email week_email month_email test_plan_email ) (筛选器的话 need problem) (工作台模板的话 对应应的模板id(1,2,3,4,5)) (展示模块模板的话 对应应的id) | |
template_type | 字符串 | 可选 | - | 类型再区分,模板类型10 文档偏好 20筛选器 30 工作台 40 展示模块 | |
template_title | 字符串 | 可选 | - | 模板标题 | |
template_content | 字符串 | 可选 | - | 模板内容,如果文档偏好直接填这个就行 | |
list_type | 枚举类型 | 可选 | - | 范围:need/problem/task/project | 列表类型 筛选器偏好,跟筛选器对齐 |
search_conditions | 数组用,分割 | 可选 | - | 只传勾选的搜索条件配置,多个用英文逗号分割,注意顺序,至少要选择一项。例如:search_conditions=id,name | |
need_fields | 数组用,分割 | 可选 | - | 最小:1 | 只传勾选的显示字段配置,多个用英文逗号分割,注意顺序,至少要选择一项。例如:search_conditions=id,name |
workbench_config_id | 字符串 | 可选 | - | 工作台配置id,注意,根据排序好的顺序传 | |
template_id | 字符串 | 可选 | - | 模板id | |
show_modules | 字符串 | 可选 | - | 展示模块id | |
quick_toolbar | 字符串 | 可选 | - | 快速工具栏 |
返回字段
返回结果 | 类型 | 说明 |
---|---|---|
ret | 整型 | 状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误 |
data | 对象或混合类型 | 业务数据,由各自接口指定,通常为对象 |
msg | 字符串 | 提示信息,失败时的错误提示 |
在线测试
参数 | 是否必须 | 值 |
---|---|---|
service | 必须 | |
access_token | 可选 | |
app_key | 可选 | |
sign | 可选 | |
module_type | 可选 | |
module_type_string | 可选 | |
template_type | 可选 | |
template_title | 可选 | |
template_content | 可选 | |
list_type | 可选 | |
search_conditions | 可选 | |
need_fields | 可选 | |
workbench_config_id | 可选 | |
template_id | 可选 | |
show_modules | 可选 | |
quick_toolbar | 可选 |
客户端请求示例
# 暂无示例,可添加示例文件:./src/view/docs/demos/Platform.Template_Template.AddOrUpdateTemplate.json
错误列表
错误状态码 | 错误描述信息 |
---|---|
400 | ret=400,客户端参数错误或非法请求 |
404 | 表示接口服务不存在 |
406 | ret=406,access_token令牌校验不通过 |
407 | ret=407,app_key权限不足,或未知应用 |
408 | ret=408,当前用户禁止使用,或用户未登录 |
410 | 权限不足 |
500 | 表示服务端内部错误 |
本文档生成时间:2025-01-15 15:12:53 联系我们开通接入OpenAPI