Updating Notifications
Function
This API is used to update notifications.
Calling Method
For details, see Calling APIs.
URI
POST /v3/jobs/notice/{job_id}/update
|
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
|
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 can be obtained by calling the IAM service API. For details, seeObtaining an IAM User Token. Constraints Global tenant tokens are not supported. Use a region-level token whose scope is project. Range N/A. Default Value N/A. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
notice_type |
Yes |
String |
Definition Notification type. The options include system message, email, WeCom, DingTalk, and Feishu. Constraints N/A. Range The value can be MESSAGE (system message), MAIL (email), WECOM (WeCom), DING_TALK (DingTalk), or FEISHU (Feishu). Default Value N/A. |
|
enabled_event_type_names |
Yes |
Array of strings |
Definition Types of enabled notifications. Constraints N/A. Range N/A. Default Value N/A. |
|
param_config |
No |
String |
Definition Notification parameter configuration. Constraints N/A. Range N/A. Default Value N/A. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
result |
String |
Definition Returned 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. |
Example Requests
POST https://{endpoint}/v3/jobs/notice/48c66c6002964721be537cdc6ce0297b/update
{
"notice_type" : "MESSAGE",
"enabled_event_type_names" : [ "buildJobFail", "updateConfigJob", "buildJobSuccess", "deleteJob" ],
"send_switch" : true,
"use_project_notice" : true,
"param_config" : "{\"eventTypeNamesReceivers\":{\"buildJobSuccess\":[\"creator\",\"executor\",\"follower\"],\"buildJobFail\":[\"creator\",\"executor\",\"follower\"]}}"
}
Example Responses
Status code: 200
OK
{
"result" : {
"job_id" : "db8467d972cc47f7a1bd2a3a3e77596a"
},
"error" : null,
"status" : "success"
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
OK |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
