› › ›

更新案例 API

编辑

更新案例 API编辑

更新一个或多个案例。

有关最新 API 详细信息，请参阅开放 API 规范。

请求编辑

PATCH <kibana 主机>:<端口>/api/cases

PATCH <kibana 主机>:<端口>/s/<空间 ID>/api/cases

先决条件编辑

您必须对案例功能在管理、可观察性 或安全部分的 Kibana 功能权限中具有 所有 权限，具体取决于您正在更新的案例的 所有者。

路径参数编辑

<空间 ID>: (可选，字符串) 空间的标识符。如果未指定，则使用默认空间。

请求正文编辑

案例

(必需，对象数组) 包含一个或多个案例对象的数组。

案例 对象的属性

分配者

(可选，对象数组) 包含分配给案例的用户的数组。

分配者对象的属性

UID: (必需，字符串) 用户配置文件的唯一标识符。这些标识符可以通过使用建议用户配置文件 API 找到。

连接器

(可选，对象) 包含连接器配置的对象。

连接器 的属性

字段

(必需，对象) 包含连接器字段的对象。要删除连接器，请指定 null。如果要省略任何单个字段，请将其值指定为 null。

字段 的属性

对于 IBM Resilient 连接器，请指定

问题类型: (必需，字符串数组) 问题的类型。
严重程度代码: (必需，字符串) 问题的严重程度代码。

对于 Jira 连接器，请指定

问题类型: (必需，字符串) 问题的类型。
父级: (必需，字符串) 父级问题的键，当问题类型为 子任务 时。
优先级: (必需，字符串) 问题的优先级。

对于 ServiceNow ITSM 连接器，请指定

类别: (必需，字符串) 事件的类别。
影响: (必需，字符串) 事件对业务的影响。
严重程度: (必需，字符串) 事件的严重程度。
子类别: (必需，字符串) 事件的子类别。
紧急程度: (必需，字符串) 事件解决可以延迟的程度。

对于 ServiceNow SecOps 连接器，请指定

类别: (必需，字符串) 事件的类别。
目标 IP: (必需，字符串) 目标 IP 的逗号分隔列表。
恶意软件哈希: (必需，字符串) 恶意软件哈希的逗号分隔列表。
恶意软件 URL: (必需，字符串) 恶意软件 URL 的逗号分隔列表。
优先级: (必需，字符串) 事件的优先级。
源 IP: (必需，字符串) 源 IP 的逗号分隔列表。
子类别: (必需，字符串) 事件的子类别。

对于 Swimlane 连接器，请指定

案例 ID: (必需，字符串) 案例的标识符。

对于 Webhook - 案例管理连接器，请指定 null。

ID

(必需，字符串) 连接器的标识符。要删除连接器，请使用 none。要检索连接器 ID，请使用查找连接器）。

名称

(必需，字符串) 连接器的名称。要删除连接器，请使用 none。

类型

(必需，字符串) 连接器的类型。有效值为：.cases-webhook、.jira、.none、.resilient、.servicenow、.servicenow-sir 和 .swimlane。要删除连接器，请使用 .none。

描述

(可选，字符串) 更新的案例描述。

ID

(必需，字符串) 案例的标识符。

设置

(可选，对象) 包含案例设置的对象。

设置 的属性

同步警报: (必需，布尔值) 打开或关闭与警报的同步。

严重程度

(可选，字符串) 案例的严重程度。有效值为：critical、high、low 和 medium。

状态

(可选，字符串) 案例状态。有效值为：closed、in-progress 和 open。

标签

(可选，字符串数组) 有助于对案例进行分类的词语和短语。

标题

(可选，字符串) 案例的标题。

版本

(必需，字符串) 案例的当前版本。要确定此值，请使用获取案例或查找案例。

响应代码编辑

200: 表示成功调用。

示例编辑

更新案例 ID a18b38a0-71b0-11ea-a0b2-c51ea50a58e2 的描述、标签和连接器

PATCH api/cases
{
  "cases": [
    {
      "id": "a18b38a0-71b0-11ea-a0b2-c51ea50a58e2",
      "version": "WzIzLDFd",
      "connector": {
        "id": "131d4448-abe0-4789-939d-8ef60680b498",
        "name": "My connector",
        "type": ".jira",
        "fields": {
          "issueType": "10006",
          "priority": null,
          "parent": null
        }
      },
      "description": "A new description.",
      "tags": [ "tag-1", "tag-2" ],
      "assignees": [],
      "settings": {
        "syncAlerts": true
      }
    }
  ]
}

API 返回更新后的案例，并具有新的 version 值。例如

[
  {
    "id": "66b9aa00-94fa-11ea-9f74-e7e108796192",
    "version": "WzU0OCwxXQ==",
    "comments": [],
    "totalComment": 0,
    "totalAlerts": 0,
    "title": "Case title 1",
    "tags": [ "tag-1", "tag-2" ],
    "settings": {
      "syncAlerts": true
    },
    "owner": "cases",
    "description": "A new description.",
    "duration": null,
    "severity": "low",
    "closed_at": null,
    "closed_by": null,
    "created_at": "2022-05-13T09:16:17.416Z",
    "created_by": {
      "email": null,
      "full_name": null,
      "username": "elastic"
    },
    "status": "open",
    "updated_at": "2022-05-13T09:48:33.043Z",
    "updated_by": {
      "email": null,
      "full_name": null,
      "username": "elastic"
    },
    "connector": {
      "id": "131d4448-abe0-4789-939d-8ef60680b498",
      "name": "My connector",
      "type": ".jira",
      "fields": {
        "issueType": "10006",
        "parent": null,
        "priority": null,
      }
    },
    "external_service": {
      "external_title": "IS-4",
      "pushed_by": {
        "full_name": null,
        "email": null,
        "username": "elastic"
      },
      "external_url": "https://hms.atlassian.net/browse/IS-4",
      "pushed_at": "2022-05-13T09:20:40.672Z",
      "connector_id": "05da469f-1fde-4058-99a3-91e4807e2de8",
      "external_id": "10003",
      "connector_name": "Jira"
    }
  }
]

« 设置案例配置 API 更新案例评论 API »