Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Querying CodeArts Pipeline Notifications

Updated on 2025-03-25 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying CodeArts Pipeline Notifications

Function

This API is used to query CodeArts Pipeline notifications.

Calling Method

For details, see Calling APIs.

URI

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

**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

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
[items]	Array of QueryPipelineNoticeResp objects	Response body.

**Table 3** QueryPipelineNoticeResp
Parameter	Type	Description
event_type	String	Event type.
notice_data	notice_data object	Details.

**Table 4** notice_data
Parameter	Type	Description
notice_types	Array of strings	Notification type.
notice_roles	Array of strings	Notification rules.
notice_users	String	Notified users.

Example Requests

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

Example Responses

Status code: 200

Response body.

[ {
  "event_type" : "pipeline.updated",
  "notice_data" : {
    "notice_types" : [ "MESSAGE" ],
    "notice_roles" : [ "CREATOR", "EXECUTOR", "COLLECTOR" ],
    "notice_users" : null
  }
}, {
  "event_type" : "pipeline.deleted",
  "notice_data" : {
    "notice_types" : [ "MESSAGE" ],
    "notice_roles" : [ "CREATOR", "EXECUTOR", "COLLECTOR" ],
    "notice_users" : null
  }
}, {
  "event_type" : "pipelineRun.succeed",
  "notice_data" : {
    "notice_types" : [ "MESSAGE" ],
    "notice_roles" : [ "CREATOR", "EXECUTOR", "COLLECTOR" ],
    "notice_users" : null
  }
}, {
  "event_type" : "pipelineRun.failed",
  "notice_data" : {
    "notice_types" : [ "MESSAGE" ],
    "notice_roles" : [ "CREATOR", "EXECUTOR", "COLLECTOR" ],
    "notice_users" : null
  }
} ]