更新时间:2025-11-21 GMT+08:00
分享

创建评论 - CreateNotes

功能介绍

创建评论

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

workspace_id

String

参数解释:

工作空间id。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

content-type

String

参数解释:

内容类型

  • application/json;charset=UTF-8 普通API请求的类型

约束限制:

不涉及

取值范围:

  • application/json;charset=UTF-8

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

war_room_id

String

评论的对象ID

type

String

评论的类型

content

String

评论的内容

note_type

String

评论的动作类型

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

success

Boolean

是否请求成功

data

Array of NotesDetail objects

评论详情

表5 NotesDetail

参数

参数类型

描述

create_time

String

创建时间

update_time

String

更新时间

data

data object

评论内容体

id

String

评论唯一UUID

is_deleted

Boolean

是否已删除

marked_note

Boolean

标识是否是评论

note_type

String

评论的动作类型

project_id

String

项目ID

type

String

评论的类型

user

user object

用户信息

war_room_id

String

评论的对象ID

workspace_id

String

空间

content

Object

评论详情信息

表6 data

参数

参数类型

描述

content

String

评论的内容

表7 user

参数

参数类型

描述

id

String

用户id

name

String

用户名称

状态码:400

表8 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

请求示例

响应示例

状态码

状态码

描述

200

创建评论响应

400

请求异常返回报文

错误码

请参见错误码

相关文档