Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Querying Third-Party Pipeline Notifications
Updated on 2025-03-25 GMT+08:00

Querying Third-Party Pipeline Notifications

Function

This API is used to query third-party pipeline notifications.

Calling Method

For details, see Calling APIs.

URI

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

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

notice_id

String

Message ID.

pipeline_id

String

Pipeline ID.

notice_type

String

Message type.

notice_status

Boolean

Message status.

send_url

String

URL sent.

notice_events

Array of strings

Event type.

notice_contents

Array of strings

Message content.

notice_users

Array of strings

Recipients.

secret_info

String

Key information.

sort_index

Integer

Sorting.

Example Requests

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

Example Responses

Status code: 200

Response body.

[ {
  "notice_id" : "dd58644df44d426d862eea6f8a456b43",
  "pipeline_id" : "0747d5a7099e45f69dc1d099945909a9",
  "notice_type" : "feishu",
  "notice_status" : false,
  "send_url" : "https://123",
  "notice_events" : [ "pipelineRun.pause" ],
  "notice_contents" : [ "projectName" ],
  "notice_users" : [ "12" ],
  "secret_info" : "12",
  "sort_index" : 0
} ]

Status Codes

Status Code

Description

200

Response body.

Error Codes

See Error Codes.