文档首页/ 编译构建 CodeArts Build/ API参考/ 任务相关API接口/ 获取通知信息
更新时间：2024-11-08 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取通知信息

功能介绍

获取通知信息

调用方法

请参见如何调用API。

URI

GET /v1/job/{job_id}/notice

表1 路径参数

参数

是否必选

参数类型

描述

job_id

是

String

构建的任务ID；

编辑构建任务时，浏览器URL末尾的32位数字、字母组合的字符串。

请求参数

无

响应参数

状态码： 200

表2 响应Body参数

参数

参数类型

描述

result

Array of QueryJobNoticeItems objects

查询模板结果

error

String

返回错误信息

status

String

返回状态信息
表3 QueryJobNoticeItems

参数

参数类型

描述

notice_type

String

通知类型

enable_map

Map<String,Boolean>

通知品种开启详情的表

param_config

String

参数配置

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 401

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 403

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 404

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

GET https://{endpoint}/v1/job/901878212b1a49be9c1a1054c272762a/notice

响应示例

状态码： 200

OK

{
  "result" : [ {
    "notice_type" : "DING_TALK",
    "enable_map" : {
      "buildJobFail" : false,
      "updateConfigJob" : false,
      "buildJobSuccess" : false,
      "deleteJob" : false,
      "forbiddenJob" : false
    },
    "param_config" : null
  }, {
    "notice_type" : "MAIL",
    "enable_map" : {
      "buildJobFail" : true,
      "updateConfigJob" : true,
      "buildJobSuccess" : true,
      "deleteJob" : true,
      "forbiddenJob" : true
    },
    "param_config" : null
  }, {
    "notice_type" : "MESSAGE",
    "enable_map" : {
      "buildJobFail" : true,
      "updateConfigJob" : true,
      "buildJobSuccess" : true,
      "deleteJob" : true,
      "forbiddenJob" : true
    },
    "param_config" : null
  }, {
    "notice_type" : "WECOM",
    "enable_map" : {
      "buildJobFail" : false,
      "updateConfigJob" : false,
      "buildJobSuccess" : false,
      "deleteJob" : false,
      "forbiddenJob" : false
    },
    "param_config" : null
  } ],
  "error" : null,
  "status" : "success"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 任务相关API接口

相关文档