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

codeartscheck::getProjectConfig

Read

-

codeartscheck:ProjectId

-

-

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~100000]个字符。

默认取值：

不涉及。

result

result object

消息通知配置。

httpStatus

String

参数解释：

HTTP响应状态。

取值范围：

• 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：任务执行完成时发送通知。

sendMail

Integer

参数解释：

是否发送邮件通知。

取值范围：

• 1：需要发送邮件通知。

• 0：不需发送邮件通知。

sendMessage

Integer

参数解释：

是否发送消息通知。

取值范围：

• 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：不需发送消息通知给对应角色。

userIds

String

参数解释：

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

取值范围：

字符串长度不超过500。

sendUsersEnable

Integer

参数解释：

是否发送消息通知给对应用户。

取值范围：

• 1：需要发送消息通知给对应用户。

• 0：不需发送消息通知给对应用户。

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及。

200

租户或项目消息通知配置

400

Bad Request

401

Unauthorized