流水线官方消息通知更新 - UpdatePipelineOfficialNotice

功能介绍

流水线官方消息通知更新

调用方法

URI

POST /v5/{project_id}/api/pipeline-notices/{pipeline_id}/notice

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：项目ID，获取方式请参见获取项目ID。约束限制：不涉及。取值范围： 32位字符，由数字和字母组成。默认取值：不涉及。
pipeline_id	是	String	参数解释：流水线ID，可以通过查询流水线列表接口获取，其中pipelines.pipelineId即为流水线ID。约束限制：不涉及。取值范围： 32位字符，由数字和字母组成。默认取值：不涉及。

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
event_type	是	String	事件类型
notice_data	是	notice_data object	详情

表3 notice_data
参数	是否必选	参数类型	描述
notice_types	是	Array of strings	流水线消息通知类型。
notice_roles	是	Array of strings	通知规则

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
status	String	参数解释：响应状态。取值范围：不涉及。

请求示例

POST https://(endpoint)/v5/e2e18230a85d4d6ab0b56cb6d2246c18/api/pipeline-notices/0747d5a7099e45f69dc1d099945909a9/notice

{
  "event_type" : "pipeline.deleted",
  "notice_data" : {
    "notice_types" : [ "MESSAGE", "EMAIL" ],
    "notice_roles" : [ "CREATOR", "EXECUTOR", "COLLECTOR" ]
  }
}