更新事件备注
此方法用于为安全事件添加备注。
重要提示
此方法已更新至1.1版本。如需查看1.0版本信息,请参阅 本节内容 .
参数
|
参数 |
类型 |
可选 |
说明 |
|---|---|---|---|
|
|
字符串 |
否 |
目标事件的类型。可能取值:
|
|
|
字符串 |
否 |
从事件推送详情中获取的事件ID。该值对应
提示您可以通过以下步骤从 GravityZone 控制台获取特定事件的ID:
|
|
|
字符串 |
否 |
要包含在备注中的文本内容。 注意若事件已有备注,原备注将被覆盖。 |
返回值
此方法返回布尔值
真
若备注分配成功。
示例
请求 :
{
"params": {
"incidentId" : "621342db44747b408b7edf65",
"type" : "extendedIncidents" 或 "incidents",
"note" : "随机备注"
},
"jsonrpc": "2.0",
"method": "updateIncidentNote",
"id": "0df7568c-59c1-48e0-a31b-18d83e6d9810"
}
响应 :
{
"id": "0df7568c-59c1-48e0-a31b-18d83e6d9810",
"jsonrpc": "2.0",
"result": true
}
版本 1.0
参数
|
参数 |
类型 |
可选 |
描述 |
|---|---|---|---|
|
|
字符串 |
否 |
目标事件类型。可能取值:
|
|
|
字符串 |
否 |
事件ID,从事件推送详情中获取。该值对应
|
|
|
字符串 |
否 |
要包含在备注中的文本。 备注如果该事件已分配有备注,则会被覆盖。 |
返回值
此方法返回一个布尔值,若备注分配成功则为
True
,并返回以下对象:
-
data,包含与事件相关信息的一个对象。-
lastUpdated- 备注被修改时的时间戳。
-
示例
请求 :
{
"params": {
"incidentId" : "621342db44747b408b7edf65",
"type" : "extendedIncidents" 或 "incidents",
"note" : "随机备注"
},
"jsonrpc": "2.0",
"method": "updateIncidentNote",
"id": "0df7568c-59c1-48e0-a31b-18d83e6d9810"
}
响应 :
{
"id": "0df7568c-59c1-48e0-a31b-18d83e6d9810",
"jsonrpc": "2.0",
"result": {
"success": true
}
}