[Cases] Route: Get all alerts attach to a case (#101878)

Co-authored-by: Jonathan Buttner <jonathan.buttner@elastic.co>

x-pack/plugins/cases/common/api/cases/alerts.ts

@@ -0,0 +1,18 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import * as rt from 'io-ts';
+
+const AlertRt = rt.type({
+  id: rt.string,
+  index: rt.string,
+  attached_at: rt.string,
+});
+
+export const AlertResponseRt = rt.array(AlertRt);
+
+export type AlertResponse = rt.TypeOf<typeof AlertResponseRt>;

x-pack/plugins/cases/common/api/cases/index.ts

@@ -12,3 +12,4 @@ export * from './status';
 export * from './user_actions';
 export * from './sub_case';
 export * from './constants';
+export * from './alerts';

x-pack/plugins/cases/common/constants.ts

@@ -51,6 +51,7 @@ export const CASE_TAGS_URL = `${CASES_URL}/tags`;
 export const CASE_USER_ACTIONS_URL = `${CASE_DETAILS_URL}/user_actions`;
 
 export const CASE_ALERTS_URL = `${CASES_URL}/alerts/{alert_id}`;
+export const CASE_DETAILS_ALERTS_URL = `${CASE_DETAILS_URL}/alerts`;
 
 /**
  * Action routes

x-pack/plugins/cases/docs/cases_client/classes/client.casesclient.md

@@ -45,63 +45,63 @@ Client wrapper that contains accessor methods for individual entities within the
 
 **Returns:** [*CasesClient*](client.casesclient.md)
 
-Defined in: [client.ts:28](https://github.com/jonathan-buttner/kibana/blob/2085a3b4480/x-pack/plugins/cases/server/client/client.ts#L28)
+Defined in: [client.ts:28](https://github.com/jonathan-buttner/kibana/blob/0e98e105663/x-pack/plugins/cases/server/client/client.ts#L28)
 
 ## Properties
 
 ### \_attachments
 
 • `Private` `Readonly` **\_attachments**: [*AttachmentsSubClient*](../interfaces/attachments_client.attachmentssubclient.md)
 
-Defined in: [client.ts:24](https://github.com/jonathan-buttner/kibana/blob/2085a3b4480/x-pack/plugins/cases/server/client/client.ts#L24)
+Defined in: [client.ts:24](https://github.com/jonathan-buttner/kibana/blob/0e98e105663/x-pack/plugins/cases/server/client/client.ts#L24)
 
 ___
 
 ### \_cases
 
 • `Private` `Readonly` **\_cases**: [*CasesSubClient*](../interfaces/cases_client.casessubclient.md)
 
-Defined in: [client.ts:23](https://github.com/jonathan-buttner/kibana/blob/2085a3b4480/x-pack/plugins/cases/server/client/client.ts#L23)
+Defined in: [client.ts:23](https://github.com/jonathan-buttner/kibana/blob/0e98e105663/x-pack/plugins/cases/server/client/client.ts#L23)
 
 ___
 
 ### \_casesClientInternal
 
 • `Private` `Readonly` **\_casesClientInternal**: *CasesClientInternal*
 
-Defined in: [client.ts:22](https://github.com/jonathan-buttner/kibana/blob/2085a3b4480/x-pack/plugins/cases/server/client/client.ts#L22)
+Defined in: [client.ts:22](https://github.com/jonathan-buttner/kibana/blob/0e98e105663/x-pack/plugins/cases/server/client/client.ts#L22)
 
 ___
 
 ### \_configure
 
 • `Private` `Readonly` **\_configure**: [*ConfigureSubClient*](../interfaces/configure_client.configuresubclient.md)
 
-Defined in: [client.ts:27](https://github.com/jonathan-buttner/kibana/blob/2085a3b4480/x-pack/plugins/cases/server/client/client.ts#L27)
+Defined in: [client.ts:27](https://github.com/jonathan-buttner/kibana/blob/0e98e105663/x-pack/plugins/cases/server/client/client.ts#L27)
 
 ___
 
 ### \_stats
 
 • `Private` `Readonly` **\_stats**: [*StatsSubClient*](../interfaces/stats_client.statssubclient.md)
 
-Defined in: [client.ts:28](https://github.com/jonathan-buttner/kibana/blob/2085a3b4480/x-pack/plugins/cases/server/client/client.ts#L28)
+Defined in: [client.ts:28](https://github.com/jonathan-buttner/kibana/blob/0e98e105663/x-pack/plugins/cases/server/client/client.ts#L28)
 
 ___
 
 ### \_subCases
 
 • `Private` `Readonly` **\_subCases**: [*SubCasesClient*](../interfaces/sub_cases_client.subcasesclient.md)
 
-Defined in: [client.ts:26](https://github.com/jonathan-buttner/kibana/blob/2085a3b4480/x-pack/plugins/cases/server/client/client.ts#L26)
+Defined in: [client.ts:26](https://github.com/jonathan-buttner/kibana/blob/0e98e105663/x-pack/plugins/cases/server/client/client.ts#L26)
 
 ___
 
 ### \_userActions
 
 • `Private` `Readonly` **\_userActions**: [*UserActionsSubClient*](../interfaces/user_actions_client.useractionssubclient.md)
 
-Defined in: [client.ts:25](https://github.com/jonathan-buttner/kibana/blob/2085a3b4480/x-pack/plugins/cases/server/client/client.ts#L25)
+Defined in: [client.ts:25](https://github.com/jonathan-buttner/kibana/blob/0e98e105663/x-pack/plugins/cases/server/client/client.ts#L25)
 
 ## Accessors
 
@@ -113,7 +113,7 @@ Retrieves an interface for interacting with attachments (comments) entities.
 
 **Returns:** [*AttachmentsSubClient*](../interfaces/attachments_client.attachmentssubclient.md)
 
-Defined in: [client.ts:50](https://github.com/jonathan-buttner/kibana/blob/2085a3b4480/x-pack/plugins/cases/server/client/client.ts#L50)
+Defined in: [client.ts:50](https://github.com/jonathan-buttner/kibana/blob/0e98e105663/x-pack/plugins/cases/server/client/client.ts#L50)
 
 ___
 
@@ -125,7 +125,7 @@ Retrieves an interface for interacting with cases entities.
 
 **Returns:** [*CasesSubClient*](../interfaces/cases_client.casessubclient.md)
 
-Defined in: [client.ts:43](https://github.com/jonathan-buttner/kibana/blob/2085a3b4480/x-pack/plugins/cases/server/client/client.ts#L43)
+Defined in: [client.ts:43](https://github.com/jonathan-buttner/kibana/blob/0e98e105663/x-pack/plugins/cases/server/client/client.ts#L43)
 
 ___
 
@@ -137,7 +137,7 @@ Retrieves an interface for interacting with the configuration of external connec
 
 **Returns:** [*ConfigureSubClient*](../interfaces/configure_client.configuresubclient.md)
 
-Defined in: [client.ts:76](https://github.com/jonathan-buttner/kibana/blob/2085a3b4480/x-pack/plugins/cases/server/client/client.ts#L76)
+Defined in: [client.ts:76](https://github.com/jonathan-buttner/kibana/blob/0e98e105663/x-pack/plugins/cases/server/client/client.ts#L76)
 
 ___
 
@@ -149,7 +149,7 @@ Retrieves an interface for retrieving statistics related to the cases entities.
 
 **Returns:** [*StatsSubClient*](../interfaces/stats_client.statssubclient.md)
 
-Defined in: [client.ts:83](https://github.com/jonathan-buttner/kibana/blob/2085a3b4480/x-pack/plugins/cases/server/client/client.ts#L83)
+Defined in: [client.ts:83](https://github.com/jonathan-buttner/kibana/blob/0e98e105663/x-pack/plugins/cases/server/client/client.ts#L83)
 
 ___
 
@@ -163,7 +163,7 @@ Currently this functionality is disabled and will throw an error if this functio
 
 **Returns:** [*SubCasesClient*](../interfaces/sub_cases_client.subcasesclient.md)
 
-Defined in: [client.ts:66](https://github.com/jonathan-buttner/kibana/blob/2085a3b4480/x-pack/plugins/cases/server/client/client.ts#L66)
+Defined in: [client.ts:66](https://github.com/jonathan-buttner/kibana/blob/0e98e105663/x-pack/plugins/cases/server/client/client.ts#L66)
 
 ___
 
@@ -175,4 +175,4 @@ Retrieves an interface for interacting with the user actions associated with the
 
 **Returns:** [*UserActionsSubClient*](../interfaces/user_actions_client.useractionssubclient.md)
 
-Defined in: [client.ts:57](https://github.com/jonathan-buttner/kibana/blob/2085a3b4480/x-pack/plugins/cases/server/client/client.ts#L57)
+Defined in: [client.ts:57](https://github.com/jonathan-buttner/kibana/blob/0e98e105663/x-pack/plugins/cases/server/client/client.ts#L57)

x-pack/plugins/cases/docs/cases_client/interfaces/attachments_add.addargs.md

@@ -21,7 +21,7 @@ The arguments needed for creating a new attachment to a case.
 
 The case ID that this attachment will be associated with
 
-Defined in: [attachments/add.ts:308](https://github.com/jonathan-buttner/kibana/blob/2085a3b4480/x-pack/plugins/cases/server/client/attachments/add.ts#L308)
+Defined in: [attachments/add.ts:305](https://github.com/jonathan-buttner/kibana/blob/0e98e105663/x-pack/plugins/cases/server/client/attachments/add.ts#L305)
 
 ___
 
@@ -31,4 +31,4 @@ ___
 
 The attachment values.
 
-Defined in: [attachments/add.ts:312](https://github.com/jonathan-buttner/kibana/blob/2085a3b4480/x-pack/plugins/cases/server/client/attachments/add.ts#L312)
+Defined in: [attachments/add.ts:309](https://github.com/jonathan-buttner/kibana/blob/0e98e105663/x-pack/plugins/cases/server/client/attachments/add.ts#L309)

x-pack/plugins/cases/docs/cases_client/interfaces/attachments_client.attachmentssubclient.md

@@ -16,6 +16,7 @@ API for interacting with the attachments to a case.
 - [find](attachments_client.attachmentssubclient.md#find)
 - [get](attachments_client.attachmentssubclient.md#get)
 - [getAll](attachments_client.attachmentssubclient.md#getall)
+- [getAllAlertsAttachToCase](attachments_client.attachmentssubclient.md#getallalertsattachtocase)
 - [update](attachments_client.attachmentssubclient.md#update)
 
 ## Methods
@@ -34,7 +35,7 @@ Adds an attachment to a case.
 
 **Returns:** *Promise*<[*ICaseResponse*](typedoc_interfaces.icaseresponse.md)\>
 
-Defined in: [attachments/client.ts:25](https://github.com/jonathan-buttner/kibana/blob/2085a3b4480/x-pack/plugins/cases/server/client/attachments/client.ts#L25)
+Defined in: [attachments/client.ts:35](https://github.com/jonathan-buttner/kibana/blob/0e98e105663/x-pack/plugins/cases/server/client/attachments/client.ts#L35)
 
 ___
 
@@ -52,7 +53,7 @@ Deletes a single attachment for a specific case.
 
 **Returns:** *Promise*<void\>
 
-Defined in: [attachments/client.ts:33](https://github.com/jonathan-buttner/kibana/blob/2085a3b4480/x-pack/plugins/cases/server/client/attachments/client.ts#L33)
+Defined in: [attachments/client.ts:43](https://github.com/jonathan-buttner/kibana/blob/0e98e105663/x-pack/plugins/cases/server/client/attachments/client.ts#L43)
 
 ___
 
@@ -70,7 +71,7 @@ Deletes all attachments associated with a single case.
 
 **Returns:** *Promise*<void\>
 
-Defined in: [attachments/client.ts:29](https://github.com/jonathan-buttner/kibana/blob/2085a3b4480/x-pack/plugins/cases/server/client/attachments/client.ts#L29)
+Defined in: [attachments/client.ts:39](https://github.com/jonathan-buttner/kibana/blob/0e98e105663/x-pack/plugins/cases/server/client/attachments/client.ts#L39)
 
 ___
 
@@ -88,7 +89,7 @@ Retrieves all comments matching the search criteria.
 
 **Returns:** *Promise*<[*ICommentsResponse*](typedoc_interfaces.icommentsresponse.md)\>
 
-Defined in: [attachments/client.ts:37](https://github.com/jonathan-buttner/kibana/blob/2085a3b4480/x-pack/plugins/cases/server/client/attachments/client.ts#L37)
+Defined in: [attachments/client.ts:47](https://github.com/jonathan-buttner/kibana/blob/0e98e105663/x-pack/plugins/cases/server/client/attachments/client.ts#L47)
 
 ___
 
@@ -106,7 +107,7 @@ Retrieves a single attachment for a case.
 
 **Returns:** *Promise*<{ `comment`: *string* ; `owner`: *string* ; `type`: user  } & { `associationType`: AssociationType ; `created_at`: *string* ; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `owner`: *string* ; `pushed_at`: ``null`` \| *string* ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| *string* ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; }  } & { `id`: *string* ; `version`: *string*  } & { `alertId`: *string* \| *string*[] ; `index`: *string* \| *string*[] ; `owner`: *string* ; `rule`: { id: string \| null; name: string \| null; } ; `type`: alert \| generatedAlert  } & { `associationType`: AssociationType ; `created_at`: *string* ; `created_by`: { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `owner`: *string* ; `pushed_at`: ``null`` \| *string* ; `pushed_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; } ; `updated_at`: ``null`` \| *string* ; `updated_by`: ``null`` \| { email: string \| null \| undefined; full\_name: string \| null \| undefined; username: string \| null \| undefined; }  } & { `id`: *string* ; `version`: *string*  }\>
 
-Defined in: [attachments/client.ts:45](https://github.com/jonathan-buttner/kibana/blob/2085a3b4480/x-pack/plugins/cases/server/client/attachments/client.ts#L45)
+Defined in: [attachments/client.ts:59](https://github.com/jonathan-buttner/kibana/blob/0e98e105663/x-pack/plugins/cases/server/client/attachments/client.ts#L59)
 
 ___
 
@@ -124,7 +125,25 @@ Gets all attachments for a single case.
 
 **Returns:** *Promise*<[*IAllCommentsResponse*](typedoc_interfaces.iallcommentsresponse.md)\>
 
-Defined in: [attachments/client.ts:41](https://github.com/jonathan-buttner/kibana/blob/2085a3b4480/x-pack/plugins/cases/server/client/attachments/client.ts#L41)
+Defined in: [attachments/client.ts:55](https://github.com/jonathan-buttner/kibana/blob/0e98e105663/x-pack/plugins/cases/server/client/attachments/client.ts#L55)
+
+___
+
+### getAllAlertsAttachToCase
+
+▸ **getAllAlertsAttachToCase**(`params`: [*GetAllAlertsAttachToCase*](attachments_get.getallalertsattachtocase.md)): *Promise*<{ `attached_at`: *string* ; `id`: *string* ; `index`: *string*  }[]\>
+
+Retrieves all alerts attach to a case given a single case ID
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `params` | [*GetAllAlertsAttachToCase*](attachments_get.getallalertsattachtocase.md) |
+
+**Returns:** *Promise*<{ `attached_at`: *string* ; `id`: *string* ; `index`: *string*  }[]\>
+
+Defined in: [attachments/client.ts:51](https://github.com/jonathan-buttner/kibana/blob/0e98e105663/x-pack/plugins/cases/server/client/attachments/client.ts#L51)
 
 ___
 
@@ -144,4 +163,4 @@ The request must include all fields for the attachment. Even the fields that are
 
 **Returns:** *Promise*<[*ICaseResponse*](typedoc_interfaces.icaseresponse.md)\>
 
-Defined in: [attachments/client.ts:51](https://github.com/jonathan-buttner/kibana/blob/2085a3b4480/x-pack/plugins/cases/server/client/attachments/client.ts#L51)
+Defined in: [attachments/client.ts:65](https://github.com/jonathan-buttner/kibana/blob/0e98e105663/x-pack/plugins/cases/server/client/attachments/client.ts#L65)

x-pack/plugins/cases/docs/cases_client/interfaces/attachments_delete.deleteallargs.md

@@ -21,7 +21,7 @@ Parameters for deleting all comments of a case or sub case.
 
 The case ID to delete all attachments for
 
-Defined in: [attachments/delete.ts:26](https://github.com/jonathan-buttner/kibana/blob/2085a3b4480/x-pack/plugins/cases/server/client/attachments/delete.ts#L26)
+Defined in: [attachments/delete.ts:31](https://github.com/jonathan-buttner/kibana/blob/0e98e105663/x-pack/plugins/cases/server/client/attachments/delete.ts#L31)
 
 ___
 
@@ -31,4 +31,4 @@ ___
 
 If specified the caseID will be ignored and this value will be used to find a sub case for deleting all the attachments
 
-Defined in: [attachments/delete.ts:30](https://github.com/jonathan-buttner/kibana/blob/2085a3b4480/x-pack/plugins/cases/server/client/attachments/delete.ts#L30)
+Defined in: [attachments/delete.ts:35](https://github.com/jonathan-buttner/kibana/blob/0e98e105663/x-pack/plugins/cases/server/client/attachments/delete.ts#L35)

x-pack/plugins/cases/docs/cases_client/interfaces/attachments_delete.deleteargs.md

@@ -22,7 +22,7 @@ Parameters for deleting a single attachment of a case or sub case.
 
 The attachment ID to delete
 
-Defined in: [attachments/delete.ts:44](https://github.com/jonathan-buttner/kibana/blob/2085a3b4480/x-pack/plugins/cases/server/client/attachments/delete.ts#L44)
+Defined in: [attachments/delete.ts:49](https://github.com/jonathan-buttner/kibana/blob/0e98e105663/x-pack/plugins/cases/server/client/attachments/delete.ts#L49)
 
 ___
 
@@ -32,7 +32,7 @@ ___
 
 The case ID to delete an attachment from
 
-Defined in: [attachments/delete.ts:40](https://github.com/jonathan-buttner/kibana/blob/2085a3b4480/x-pack/plugins/cases/server/client/attachments/delete.ts#L40)
+Defined in: [attachments/delete.ts:45](https://github.com/jonathan-buttner/kibana/blob/0e98e105663/x-pack/plugins/cases/server/client/attachments/delete.ts#L45)
 
 ___
 
@@ -42,4 +42,4 @@ ___
 
 If specified the caseID will be ignored and this value will be used to find a sub case for deleting the attachment
 
-Defined in: [attachments/delete.ts:48](https://github.com/jonathan-buttner/kibana/blob/2085a3b4480/x-pack/plugins/cases/server/client/attachments/delete.ts#L48)
+Defined in: [attachments/delete.ts:53](https://github.com/jonathan-buttner/kibana/blob/0e98e105663/x-pack/plugins/cases/server/client/attachments/delete.ts#L53)

x-pack/plugins/cases/docs/cases_client/interfaces/attachments_get.findargs.md

@@ -21,7 +21,7 @@ Parameters for finding attachments of a case
 
 The case ID for finding associated attachments
 
-Defined in: [attachments/get.ts:48](https://github.com/jonathan-buttner/kibana/blob/2085a3b4480/x-pack/plugins/cases/server/client/attachments/get.ts#L48)
+Defined in: [attachments/get.ts:47](https://github.com/jonathan-buttner/kibana/blob/0e98e105663/x-pack/plugins/cases/server/client/attachments/get.ts#L47)
 
 ___
 
@@ -48,4 +48,4 @@ Optional parameters for filtering the returned attachments
 | `sortOrder` | *undefined* \| ``"desc"`` \| ``"asc"`` |
 | `subCaseId` | *undefined* \| *string* |
 
-Defined in: [attachments/get.ts:52](https://github.com/jonathan-buttner/kibana/blob/2085a3b4480/x-pack/plugins/cases/server/client/attachments/get.ts#L52)
+Defined in: [attachments/get.ts:51](https://github.com/jonathan-buttner/kibana/blob/0e98e105663/x-pack/plugins/cases/server/client/attachments/get.ts#L51)

x-pack/plugins/cases/docs/cases_client/interfaces/attachments_get.getallalertsattachtocase.md

@@ -0,0 +1,21 @@
+[Cases Client API Interface](../cases_client_api.md) / [attachments/get](../modules/attachments_get.md) / GetAllAlertsAttachToCase
+
+# Interface: GetAllAlertsAttachToCase
+
+[attachments/get](../modules/attachments_get.md).GetAllAlertsAttachToCase
+
+## Table of contents
+
+### Properties
+
+- [caseId](attachments_get.getallalertsattachtocase.md#caseid)
+
+## Properties
+
+### caseId
+
+• **caseId**: *string*
+
+The ID of the case to retrieve the alerts from
+
+Defined in: [attachments/get.ts:87](https://github.com/jonathan-buttner/kibana/blob/0e98e105663/x-pack/plugins/cases/server/client/attachments/get.ts#L87)

x-pack/plugins/cases/docs/cases_client/interfaces/attachments_get.getallargs.md

@@ -22,7 +22,7 @@ Parameters for retrieving all attachments of a case
 
 The case ID to retrieve all attachments for
 
-Defined in: [attachments/get.ts:62](https://github.com/jonathan-buttner/kibana/blob/2085a3b4480/x-pack/plugins/cases/server/client/attachments/get.ts#L62)
+Defined in: [attachments/get.ts:61](https://github.com/jonathan-buttner/kibana/blob/0e98e105663/x-pack/plugins/cases/server/client/attachments/get.ts#L61)
 
 ___
 
@@ -32,7 +32,7 @@ ___
 
 Optionally include the attachments associated with a sub case
 
-Defined in: [attachments/get.ts:66](https://github.com/jonathan-buttner/kibana/blob/2085a3b4480/x-pack/plugins/cases/server/client/attachments/get.ts#L66)
+Defined in: [attachments/get.ts:65](https://github.com/jonathan-buttner/kibana/blob/0e98e105663/x-pack/plugins/cases/server/client/attachments/get.ts#L65)
 
 ___
 
@@ -42,4 +42,4 @@ ___
 
 If included the case ID will be ignored and the attachments will be retrieved from the specified ID of the sub case
 
-Defined in: [attachments/get.ts:70](https://github.com/jonathan-buttner/kibana/blob/2085a3b4480/x-pack/plugins/cases/server/client/attachments/get.ts#L70)
+Defined in: [attachments/get.ts:69](https://github.com/jonathan-buttner/kibana/blob/0e98e105663/x-pack/plugins/cases/server/client/attachments/get.ts#L69)

x-pack/plugins/cases/docs/cases_client/interfaces/attachments_get.getargs.md

@@ -19,7 +19,7 @@
 
 The ID of the attachment to retrieve
 
-Defined in: [attachments/get.ts:81](https://github.com/jonathan-buttner/kibana/blob/2085a3b4480/x-pack/plugins/cases/server/client/attachments/get.ts#L81)
+Defined in: [attachments/get.ts:80](https://github.com/jonathan-buttner/kibana/blob/0e98e105663/x-pack/plugins/cases/server/client/attachments/get.ts#L80)
 
 ___
 
@@ -29,4 +29,4 @@ ___
 
 The ID of the case to retrieve an attachment from
 
-Defined in: [attachments/get.ts:77](https://github.com/jonathan-buttner/kibana/blob/2085a3b4480/x-pack/plugins/cases/server/client/attachments/get.ts#L77)
+Defined in: [attachments/get.ts:76](https://github.com/jonathan-buttner/kibana/blob/0e98e105663/x-pack/plugins/cases/server/client/attachments/get.ts#L76)