Help Center/ CodeArts Check/ API Reference/ APIs/ Task Management/ Obtaining Information About Notifications
Updated on 2026-08-10 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Obtaining Information About Notifications

Function

This API is usd to query the configurations of system and email notifications of different event types based on the task ID.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

codeartscheck:task:get

Read

task *

-

-

-

-

codeartscheck:ProjectId

URI

GET /v1/task/notification/{task_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

task_id

Yes

String

Definition

Task ID, returned by the API for creating a check task. Each code check task, branch task, or incremental task generated through an API has a unique ID. Obtain the ID by calling the API used to . id indicates the task ID.

Constraints

N/A

Range

1 to 32 characters.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. Obtain one by calling the IAM API Obtaining a User Token. The value of X-Subject-Token in the response header is a token.

Constraints

N/A

Range

The length is the value of [1-100000].

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

httpStatus

String

Definition:

HTTP response status.

Value range:

  • OK: The request has been successfully processed, and the server returns the requested resource or operation result.

  • ACCEPTED: The request has been accepted by the server, but the processing is not complete (usually used for asynchronous operations).

  • INTERNAL_SERVER_ERROR: internal API exception.

  • BAD_REQUEST: abnormal parameter verification.

result

NotificationResult object

Definition

Notification information.

status

String

Definition:

API response status.

Value range:

  • success: successful response.

  • error: response failed.
Table 4 NotificationResult

Parameter

Type

Description

codeGateFailed

TaskEventNotificationParam object

Definition

Gate check failed.

Range

N/A

deleteTask

TaskEventNotificationParam object

Definition

This API is used to delete a task.

Range

N/A

executeTask

TaskEventNotificationParam object

Definition

Task completed.

Range

N/A
Table 5 TaskEventNotificationParam

Parameter

Type

Description

roles

String

Definition:

Recipient role.

Value range:

N/A

sendMail

Boolean

Definition:

Whether to enable email notifications.

Value range:

  • true: enable.

  • false: disable.

sendMessage

Boolean

Definition:

Whether to enable notifications.

Value range:

  • true: enable.

  • false: disable.

sendOfficialAccount

Boolean

Definition:

Whether to enable WeChat official account notifications.

Value range:

  • true: enable.

  • false: disable.

sendRolesEnable

Boolean

Definition:

Whether to send to specified roles.

Value range:

  • true: send.

  • false: do not send.

sendUsersEnable

Boolean

Definition:

Whether to send to specified users.

Value range:

  • true: send.

  • false: do not send.

userIds

String

Definition:

User list. Use commas (,) to separate user IDs.

Range:

N/A

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Value range:

N/A

error_msg

String

Definition:

Error message.

Value range:

N/A

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Value range:

N/A

error_msg

String

Definition:

Error message.

Value range:

N/A

Example Requests

Query the latest notification whose ID is 897acf5exxx48a5013cd.

https://{endpoint}/v1/task/notification/897acf5exxx48a5013cd

Example Responses

Status code: 200

Request succeeded.

{
  "httpStatus" : "OK",
  "result" : {
    "codeGateFailed" : {
      "roles" : "Developer",
      "sendMail" : true,
      "sendMessage" : true,
      "sendOfficialAccount" : false,
      "sendRolesEnable" : true,
      "sendUsersEnable" : true,
      "userIds" : "e8d32c5f742448228fd2ec78bdee72e4"
    },
    "deleteTask" : {
      "roles" : "Developer",
      "sendMail" : true,
      "sendMessage" : true,
      "sendOfficialAccount" : false,
      "sendRolesEnable" : true,
      "sendUsersEnable" : true,
      "userIds" : "e8d32c5f742448228fd2ec78bdee72e4"
    },
    "executeTask" : {
      "roles" : "Developer",
      "sendMail" : true,
      "sendMessage" : true,
      "sendOfficialAccount" : false,
      "sendRolesEnable" : true,
      "sendUsersEnable" : true,
      "userIds" : "e8d32c5f742448228fd2ec78bdee72e4"
    }
  },
  "status" : "success"
}

Status code: 400

A request error occurred.

{
  "error_code" : "CC.xxxxxxxx.400",
  "error_msg" : "Verify request parameter failed. Check whether the request parameters are correct."
}

Status code: 401

The permission is insufficient.

{
  "error_code" : "CC.00000003",
  "error_msg" : "Authentication information expired."
}

Status Codes

Status Code

Description

200

Request succeeded.

400

A request error occurred.

401

The permission is insufficient.

Error Codes

See Error Codes.

Parent Topic: Task Management