更新案例配置 API编辑

更新外部连接详细信息,例如案例的关闭类型和默认连接器。

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

请求编辑

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

PATCH <kibana 主机>:<端口>/s/<space_id>/api/cases/configure/<configuration_id>

先决条件编辑

您必须在Kibana 功能权限管理可观测性安全部分中,对案例功能拥有所有权限,具体取决于案例配置的所有者

描述编辑

连接器用于与外部系统交互。您必须先创建一个连接器,然后才能在案例中使用它。请参阅添加连接器

路径参数编辑

<configuration_id>
配置的标识符。要检索配置 ID,请使用获取配置
<space_id>
(可选,字符串)空间的标识符。如果未指定,则使用默认空间。

请求正文编辑

closure_type

(可选,字符串)确定在将案例推送到外部系统时是否自动关闭案例。有效值为

  • close-by-pushing:案例在推送时自动关闭。
  • close-by-user:案例不会自动关闭。
connector

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

connector 的属性
fields

(必需,对象)包含连接器字段的对象。

案例配置中指定的字段未使用,也不会传播到各个案例,因此建议将其设置为null

id
(必需,字符串)连接器的标识符。要检索连接器 ID,请使用查找连接器
name
(必需,字符串)连接器的名称。
type
(必需,字符串)连接器的类型。有效值为:.cases-webhook.jira.none.resilient.servicenow.servicenow-sir.swimlane
version
(必需,字符串)连接器的版本。要检索版本值,请使用获取配置

响应代码编辑

200
指示调用成功。

示例编辑

更改关闭类型配置选项

PATCH api/cases/configure/3297a0f0-b5ec-11ec-b141-0fdb20a7f9a9
{
  "closure_type": "close-by-pushing",
  "version": "WzIwMiwxXQ=="
}

API 返回以下内容

{
  "closure_type": "close-by-pushing",
  "owner": "cases",
  "created_at": "2022-06-01T17:07:17.767Z",
  "created_by": {
    "email": "null",
    "full_name": "null",
    "username": "elastic"
  },
  "updated_at": "2022-06-01T19:58:48.169Z",
  "updated_by": {
    "email": "null",
    "full_name": "null",
    "username": "elastic"
  },
  "connector": {
    "id": "none",
    "name": "none",
    "type": ".none",
    "fields": null
    },
  "mappings": [],
  "version": "WzkwNiw1XQ==",
  "error": null,
  "id": "3297a0f0-b5ec-11ec-b141-0fdb20a7f9a9"
}