修改事件通知配置 - UpdateMessageNoticesConfigs_项目配置管理_API_API参考

功能介绍

此接口用于修改事件通知配置,可以针对不同的事件类型,选择是否开启发送服务动态以及是否开启发送邮件通知,目前已由CodeArts统一管理,对应页面

设置 -> 通用设置 -> 通知设置

调用方法

URI

PUT /v4/projects/{project_id}/message-notices

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
id	是	String	通知id
name	否	String	通知配置名称
type	是	Integer	参数解释: 消息类型约束限制: 不涉及取值范围: 0，测试管理类型。 1，接口测试类型。默认取值: 不涉及
send_email	是	Boolean	是否发送邮件
send_message	是	Boolean	是否发送动态
project_id	否	String	项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID
notice_users	否	Array of NameAndIdVo objects	通知用户

表3 NameAndIdVo
参数	是否必选	参数类型	描述
id	否	String	参数解释 NameAndIdVo对象的唯一标识ID 取值范围不涉及
name	否	String	参数解释 NameAndIdVo对象的显示名称取值范围不涉及

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
value	String	参数解释请求返回的数据取值范围不涉及

状态码：400

表5 响应Body参数
参数	参数类型	描述
error_code	String	参数解释: 接口调用失败错误码取值范围: 不涉及
error_msg	String	参数解释: 接口调用失败错误信息取值范围: 不涉及

状态码：401

表6 响应Body参数
参数	参数类型	描述
error_code	String	参数解释: 接口调用失败错误码取值范围: 不涉及
error_msg	String	参数解释: 接口调用失败错误信息取值范围: 不涉及

状态码：404

表7 响应Body参数
参数	参数类型	描述
error_code	String	参数解释: 接口调用失败错误码取值范围: 不涉及
error_msg	String	参数解释: 接口调用失败错误信息取值范围: 不涉及

状态码：500

表8 响应Body参数
参数	参数类型	描述
error_code	String	参数解释: 接口调用失败错误码取值范围: 不涉及
error_msg	String	参数解释: 接口调用失败错误信息取值范围: 不涉及

请求示例

put https://{endpoint}/v4/projects/75681cbb7c324e15a9eb8ee74a96a474/message-notices

{
  "id" : "deleteTestCase",
  "name" : "删除用例",
  "type" : 0,
  "send_email" : true,
  "send_message" : true,
  "project_id" : "75681cbb7c324e15a9eb8ee74a96a474",
  "notice_users" : [ { } ]
}

响应示例

状态码：200

{
  "status" : "string",
  "result" : "ok",
  "error" : { },
  "request_id" : "string",
  "server_address" : "string"
}

状态码

状态码	描述
200	OK
400	Bad Request
401	Unauthorized
404	Not Found
500	Internal Server Error

错误码

请参见错误码。

修改事件通知配置 - UpdateMessageNoticesConfigs