Querying Notifications

Function

This API is used to query notification settings.

Calling Method

For details, see Calling APIs.

URI

GET /v3/jobs/notice/{job_id}/query

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
job_id	Yes	String	Definition Enter the ID of the build task whose history you want to query. To obtain this ID, open the build task details page in your browser, and copy the 32-character string, which includes both digits and letters, at the end of the URL. Constraints N/A. Range The value is 32 characters long. Only letters and digits are allowed. Default Value N/A.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. (The value of the X-Subject-Token response header is the user token.) It is obtained by calling the IAM API. Constraints Global tenant tokens are not supported. Use a region-level token whose scope is project. Range N/A. Default Value N/A.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
result	Array of QueryJobNoticeItems objects	Definition Template query result. Range N/A.
error	String	Definition Returned error message. Range N/A.
status	String	Definition Returned status information. Range ● success: The API call is successful. ● fail: The API call failed.

**Table 4** QueryJobNoticeItems
Parameter	Type	Description
notice_type	String	Definition Notification type. The options include system message, email, DingTalk, Feishu, and WeCom. Range System message, email, DingTalk, Feishu, and WeCom.
enable_map	Map<String,Boolean>	Definition Details about enabled notification types. Range N/A.
param_config	String	Definition Parameter configuration. Range N/A.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 403

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 404

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

GET https://{endpoint}/v3/jobs/notice/48c66c6002964721be537cdc6ce0297b/query

Example Responses

Status code: 200

{
  "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" : false,
      "buildJobSuccess" : false,
      "deleteJob" : false,
      "forbiddenJob" : false
    },
    "param_config" : null
  }, {
    "notice_type" : "MESSAGE",
    "enable_map" : {
      "buildJobFail" : false,
      "updateConfigJob" : false,
      "buildJobSuccess" : false,
      "deleteJob" : false,
      "forbiddenJob" : false
    },
    "param_config" : null
  } ],
  "error" : null,
  "status" : "success"
}