获取事件通知配置
功能介绍
获取事件通知配置
调用方法
请参见如何调用API。
URI
GET /v4/projects/{project_id}/message-notices
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID |
请求参数
无
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
status |
String |
success|error |
|
result |
获取事件通知配置返回参数 |
|
|
error |
ApiError object |
错误信息 |
|
request_id |
String |
由接口调用方传入，建议使用UUID保证请求的唯一性。 |
|
server_address |
String |
本次请求的受理的服务地址 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 |
|
value |
Array of ProjectEventNotificationConfigInfo objects |
实际的数据类型：单个对象，集合 或 NULL |
|
reason |
String |
业务失败的提示内容 |
|
page_size |
Integer |
分页大小 |
|
page_no |
Integer |
分页编码 |
|
has_more |
Boolean |
是否有更多 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
通知id |
|
name |
String |
通知配置名称 |
|
type |
Integer |
消息类型 |
|
send_email |
Boolean |
是否发送邮件 |
|
send_message |
Boolean |
是否发送动态 |
|
project_id |
String |
项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID |
|
notice_users |
Array of NameAndIdVo objects |
通知用户 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
接口调用失败错误码 |
|
error_msg |
String |
接口调用失败错误信息 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
接口调用失败错误码 |
|
error_msg |
String |
接口调用失败错误信息 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
接口调用失败错误码 |
|
error_msg |
String |
接口调用失败错误信息 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
接口调用失败错误码 |
|
error_msg |
String |
接口调用失败错误信息 |
请求示例
post https://{endpoint}/v4/projects/f3087a82b44744c29a1bd69ab6ada154/message-notices
响应示例
状态码：200
OK
{
"status" : "success",
"result" : {
"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
} ]
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。
