Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Enabling or Disabling CodeArts Pipeline Notifications
Updated on 2025-03-25 GMT+08:00

Enabling or Disabling CodeArts Pipeline Notifications

Function

This API is used to enable or disable CodeArts Pipeline notifications.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Parameter description:

CodeArts project ID.

Constraints:

N/A.

Value Range:

The value contains 32 characters.

Default value:

N/A.

pipeline_id

Yes

String

Parameter description:

Pipeline ID.

Constraints:

N/A.

Value Range:

The value contains 32 characters.

Default value:

N/A.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

notice_type

Yes

String

Notification type.

notice_switch

Yes

Boolean

Switch status.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

status

String

Status.

Example Requests

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

{
  "notice_type" : "officialNotice",
  "notice_switch" : false
}

Example Responses

Status code: 200

Response body.

{
  "status" : "success"
}

Status Codes

Status Code

Description

200

Response body.

Error Codes

See Error Codes.