获取事件通知配置 - ShowMessageNoticesConfig

功能介绍

此接口用于获取事件通知配置列表,对应页面测试 -> 测试设置 -> 消息通知中的查询配置列表 ,可与PUT /v4/projects/{project_id}/message-notices接口配合使用实现对通知功能的配置及查询

调用方法

URI

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

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

请求参数

无

响应参数

状态码：200

表2 响应Body参数
参数	参数类型	描述
status	String	参数解释: 调用此接口的响应状态。取值范围: success，表示接口调用成功。 error，表示接口调用失败。
result	ResultValueListProjectEventNotificationConfigInfo object	获取事件通知配置返回参数
error	ApiError object	错误信息
request_id	String	由接口调用方传入，建议使用UUID保证请求的唯一性。
server_address	String	本次请求的受理的服务地址

表3 ResultValueListProjectEventNotificationConfigInfo
参数	参数类型	描述
total	Integer	起始记录数大于实际总条数时，值为0，分页请求才有此值
value	Array of ProjectEventNotificationConfigInfo objects	实际的数据类型：单个对象，集合或 NULL
reason	String	业务失败的提示内容
page_size	Integer	分页大小
page_no	Integer	分页编码
has_more	Boolean	是否有更多

表4 ProjectEventNotificationConfigInfo
参数	参数类型	描述
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	通知用户

表5 NameAndIdVo
参数	参数类型	描述
id	String	ID
name	String	名称

表6 ApiError
参数	参数类型	描述
code	String	业务失败的错误编码
reason	String	业务失败的提示内容

状态码：400

表7 响应Body参数
参数	参数类型	描述
error_code	String	接口调用失败错误码
error_msg	String	接口调用失败错误信息

状态码：401

表8 响应Body参数
参数	参数类型	描述
error_code	String	接口调用失败错误码
error_msg	String	接口调用失败错误信息

状态码：404

表9 响应Body参数
参数	参数类型	描述
error_code	String	接口调用失败错误码
error_msg	String	接口调用失败错误信息

状态码：500

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	接口调用失败错误码
error_msg	String	接口调用失败错误信息

请求示例

post https://{endpoint}/v4/projects/f3087a82b44744c29a1bd69ab6ada154/message-notices

响应示例

状态码：200

{
  "value" : [ {
    "id" : "allocateTestCase",
    "name" : "分配用例处理者",
    "type" : 0,
    "send_email" : true,
    "send_message" : true
  }, {
    "id" : "deleteCata",
    "name" : "删除目录",
    "type" : 0,
    "send_email" : true,
    "send_message" : true
  }, {
    "id" : "deleteTestCase",
    "name" : "删除用例",
    "type" : 0,
    "send_email" : true,
    "send_message" : true
  }, {
    "id" : "updateTestCase",
    "name" : "更新用例",
    "type" : 0,
    "send_email" : true,
    "send_message" : true
  }, {
    "id" : "createTestSuite",
    "name" : "新建测试套",
    "type" : 0,
    "send_email" : true,
    "send_message" : true
  }, {
    "id" : "updateTestSuite",
    "name" : "更新测试套",
    "type" : 0,
    "send_email" : true,
    "send_message" : true
  }, {
    "id" : "deleteTestSuite",
    "name" : "删除测试套",
    "type" : 0,
    "send_email" : true,
    "send_message" : true
  }, {
    "id" : "createReport",
    "name" : "新建报表",
    "type" : 0,
    "send_email" : true,
    "send_message" : true
  }, {
    "id" : "updateReport",
    "name" : "更新报表",
    "type" : 0,
    "send_email" : true,
    "send_message" : true
  }, {
    "id" : "deleteReport",
    "name" : "删除报表",
    "type" : 0,
    "send_email" : true,
    "send_message" : true
  }, {
    "id" : "editRisk",
    "name" : "编辑风险信息",
    "type" : 0,
    "send_email" : true,
    "send_message" : true
  }, {
    "id" : "createPlan",
    "name" : "新建计划",
    "type" : 0,
    "send_email" : true,
    "send_message" : true
  }, {
    "id" : "updatePlan",
    "name" : "更改计划",
    "type" : 0,
    "send_email" : true,
    "send_message" : true
  }, {
    "id" : "deletePlan",
    "name" : "删除计划",
    "type" : 0,
    "send_email" : true,
    "send_message" : true
  }, {
    "id" : "deleteBranch",
    "name" : "删除分支",
    "type" : 0,
    "send_email" : true,
    "send_message" : true
  }, {
    "id" : "executeManualCase",
    "name" : "执行手工用例",
    "type" : 0,
    "send_email" : true,
    "send_message" : true
  }, {
    "id" : "finishPlanReport",
    "name" : "测试计划完成后发送质量报告",
    "type" : 0,
    "send_email" : true,
    "send_message" : true
  }, {
    "id" : "commentNotification",
    "name" : "评论通知",
    "type" : 0,
    "send_email" : true,
    "send_message" : true
  }, {
    "id" : "a6bd5272bb834223b8cea7cfdb762885",
    "name" : "接口测试用例执行完成",
    "type" : 1,
    "send_email" : false,
    "send_message" : false
  }, {
    "id" : "2d7264d126a84dba8a362f45fc964b87",
    "name" : "测试套件执行完成",
    "type" : 1,
    "send_email" : false,
    "send_message" : false
  } ]
}