Help Center/ SecMaster/ API Reference/ SecMaster APIs (V1)/ Comment/ Querying the Comment List

Updated on 2025-12-18 GMT+08:00

CLI Examples

View PDF

Querying the Comment List

This API is used to query the comment list.

For details, see Calling APIs.

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

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

**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
limit	No	Integer	The maximum number of records can be returned on each page for a pagination query. The value starts from 1.
offset	No	Integer	Pagination query parameter. This parameter specifies the start position of the query result. The value starts from 0.
sort_by	No	String	Sorting field.
order	No	String	Sorting order, which can be ascending or descending.
from_date	No	String	Search start time.
to_date	No	String	Search end time.
war_room_id	No	String	ID of the commented object.

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
total	Integer	Total records.
size	Integer	Records on each page.
page	Integer	Current page number.
success	Boolean	Whether the request is successful.
data	Array of NotesDetail objects	Comment list details.