查询租户或项目消息通知配置

domain_id

否

String

参数解释：

租户ID，值来源于iam的租户id。

约束限制：

不涉及。

取值范围：

字符集为大小写字母和数字，字符串长度不少于1，不超过128。

默认取值：

不涉及。

project_id

否

String

参数解释：

项目的32位uuid，项目唯一标识，通过查询项目列表接口查询项目列表获取。

约束限制：

不涉及。

取值范围：

字符集为大小写字母和数字，字符串长度不少于1，不超过128。

默认取值：

不涉及。

is_check_project

是

Integer

参数解释：

是否查询项目的配置，为1时代表查询项目的消息通知配置，为0代表查询租户的消息通知配置。

约束限制：

不涉及。

取值范围：

0、1。

默认取值：

不涉及。

X-Auth-Token

是

String

参数解释：

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制：

不涉及。

取值范围：

字符串长度不少于1，不超过10万。

默认取值：

不涉及。

result

result object

消息通知配置。

httpStatus

String

参数解释：

HTTP响应状态，接口响应成功时为"OK"，接口响应失败时为其他HTTP状态码。如INTERNAL_SERVER_ERROR为接口内部异常，BAD_REQUEST是参数校验异常。

取值范围：

• OK，接口响应成功。

• ACCEPTED，接口响应成功。

• INTERNAL_SERVER_ERROR，接口内部异常。

• BAD_REQUEST，参数校验异常。

status

String

参数解释：

接口响应状态。

取值范围：

• success，接口响应成功。

• error，接口响应失败。

codeGateFailed

NotificationRule object

门禁失败时的消息通知配置。

deleteTask

NotificationRule object

删除任务时的消息通知配置。

executeTask

NotificationRule object

执行任务完成时的消息通知配置。

eventType

String

参数解释：

事件类型，标识具体的事件，有三种。codeGateFailed为检查任务门禁失败时发送通知，taskDeleted为任务被删除时发送通知，taskExecuteCompleted为任务执行完成时发送通知。

取值范围：

codeGateFailed、taskDeleted、taskExecuteCompleted。

sendMail

Integer

参数解释：

是否发送邮件通知，1是需要发送邮件通知，0是不需要发送邮件通知。

取值范围：

1、0。

sendMessage

Integer

参数解释：

是否发送消息通知，1是需要发送消息通知，0是不需要发送消息通知。

取值范围：

1、0。

roles

String

参数解释：

接收消息通知的角色列表，标识哪些角色需要接收消息通知。

取值范围：

Developer、Committer、Operation manager、Product manager、Participant、Project manager、project_admin、System engineer、Test manager、Viewer、Tester，以及自定义的角色。

sendRolesEnable

Integer

参数解释：

是否发送消息通知给对应角色，1是发送消息通知给对应角色，0是不发送消息通知给对应角色。

取值范围：

1、0。

userIds

String

参数解释：

接收通知的用户ID列表，多个用户IID用逗号分隔。

取值范围：

字符串长度不超过500。

sendUsersEnable

Integer

参数解释：

是否发送消息通知给对应用户，1是发送消息通知给对应用户，0是不发送消息通知给对应用户。

取值范围：

1、0。

error_code

String

错误码

error_msg

String

错误描述

error_code

String

错误码

error_msg

String

错误描述

200

租户或项目消息通知配置

400

Bad Request

401

Unauthorized