IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Update caseedit
Updates existing cases.
Request URLedit
PATCH <kibana host>:<port>/api/cases
Request bodyedit
A JSON array containing one or more case objects with updated field values:
Name | Type | Description | Required |
---|---|---|---|
|
Array containing one or more case objects. |
Yes |
cases
schemaedit
Name | Type | Description | Required |
---|---|---|---|
|
String |
The ID of the case being updated. |
Yes |
|
String |
The updated case title. |
No |
|
String |
The updated case description. |
No |
|
String |
The updated case status, which can be:
|
No |
|
String[] |
The updated case tags. |
No |
|
String |
The current case version (returned when calling Get case or Find cases). |
Yes |
Example requestedit
Updates the description
and tags
fields of case ID
a18b38a0-71b0-11ea-a0b2-c51ea50a58e2
:
PATCH api/cases { "cases": [ { "id": "a18b38a0-71b0-11ea-a0b2-c51ea50a58e2", "description": "James Bond clicked on a highly suspicious email banner advertising cheap holidays for underpaid civil servants. Operation bubblegum is active. Repeat - operation bubblegum is now active!", "tags": [ "phishing", "social engineering", "bubblegum" ], "version": "WzIzLDFd" } ] }
Response codeedit
-
200
- Indicates a successful call.
Response payloadedit
The updated case with a new version
value.
Example responseedit
[ { "id": "a18b38a0-71b0-11ea-a0b2-c51ea50a58e2", "version": "Wzk4LDFd", "comments": [], "totalComment": 0, "closed_at": null, "closed_by": null, "created_at": "2020-03-29T11:30:02.658Z", "created_by": { "email": "ahunley@imf.usa.gov", "full_name": "Alan Hunley", "username": "ahunley" }, "external_service": null, "updated_at": "2020-03-29T12:01:50.244Z", "updated_by": { "email": "classified@hms.oo.gov.uk", "full_name": "Classified", "username": "M" }, "description": "James Bond clicked on a highly suspicious email banner advertising cheap holidays for underpaid civil servants. Operation bubblegum is active. Repeat - operation bubblegum is now active!", "title": "This case will self-destruct in 5 seconds", "status": "open", "tags": [ "phishing", "social engineering", "bubblegum" ] } ]