IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Update case comment API Import and export dashboard APIs »

› › ›

Update case configuration API

edit

Update case configuration API

edit

Updates external connection details, such as the closure type and default connector for cases.

Request

edit

PATCH <kibana host>:<port>/api/cases/configure/<configuration_id>

PATCH <kibana host>:<port>/s/<space_id>/api/cases/configure/<configuration_id>

Prerequisites

edit

You must have all privileges for the Cases feature in the Management, Observability, or Security section of the Kibana feature privileges, depending on the owner of the case configuration.

Description

edit

Connectors are used to interface with external systems. You must create a connector before you can it in your cases. Refer to Add connectors.

Path parameters

edit

<configuration_id>: The identifier for the configuration. To retrieve the configuration IDs, use Get configuration.
<space_id>: (Optional, string) An identifier for the space. If it is not specified, the default space is used.

Request body

edit

closure_type

(Optional, string) Determines whether a case is automatically closed when it is pushed to external systems. Valid values are:

close-by-pushing: Cases are automatically closed when they are pushed.
close-by-user: Cases are not automatically closed.

connector

(Optional, object) An object that contains the connector configuration.

Properties of connector

fields: (Required, object) An object that contains the connector fields.

The fields specified in the case configuration are not used and are not propagated to individual cases, therefore it is recommended to set it to null.
id: (Required, string) The identifier for the connector. To retrieve connector IDs, use Find connectors.
name: (Required, string) The name of the connector.
type: (Required, string) The type of the connector. Valid values are: .servicenow, .servicenow-sir, .jira, .resilient, .swimlane, and .none.

version

(Required, string) The version of the connector. To retrieve the version value, use Get configuration.

Response code

edit

200: Indicates a successful call.

Example

edit

Change the closure type configuration option:

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

The API returns the following:

{
  "closure_type": "close-by-user",
  "owner": "cases",
  "created_at": "2022-04-06T20:57:40.746Z",
  "created_by": {
    "email": "admin@hms.gov.uk",
    "full_name": "Ms Admin",
    "username": "admin"
  },
  "updated_at": "2022-04-12T22:41:09.262Z",
  "updated_by": {
    "email": "admin@hms.gov.uk",
    "full_name": "Ms Admin",
    "username": "admin"
  },
  "connector": {
    "id": "none",
    "name": "none",
    "type": ".none",
    "fields": null
    },
  "mappings": [],
  "version": "WzkwNiw1XQ==",
  "error": null,
  "id": "3297a0f0-b5ec-11ec-b141-0fdb20a7f9a9"
}

« Update case comment API Import and export dashboard APIs »