Help Center/ SecMaster/ API Reference/ SecMaster APIs (V1)/ Comment/ Creating a Comment
Updated on 2025-12-18 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Creating a Comment

Function

This API is used to create comments.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/notes

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID

Constraints

N/A

Range

N/A

Default Value

N/A

workspace_id

Yes

String

Definition

Workspace ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token

Constraints

N/A

Range

N/A

Default Value

N/A

content-type

Yes

String

Definition

Content type.

  • application/json;charset=UTF-8: common API request type

Constraints

N/A

Range

  • application/json;charset=UTF-8

Default Value

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

war_room_id

No

String

ID of the commented object.

type

Yes

String

Comment type.

content

Yes

String

Comment content.

note_type

No

String

Comment action type.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code.

Range

N/A

message

String

Definition

Error description.

Range

N/A

success

Boolean

Whether the request is successful.

data

NotesDetail object

Comment details object.
Table 5 NotesDetail

Parameter

Type

Description

create_time

String

Creation time.

update_time

String

Update time.

data

data object

Comment content body.

id

String

Unique UUID of a comment.

is_deleted

Boolean

Whether it is deleted.

marked_note

Boolean

Whether it is a comment.

note_type

String

Comment action type.

project_id

String

Project ID.

type

String

Comment type.

user

user object

User information.

war_room_id

String

ID of the commented object.

workspace_id

String

Workspace.

content

Object

Comment details.
Table 6 data

Parameter

Type

Description

content

String

Comment content.
Table 7 user

Parameter

Type

Description

id

String

User ID.

name

String

Username.

Status code: 400

Table 8 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code.

Range

N/A

message

String

Definition

Error description.

Range

N/A

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Response for creating a comment.

400

Returned packet for abnormal requests.

Error Codes

See Error Codes.

Parent topic: Comment