kibana/api_docs/cases.json
Stacey Gammon 044c725c71
Fix a bunch of bugs with APIDocs system (#99589)
* Remove custom code, add in a hack

* remove artifical limit

* Fix arrow functions in interfaces not having children

* Update docs

* Update api docs after merge from master

* update api docs after merge from master

* update api docs
2021-05-20 13:22:41 -04:00

20953 lines
606 KiB
JSON

{
"id": "cases",
"client": {
"classes": [
{
"parentPluginId": "cases",
"id": "def-public.CasesUiPlugin",
"type": "Class",
"tags": [],
"label": "CasesUiPlugin",
"description": [],
"signature": [
{
"pluginId": "cases",
"scope": "public",
"docId": "kibCasesPluginApi",
"section": "def-public.CasesUiPlugin",
"text": "CasesUiPlugin"
},
" implements ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.Plugin",
"text": "Plugin"
},
"<void, ",
{
"pluginId": "cases",
"scope": "public",
"docId": "kibCasesPluginApi",
"section": "def-public.CasesUiStart",
"text": "CasesUiStart"
},
", ",
{
"pluginId": "cases",
"scope": "public",
"docId": "kibCasesPluginApi",
"section": "def-public.SetupPlugins",
"text": "SetupPlugins"
},
", ",
{
"pluginId": "cases",
"scope": "public",
"docId": "kibCasesPluginApi",
"section": "def-public.StartPlugins",
"text": "StartPlugins"
},
">"
],
"source": {
"path": "x-pack/plugins/cases/public/plugin.ts",
"lineNumber": 26
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-public.CasesUiPlugin.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"source": {
"path": "x-pack/plugins/cases/public/plugin.ts",
"lineNumber": 29
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-public.CasesUiPlugin.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "initializerContext",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.PluginInitializerContext",
"text": "PluginInitializerContext"
},
"<object>"
],
"source": {
"path": "x-pack/plugins/cases/public/plugin.ts",
"lineNumber": 29
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "cases",
"id": "def-public.CasesUiPlugin.setup",
"type": "Function",
"tags": [],
"label": "setup",
"description": [],
"signature": [
"(core: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>, plugins: ",
{
"pluginId": "cases",
"scope": "public",
"docId": "kibCasesPluginApi",
"section": "def-public.SetupPlugins",
"text": "SetupPlugins"
},
") => void"
],
"source": {
"path": "x-pack/plugins/cases/public/plugin.ts",
"lineNumber": 32
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-public.CasesUiPlugin.setup.$1",
"type": "Object",
"tags": [],
"label": "core",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>"
],
"source": {
"path": "x-pack/plugins/cases/public/plugin.ts",
"lineNumber": 32
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "cases",
"id": "def-public.CasesUiPlugin.setup.$2",
"type": "Object",
"tags": [],
"label": "plugins",
"description": [],
"signature": [
{
"pluginId": "cases",
"scope": "public",
"docId": "kibCasesPluginApi",
"section": "def-public.SetupPlugins",
"text": "SetupPlugins"
}
],
"source": {
"path": "x-pack/plugins/cases/public/plugin.ts",
"lineNumber": 32
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "cases",
"id": "def-public.CasesUiPlugin.start",
"type": "Function",
"tags": [],
"label": "start",
"description": [],
"signature": [
"(core: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.CoreStart",
"text": "CoreStart"
},
", plugins: ",
{
"pluginId": "cases",
"scope": "public",
"docId": "kibCasesPluginApi",
"section": "def-public.StartPlugins",
"text": "StartPlugins"
},
") => ",
{
"pluginId": "cases",
"scope": "public",
"docId": "kibCasesPluginApi",
"section": "def-public.CasesUiStart",
"text": "CasesUiStart"
}
],
"source": {
"path": "x-pack/plugins/cases/public/plugin.ts",
"lineNumber": 38
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-public.CasesUiPlugin.start.$1",
"type": "Object",
"tags": [],
"label": "core",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.CoreStart",
"text": "CoreStart"
}
],
"source": {
"path": "x-pack/plugins/cases/public/plugin.ts",
"lineNumber": 38
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "cases",
"id": "def-public.CasesUiPlugin.start.$2",
"type": "Object",
"tags": [],
"label": "plugins",
"description": [],
"signature": [
{
"pluginId": "cases",
"scope": "public",
"docId": "kibCasesPluginApi",
"section": "def-public.StartPlugins",
"text": "StartPlugins"
}
],
"source": {
"path": "x-pack/plugins/cases/public/plugin.ts",
"lineNumber": 38
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "cases",
"id": "def-public.CasesUiPlugin.stop",
"type": "Function",
"tags": [],
"label": "stop",
"description": [],
"signature": [
"() => void"
],
"source": {
"path": "x-pack/plugins/cases/public/plugin.ts",
"lineNumber": 92
},
"deprecated": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [
{
"parentPluginId": "cases",
"id": "def-public.SetupPlugins",
"type": "Interface",
"tags": [],
"label": "SetupPlugins",
"description": [],
"source": {
"path": "x-pack/plugins/cases/public/types.ts",
"lineNumber": 22
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-public.SetupPlugins.security",
"type": "Object",
"tags": [],
"label": "security",
"description": [],
"signature": [
"{ authc: ",
"AuthenticationServiceSetup",
"; sessionTimeout: ",
"SessionTimeout",
"; license: Readonly<{ isLicenseAvailable: () => boolean; isEnabled: () => boolean; getType: () => \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; getFeatures: () => ",
"SecurityLicenseFeatures",
"; features$: ",
"Observable",
"<",
"SecurityLicenseFeatures",
">; }>; __legacyCompat: { logoutUrl: string; tenant: string; }; }"
],
"source": {
"path": "x-pack/plugins/cases/public/types.ts",
"lineNumber": 23
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-public.SetupPlugins.triggersActionsUi",
"type": "Object",
"tags": [],
"label": "triggersActionsUi",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.TriggersAndActionsUIPublicPluginSetup",
"text": "TriggersAndActionsUIPublicPluginSetup"
}
],
"source": {
"path": "x-pack/plugins/cases/public/types.ts",
"lineNumber": 24
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-public.StartPlugins",
"type": "Interface",
"tags": [],
"label": "StartPlugins",
"description": [],
"source": {
"path": "x-pack/plugins/cases/public/types.ts",
"lineNumber": 27
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-public.StartPlugins.triggersActionsUi",
"type": "Object",
"tags": [],
"label": "triggersActionsUi",
"description": [],
"signature": [
{
"pluginId": "triggersActionsUi",
"scope": "public",
"docId": "kibTriggersActionsUiPluginApi",
"section": "def-public.TriggersAndActionsUIPublicPluginStart",
"text": "TriggersAndActionsUIPublicPluginStart"
}
],
"source": {
"path": "x-pack/plugins/cases/public/types.ts",
"lineNumber": 28
},
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "cases",
"id": "def-public.StartServices",
"type": "Type",
"tags": [],
"label": "StartServices",
"description": [
"\nTODO: The extra security service is one that should be implemented in the kibana context of the consuming application.\nSecurity is needed for access to authc for the `useCurrentUser` hook. Security_Solution currently passes it via renderApp in public/plugin.tsx\nLeaving it out currently in lieu of RBAC changes"
],
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.CoreStart",
"text": "CoreStart"
},
" & ",
{
"pluginId": "cases",
"scope": "public",
"docId": "kibCasesPluginApi",
"section": "def-public.StartPlugins",
"text": "StartPlugins"
},
" & { security: { authc: ",
"AuthenticationServiceSetup",
"; sessionTimeout: ",
"SessionTimeout",
"; license: Readonly<{ isLicenseAvailable: () => boolean; isEnabled: () => boolean; getType: () => \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; getFeatures: () => ",
"SecurityLicenseFeatures",
"; features$: ",
"Observable",
"<",
"SecurityLicenseFeatures",
">; }>; __legacyCompat: { logoutUrl: string; tenant: string; }; }; }"
],
"source": {
"path": "x-pack/plugins/cases/public/types.ts",
"lineNumber": 37
},
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [],
"start": {
"parentPluginId": "cases",
"id": "def-public.CasesUiStart",
"type": "Interface",
"tags": [],
"label": "CasesUiStart",
"description": [],
"source": {
"path": "x-pack/plugins/cases/public/types.ts",
"lineNumber": 42
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-public.CasesUiStart.getAllCases",
"type": "Function",
"tags": [],
"label": "getAllCases",
"description": [],
"signature": [
"(props: ",
"AllCasesProps",
") => React.ReactElement<",
"AllCasesProps",
">"
],
"source": {
"path": "x-pack/plugins/cases/public/types.ts",
"lineNumber": 43
},
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "cases",
"id": "def-public.props",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"AllCasesProps"
],
"source": {
"path": "x-pack/plugins/cases/public/types.ts",
"lineNumber": 43
},
"deprecated": false
}
]
},
{
"parentPluginId": "cases",
"id": "def-public.CasesUiStart.getAllCasesSelectorModal",
"type": "Function",
"tags": [],
"label": "getAllCasesSelectorModal",
"description": [],
"signature": [
"(props: ",
"AllCasesSelectorModalProps",
") => React.ReactElement<",
"AllCasesSelectorModalProps",
">"
],
"source": {
"path": "x-pack/plugins/cases/public/types.ts",
"lineNumber": 44
},
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "cases",
"id": "def-public.props",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"AllCasesSelectorModalProps"
],
"source": {
"path": "x-pack/plugins/cases/public/types.ts",
"lineNumber": 45
},
"deprecated": false
}
]
},
{
"parentPluginId": "cases",
"id": "def-public.CasesUiStart.getCaseView",
"type": "Function",
"tags": [],
"label": "getCaseView",
"description": [],
"signature": [
"(props: ",
"CaseViewProps",
") => React.ReactElement<",
"CaseViewProps",
">"
],
"source": {
"path": "x-pack/plugins/cases/public/types.ts",
"lineNumber": 47
},
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "cases",
"id": "def-public.props",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"CaseViewProps"
],
"source": {
"path": "x-pack/plugins/cases/public/types.ts",
"lineNumber": 47
},
"deprecated": false
}
]
},
{
"parentPluginId": "cases",
"id": "def-public.CasesUiStart.getConfigureCases",
"type": "Function",
"tags": [],
"label": "getConfigureCases",
"description": [],
"signature": [
"(props: ",
"ConfigureCasesProps",
") => React.ReactElement<",
"ConfigureCasesProps",
">"
],
"source": {
"path": "x-pack/plugins/cases/public/types.ts",
"lineNumber": 48
},
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "cases",
"id": "def-public.props",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"ConfigureCasesProps"
],
"source": {
"path": "x-pack/plugins/cases/public/types.ts",
"lineNumber": 48
},
"deprecated": false
}
]
},
{
"parentPluginId": "cases",
"id": "def-public.CasesUiStart.getCreateCase",
"type": "Function",
"tags": [],
"label": "getCreateCase",
"description": [],
"signature": [
"(props: ",
"CreateCaseProps",
") => React.ReactElement<",
"CreateCaseProps",
">"
],
"source": {
"path": "x-pack/plugins/cases/public/types.ts",
"lineNumber": 49
},
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "cases",
"id": "def-public.props",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"CreateCaseProps"
],
"source": {
"path": "x-pack/plugins/cases/public/types.ts",
"lineNumber": 49
},
"deprecated": false
}
]
},
{
"parentPluginId": "cases",
"id": "def-public.CasesUiStart.getRecentCases",
"type": "Function",
"tags": [],
"label": "getRecentCases",
"description": [],
"signature": [
"(props: ",
"RecentCasesProps",
") => React.ReactElement<",
"RecentCasesProps",
">"
],
"source": {
"path": "x-pack/plugins/cases/public/types.ts",
"lineNumber": 50
},
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "cases",
"id": "def-public.props",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"RecentCasesProps"
],
"source": {
"path": "x-pack/plugins/cases/public/types.ts",
"lineNumber": 50
},
"deprecated": false
}
]
}
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [
{
"parentPluginId": "cases",
"id": "def-server.CaseRequestContext",
"type": "Interface",
"tags": [],
"label": "CaseRequestContext",
"description": [],
"source": {
"path": "x-pack/plugins/cases/server/types.ts",
"lineNumber": 12
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-server.CaseRequestContext.getCasesClient",
"type": "Function",
"tags": [],
"label": "getCasesClient",
"description": [],
"signature": [
"() => ",
{
"pluginId": "cases",
"scope": "server",
"docId": "kibCasesPluginApi",
"section": "def-server.CasesClient",
"text": "CasesClient"
}
],
"source": {
"path": "x-pack/plugins/cases/server/types.ts",
"lineNumber": 13
},
"deprecated": false,
"returnComment": [],
"children": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-server.CasesClient",
"type": "Interface",
"tags": [],
"label": "CasesClient",
"description": [
"\nThis represents the interface that other plugins can access."
],
"source": {
"path": "x-pack/plugins/cases/server/client/types.ts",
"lineNumber": 102
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-server.CasesClient.addComment",
"type": "Function",
"tags": [],
"label": "addComment",
"description": [],
"signature": [
"(args: ",
"CasesClientAddComment",
") => Promise<{ description: string; status: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"; tags: string[]; title: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
"; connector: ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; }); settings: { syncAlerts: boolean; }; } & { closed_at: string | null; closed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; external_service: ({ connector_id: string; connector_name: string; external_id: string; external_title: string; external_url: string; } & { pushed_at: string; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; }) | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; totalComment: number; totalAlerts: number; version: string; } & { subCaseIds?: string[] | undefined; subCases?: ({ status: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"; } & { closed_at: string | null; closed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; totalComment: number; totalAlerts: number; version: string; } & { comments?: (({ comment: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert | ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }))[] | undefined; })[] | undefined; comments?: (({ comment: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert | ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }))[] | undefined; }>"
],
"source": {
"path": "x-pack/plugins/cases/server/client/types.ts",
"lineNumber": 103
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-server.CasesClient.addComment.$1",
"type": "Object",
"tags": [],
"label": "args",
"description": [],
"signature": [
"CasesClientAddComment"
],
"source": {
"path": "x-pack/plugins/cases/server/client/types.ts",
"lineNumber": 103
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "cases",
"id": "def-server.CasesClient.create",
"type": "Function",
"tags": [],
"label": "create",
"description": [],
"signature": [
"(theCase: { type?: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
" | undefined; } & { description: string; tags: string[]; title: string; connector: ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; }); settings: { syncAlerts: boolean; }; }) => Promise<{ description: string; status: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"; tags: string[]; title: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
"; connector: ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; }); settings: { syncAlerts: boolean; }; } & { closed_at: string | null; closed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; external_service: ({ connector_id: string; connector_name: string; external_id: string; external_title: string; external_url: string; } & { pushed_at: string; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; }) | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; totalComment: number; totalAlerts: number; version: string; } & { subCaseIds?: string[] | undefined; subCases?: ({ status: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"; } & { closed_at: string | null; closed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; totalComment: number; totalAlerts: number; version: string; } & { comments?: (({ comment: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert | ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }))[] | undefined; })[] | undefined; comments?: (({ comment: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert | ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }))[] | undefined; }>"
],
"source": {
"path": "x-pack/plugins/cases/server/client/types.ts",
"lineNumber": 104
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-server.CasesClient.create.$1",
"type": "CompoundType",
"tags": [],
"label": "theCase",
"description": [],
"signature": [
"{ type?: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
" | undefined; } & { description: string; tags: string[]; title: string; connector: ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; }); settings: { syncAlerts: boolean; }; }"
],
"source": {
"path": "x-pack/plugins/cases/server/client/types.ts",
"lineNumber": 104
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "cases",
"id": "def-server.CasesClient.get",
"type": "Function",
"tags": [],
"label": "get",
"description": [],
"signature": [
"(args: ",
"CasesClientGet",
") => Promise<{ description: string; status: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"; tags: string[]; title: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
"; connector: ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; }); settings: { syncAlerts: boolean; }; } & { closed_at: string | null; closed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; external_service: ({ connector_id: string; connector_name: string; external_id: string; external_title: string; external_url: string; } & { pushed_at: string; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; }) | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; totalComment: number; totalAlerts: number; version: string; } & { subCaseIds?: string[] | undefined; subCases?: ({ status: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"; } & { closed_at: string | null; closed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; totalComment: number; totalAlerts: number; version: string; } & { comments?: (({ comment: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert | ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }))[] | undefined; })[] | undefined; comments?: (({ comment: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert | ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }))[] | undefined; }>"
],
"source": {
"path": "x-pack/plugins/cases/server/client/types.ts",
"lineNumber": 105
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-server.CasesClient.get.$1",
"type": "Object",
"tags": [],
"label": "args",
"description": [],
"signature": [
"CasesClientGet"
],
"source": {
"path": "x-pack/plugins/cases/server/client/types.ts",
"lineNumber": 105
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "cases",
"id": "def-server.CasesClient.getAlerts",
"type": "Function",
"tags": [],
"label": "getAlerts",
"description": [],
"signature": [
"(args: ",
"CasesClientGetAlerts",
") => Promise<",
"CasesClientGetAlertsResponse",
">"
],
"source": {
"path": "x-pack/plugins/cases/server/client/types.ts",
"lineNumber": 106
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-server.CasesClient.getAlerts.$1",
"type": "Object",
"tags": [],
"label": "args",
"description": [],
"signature": [
"CasesClientGetAlerts"
],
"source": {
"path": "x-pack/plugins/cases/server/client/types.ts",
"lineNumber": 106
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "cases",
"id": "def-server.CasesClient.getFields",
"type": "Function",
"tags": [],
"label": "getFields",
"description": [],
"signature": [
"(args: ",
"ConfigureFields",
") => Promise<{ defaultMappings: { action_type: \"append\" | \"overwrite\" | \"nothing\"; source: \"description\" | \"title\" | \"comments\"; target: string; }[]; fields: { id: string; name: string; required: boolean; type: \"text\" | \"textarea\"; }[]; }>"
],
"source": {
"path": "x-pack/plugins/cases/server/client/types.ts",
"lineNumber": 107
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-server.CasesClient.getFields.$1",
"type": "Object",
"tags": [],
"label": "args",
"description": [],
"signature": [
"ConfigureFields"
],
"source": {
"path": "x-pack/plugins/cases/server/client/types.ts",
"lineNumber": 107
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "cases",
"id": "def-server.CasesClient.getMappings",
"type": "Function",
"tags": [],
"label": "getMappings",
"description": [],
"signature": [
"(args: ",
"MappingsClient",
") => Promise<{ action_type: \"append\" | \"overwrite\" | \"nothing\"; source: \"description\" | \"title\" | \"comments\"; target: string; }[]>"
],
"source": {
"path": "x-pack/plugins/cases/server/client/types.ts",
"lineNumber": 108
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-server.CasesClient.getMappings.$1",
"type": "Object",
"tags": [],
"label": "args",
"description": [],
"signature": [
"MappingsClient"
],
"source": {
"path": "x-pack/plugins/cases/server/client/types.ts",
"lineNumber": 108
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "cases",
"id": "def-server.CasesClient.getUserActions",
"type": "Function",
"tags": [],
"label": "getUserActions",
"description": [],
"signature": [
"(args: ",
"CasesClientGetUserActions",
") => Promise<({ action_field: (\"status\" | \"description\" | \"title\" | \"comment\" | \"tags\" | \"settings\" | \"connector\" | \"pushed\" | \"sub_case\")[]; action: \"add\" | \"delete\" | \"create\" | \"update\" | \"push-to-service\"; action_at: string; action_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; new_value: string | null; old_value: string | null; } & { action_id: string; case_id: string; comment_id: string | null; } & { sub_case_id?: string | undefined; })[]>"
],
"source": {
"path": "x-pack/plugins/cases/server/client/types.ts",
"lineNumber": 109
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-server.CasesClient.getUserActions.$1",
"type": "Object",
"tags": [],
"label": "args",
"description": [],
"signature": [
"CasesClientGetUserActions"
],
"source": {
"path": "x-pack/plugins/cases/server/client/types.ts",
"lineNumber": 109
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "cases",
"id": "def-server.CasesClient.push",
"type": "Function",
"tags": [],
"label": "push",
"description": [],
"signature": [
"(args: ",
"CasesClientPush",
") => Promise<{ description: string; status: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"; tags: string[]; title: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
"; connector: ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; }); settings: { syncAlerts: boolean; }; } & { closed_at: string | null; closed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; external_service: ({ connector_id: string; connector_name: string; external_id: string; external_title: string; external_url: string; } & { pushed_at: string; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; }) | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; totalComment: number; totalAlerts: number; version: string; } & { subCaseIds?: string[] | undefined; subCases?: ({ status: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"; } & { closed_at: string | null; closed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; totalComment: number; totalAlerts: number; version: string; } & { comments?: (({ comment: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert | ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }))[] | undefined; })[] | undefined; comments?: (({ comment: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert | ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }))[] | undefined; }>"
],
"source": {
"path": "x-pack/plugins/cases/server/client/types.ts",
"lineNumber": 110
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-server.CasesClient.push.$1",
"type": "Object",
"tags": [],
"label": "args",
"description": [],
"signature": [
"CasesClientPush"
],
"source": {
"path": "x-pack/plugins/cases/server/client/types.ts",
"lineNumber": 110
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "cases",
"id": "def-server.CasesClient.update",
"type": "Function",
"tags": [],
"label": "update",
"description": [],
"signature": [
"(args: { cases: ({ description?: string | undefined; status?: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
" | undefined; tags?: string[] | undefined; title?: string | undefined; type?: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
" | undefined; connector?: ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; }) | undefined; settings?: { syncAlerts: boolean; } | undefined; } & { id: string; version: string; })[]; }) => Promise<({ description: string; status: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"; tags: string[]; title: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
"; connector: ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; }); settings: { syncAlerts: boolean; }; } & { closed_at: string | null; closed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; external_service: ({ connector_id: string; connector_name: string; external_id: string; external_title: string; external_url: string; } & { pushed_at: string; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; }) | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; totalComment: number; totalAlerts: number; version: string; } & { subCaseIds?: string[] | undefined; subCases?: ({ status: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"; } & { closed_at: string | null; closed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; totalComment: number; totalAlerts: number; version: string; } & { comments?: (({ comment: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert | ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }))[] | undefined; })[] | undefined; comments?: (({ comment: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert | ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }))[] | undefined; })[]>"
],
"source": {
"path": "x-pack/plugins/cases/server/client/types.ts",
"lineNumber": 111
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-server.CasesClient.update.$1",
"type": "Object",
"tags": [],
"label": "args",
"description": [],
"signature": [
"{ cases: ({ description?: string | undefined; status?: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
" | undefined; tags?: string[] | undefined; title?: string | undefined; type?: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
" | undefined; connector?: ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; }) | undefined; settings?: { syncAlerts: boolean; } | undefined; } & { id: string; version: string; })[]; }"
],
"source": {
"path": "x-pack/plugins/cases/server/client/types.ts",
"lineNumber": 111
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "cases",
"id": "def-server.CasesClient.updateAlertsStatus",
"type": "Function",
"tags": [],
"label": "updateAlertsStatus",
"description": [],
"signature": [
"(args: ",
"CasesClientUpdateAlertsStatus",
") => Promise<void>"
],
"source": {
"path": "x-pack/plugins/cases/server/client/types.ts",
"lineNumber": 112
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-server.CasesClient.updateAlertsStatus.$1",
"type": "Object",
"tags": [],
"label": "args",
"description": [],
"signature": [
"CasesClientUpdateAlertsStatus"
],
"source": {
"path": "x-pack/plugins/cases/server/client/types.ts",
"lineNumber": 112
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "cases",
"id": "def-server.CasesClient.getCaseIdsByAlertId",
"type": "Function",
"tags": [],
"label": "getCaseIdsByAlertId",
"description": [],
"signature": [
"(args: ",
"CasesClientGetCasesByAlert",
") => Promise<string[]>"
],
"source": {
"path": "x-pack/plugins/cases/server/client/types.ts",
"lineNumber": 113
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-server.CasesClient.getCaseIdsByAlertId.$1",
"type": "Object",
"tags": [],
"label": "args",
"description": [],
"signature": [
"CasesClientGetCasesByAlert"
],
"source": {
"path": "x-pack/plugins/cases/server/client/types.ts",
"lineNumber": 113
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-server.PluginStartContract",
"type": "Interface",
"tags": [],
"label": "PluginStartContract",
"description": [],
"source": {
"path": "x-pack/plugins/cases/server/index.ts",
"lineNumber": 29
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-server.PluginStartContract.getCasesClientWithRequestAndContext",
"type": "Function",
"tags": [],
"label": "getCasesClientWithRequestAndContext",
"description": [],
"signature": [
"(context: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.RequestHandlerContext",
"text": "RequestHandlerContext"
},
", request: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>) => ",
{
"pluginId": "cases",
"scope": "server",
"docId": "kibCasesPluginApi",
"section": "def-server.CasesClient",
"text": "CasesClient"
}
],
"source": {
"path": "x-pack/plugins/cases/server/index.ts",
"lineNumber": 30
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-server.PluginStartContract.getCasesClientWithRequestAndContext.$1",
"type": "Object",
"tags": [],
"label": "context",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.RequestHandlerContext",
"text": "RequestHandlerContext"
}
],
"source": {
"path": "x-pack/plugins/cases/server/index.ts",
"lineNumber": 31
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "cases",
"id": "def-server.PluginStartContract.getCasesClientWithRequestAndContext.$2",
"type": "Object",
"tags": [],
"label": "request",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>"
],
"source": {
"path": "x-pack/plugins/cases/server/index.ts",
"lineNumber": 32
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "cases",
"id": "def-common.createPlainError",
"type": "Function",
"tags": [],
"label": "createPlainError",
"description": [],
"signature": [
"(message: string) => Error"
],
"source": {
"path": "x-pack/plugins/cases/common/api/runtime_types.ts",
"lineNumber": 49
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.createPlainError.$1",
"type": "string",
"tags": [],
"label": "message",
"description": [],
"signature": [
"string"
],
"source": {
"path": "x-pack/plugins/cases/common/api/runtime_types.ts",
"lineNumber": 49
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.decodeOrThrow",
"type": "Function",
"tags": [],
"label": "decodeOrThrow",
"description": [],
"signature": [
"<A, O, I>(runtimeType: ",
"Type",
"<A, O, I>, createError?: ErrorFactory) => (inputValue: I) => A"
],
"source": {
"path": "x-pack/plugins/cases/common/api/runtime_types.ts",
"lineNumber": 55
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.decodeOrThrow.$1",
"type": "Object",
"tags": [],
"label": "runtimeType",
"description": [],
"signature": [
"Type",
"<A, O, I>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/runtime_types.ts",
"lineNumber": 56
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "cases",
"id": "def-common.decodeOrThrow.$2",
"type": "Function",
"tags": [],
"label": "createError",
"description": [],
"signature": [
"ErrorFactory"
],
"source": {
"path": "x-pack/plugins/cases/common/api/runtime_types.ts",
"lineNumber": 57
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.excess",
"type": "Function",
"tags": [],
"label": "excess",
"description": [],
"signature": [
"(codec: C) => C"
],
"source": {
"path": "x-pack/plugins/cases/common/api/runtime_types.ts",
"lineNumber": 71
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.excess.$1",
"type": "Uncategorized",
"tags": [],
"label": "codec",
"description": [],
"signature": [
"C"
],
"source": {
"path": "x-pack/plugins/cases/common/api/runtime_types.ts",
"lineNumber": 71
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.formatErrors",
"type": "Function",
"tags": [
"deprecated"
],
"label": "formatErrors",
"description": [],
"signature": [
"(errors: ",
"Errors",
") => string[]"
],
"source": {
"path": "x-pack/plugins/cases/common/api/runtime_types.ts",
"lineNumber": 20
},
"deprecated": true,
"references": [],
"children": [
{
"parentPluginId": "cases",
"id": "def-common.formatErrors.$1",
"type": "Object",
"tags": [],
"label": "errors",
"description": [],
"signature": [
"Errors"
],
"source": {
"path": "x-pack/plugins/cases/common/api/runtime_types.ts",
"lineNumber": 20
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.getCaseCommentDetailsUrl",
"type": "Function",
"tags": [],
"label": "getCaseCommentDetailsUrl",
"description": [],
"signature": [
"(caseId: string, commentId: string) => string"
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 36
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.getCaseCommentDetailsUrl.$1",
"type": "string",
"tags": [],
"label": "caseId",
"description": [],
"signature": [
"string"
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 36
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "cases",
"id": "def-common.getCaseCommentDetailsUrl.$2",
"type": "string",
"tags": [],
"label": "commentId",
"description": [],
"signature": [
"string"
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 36
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.getCaseCommentsUrl",
"type": "Function",
"tags": [],
"label": "getCaseCommentsUrl",
"description": [],
"signature": [
"(id: string) => string"
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 32
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.getCaseCommentsUrl.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 32
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.getCaseDetailsUrl",
"type": "Function",
"tags": [],
"label": "getCaseDetailsUrl",
"description": [],
"signature": [
"(id: string) => string"
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 20
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.getCaseDetailsUrl.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 20
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.getCasePushUrl",
"type": "Function",
"tags": [],
"label": "getCasePushUrl",
"description": [],
"signature": [
"(caseId: string, connectorId: string) => string"
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 48
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.getCasePushUrl.$1",
"type": "string",
"tags": [],
"label": "caseId",
"description": [],
"signature": [
"string"
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 48
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "cases",
"id": "def-common.getCasePushUrl.$2",
"type": "string",
"tags": [],
"label": "connectorId",
"description": [],
"signature": [
"string"
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 48
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.getCasesFromAlertsUrl",
"type": "Function",
"tags": [],
"label": "getCasesFromAlertsUrl",
"description": [],
"signature": [
"(alertId: string) => string"
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 52
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.getCasesFromAlertsUrl.$1",
"type": "string",
"tags": [],
"label": "alertId",
"description": [],
"signature": [
"string"
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 52
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.getCaseUserActionUrl",
"type": "Function",
"tags": [],
"label": "getCaseUserActionUrl",
"description": [],
"signature": [
"(id: string) => string"
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 40
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.getCaseUserActionUrl.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 40
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.getSubCaseDetailsUrl",
"type": "Function",
"tags": [],
"label": "getSubCaseDetailsUrl",
"description": [],
"signature": [
"(caseID: string, subCaseId: string) => string"
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 28
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.getSubCaseDetailsUrl.$1",
"type": "string",
"tags": [],
"label": "caseID",
"description": [],
"signature": [
"string"
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 28
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "cases",
"id": "def-common.getSubCaseDetailsUrl.$2",
"type": "string",
"tags": [],
"label": "subCaseId",
"description": [],
"signature": [
"string"
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 28
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.getSubCasesUrl",
"type": "Function",
"tags": [],
"label": "getSubCasesUrl",
"description": [],
"signature": [
"(caseID: string) => string"
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 24
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.getSubCasesUrl.$1",
"type": "string",
"tags": [],
"label": "caseID",
"description": [],
"signature": [
"string"
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 24
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.getSubCaseUserActionUrl",
"type": "Function",
"tags": [],
"label": "getSubCaseUserActionUrl",
"description": [],
"signature": [
"(caseID: string, subCaseId: string) => string"
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 44
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.getSubCaseUserActionUrl.$1",
"type": "string",
"tags": [],
"label": "caseID",
"description": [],
"signature": [
"string"
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 44
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "cases",
"id": "def-common.getSubCaseUserActionUrl.$2",
"type": "string",
"tags": [],
"label": "subCaseId",
"description": [],
"signature": [
"string"
],
"source": {
"path": "x-pack/plugins/cases/common/api/helpers.ts",
"lineNumber": 44
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.throwErrors",
"type": "Function",
"tags": [],
"label": "throwErrors",
"description": [],
"signature": [
"(createError: ErrorFactory) => (errors: ",
"Errors",
") => never"
],
"source": {
"path": "x-pack/plugins/cases/common/api/runtime_types.ts",
"lineNumber": 51
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.throwErrors.$1",
"type": "Function",
"tags": [],
"label": "createError",
"description": [],
"signature": [
"ErrorFactory"
],
"source": {
"path": "x-pack/plugins/cases/common/api/runtime_types.ts",
"lineNumber": 51
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "cases",
"id": "def-common.ActionLicense",
"type": "Interface",
"tags": [],
"label": "ActionLicense",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 144
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.ActionLicense.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 145
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.ActionLicense.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 146
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.ActionLicense.enabled",
"type": "boolean",
"tags": [],
"label": "enabled",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 147
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.ActionLicense.enabledInConfig",
"type": "boolean",
"tags": [],
"label": "enabledInConfig",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 148
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.ActionLicense.enabledInLicense",
"type": "boolean",
"tags": [],
"label": "enabledInLicense",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 149
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.AllCases",
"type": "Interface",
"tags": [],
"label": "AllCases",
"description": [],
"signature": [
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AllCases",
"text": "AllCases"
},
" extends ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CasesStatus",
"text": "CasesStatus"
}
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 112
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.AllCases.cases",
"type": "Array",
"tags": [],
"label": "cases",
"description": [],
"signature": [
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.Case",
"text": "Case"
},
"[]"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 113
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.AllCases.page",
"type": "number",
"tags": [],
"label": "page",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 114
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.AllCases.perPage",
"type": "number",
"tags": [],
"label": "perPage",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 115
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.AllCases.total",
"type": "number",
"tags": [],
"label": "total",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 116
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ApiProps",
"type": "Interface",
"tags": [],
"label": "ApiProps",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 135
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.ApiProps.signal",
"type": "Object",
"tags": [],
"label": "signal",
"description": [],
"signature": [
"AbortSignal"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 136
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.BulkUpdateStatus",
"type": "Interface",
"tags": [],
"label": "BulkUpdateStatus",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 139
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.BulkUpdateStatus.status",
"type": "string",
"tags": [],
"label": "status",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 140
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.BulkUpdateStatus.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 141
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.BulkUpdateStatus.version",
"type": "string",
"tags": [],
"label": "version",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 142
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.Case",
"type": "Interface",
"tags": [],
"label": "Case",
"description": [],
"signature": [
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.Case",
"text": "Case"
},
" extends BasicCase"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 80
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.Case.connector",
"type": "CompoundType",
"tags": [],
"label": "connector",
"description": [],
"signature": [
"({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; })"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 81
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.Case.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 82
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.Case.externalService",
"type": "CompoundType",
"tags": [],
"label": "externalService",
"description": [],
"signature": [
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseExternalService",
"text": "CaseExternalService"
},
" | null"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 83
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.Case.subCases",
"type": "CompoundType",
"tags": [],
"label": "subCases",
"description": [],
"signature": [
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.SubCase",
"text": "SubCase"
},
"[] | null | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 84
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.Case.subCaseIds",
"type": "Array",
"tags": [],
"label": "subCaseIds",
"description": [],
"signature": [
"string[]"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 85
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.Case.settings",
"type": "Object",
"tags": [],
"label": "settings",
"description": [],
"signature": [
"{ syncAlerts: boolean; }"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 86
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.Case.tags",
"type": "Array",
"tags": [],
"label": "tags",
"description": [],
"signature": [
"string[]"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 87
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.Case.type",
"type": "Enum",
"tags": [],
"label": "type",
"description": [],
"signature": [
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
}
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 88
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseExternalService",
"type": "Interface",
"tags": [],
"label": "CaseExternalService",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 49
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.CaseExternalService.pushedAt",
"type": "string",
"tags": [],
"label": "pushedAt",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 50
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseExternalService.pushedBy",
"type": "Object",
"tags": [],
"label": "pushedBy",
"description": [],
"signature": [
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ElasticUser",
"text": "ElasticUser"
}
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 51
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseExternalService.connectorId",
"type": "string",
"tags": [],
"label": "connectorId",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 52
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseExternalService.connectorName",
"type": "string",
"tags": [],
"label": "connectorName",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 53
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseExternalService.externalId",
"type": "string",
"tags": [],
"label": "externalId",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 54
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseExternalService.externalTitle",
"type": "string",
"tags": [],
"label": "externalTitle",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 55
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseExternalService.externalUrl",
"type": "string",
"tags": [],
"label": "externalUrl",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 56
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesStatus",
"type": "Interface",
"tags": [],
"label": "CasesStatus",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 106
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.CasesStatus.countClosedCases",
"type": "CompoundType",
"tags": [],
"label": "countClosedCases",
"description": [],
"signature": [
"number | null"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 107
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesStatus.countOpenCases",
"type": "CompoundType",
"tags": [],
"label": "countOpenCases",
"description": [],
"signature": [
"number | null"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 108
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesStatus.countInProgressCases",
"type": "CompoundType",
"tags": [],
"label": "countInProgressCases",
"description": [],
"signature": [
"number | null"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 109
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseUserActions",
"type": "Interface",
"tags": [],
"label": "CaseUserActions",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 37
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.CaseUserActions.actionId",
"type": "string",
"tags": [],
"label": "actionId",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 38
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseUserActions.actionField",
"type": "Array",
"tags": [],
"label": "actionField",
"description": [],
"signature": [
"(\"status\" | \"description\" | \"title\" | \"comment\" | \"tags\" | \"settings\" | \"connector\" | \"pushed\" | \"sub_case\")[]"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 39
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseUserActions.action",
"type": "CompoundType",
"tags": [],
"label": "action",
"description": [],
"signature": [
"\"add\" | \"delete\" | \"create\" | \"update\" | \"push-to-service\""
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 40
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseUserActions.actionAt",
"type": "string",
"tags": [],
"label": "actionAt",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 41
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseUserActions.actionBy",
"type": "Object",
"tags": [],
"label": "actionBy",
"description": [],
"signature": [
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ElasticUser",
"text": "ElasticUser"
}
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 42
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseUserActions.caseId",
"type": "string",
"tags": [],
"label": "caseId",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 43
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseUserActions.commentId",
"type": "CompoundType",
"tags": [],
"label": "commentId",
"description": [],
"signature": [
"string | null"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 44
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseUserActions.newValue",
"type": "CompoundType",
"tags": [],
"label": "newValue",
"description": [],
"signature": [
"string | null"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 45
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseUserActions.oldValue",
"type": "CompoundType",
"tags": [],
"label": "oldValue",
"description": [],
"signature": [
"string | null"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 46
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.DeleteCase",
"type": "Interface",
"tags": [],
"label": "DeleteCase",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 152
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.DeleteCase.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 153
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.DeleteCase.type",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
" | null"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 154
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.DeleteCase.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 155
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.Ecs",
"type": "Interface",
"tags": [],
"label": "Ecs",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 225
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.Ecs._id",
"type": "string",
"tags": [],
"label": "_id",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 226
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.Ecs._index",
"type": "string",
"tags": [],
"label": "_index",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 227
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.Ecs.signal",
"type": "Object",
"tags": [],
"label": "signal",
"description": [],
"signature": [
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.SignalEcs",
"text": "SignalEcs"
},
" | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 228
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ElasticUser",
"type": "Interface",
"tags": [],
"label": "ElasticUser",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 124
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.ElasticUser.email",
"type": "CompoundType",
"tags": [],
"label": "email",
"description": [],
"signature": [
"string | null | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 125
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.ElasticUser.fullName",
"type": "CompoundType",
"tags": [],
"label": "fullName",
"description": [],
"signature": [
"string | null | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 126
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.ElasticUser.username",
"type": "CompoundType",
"tags": [],
"label": "username",
"description": [],
"signature": [
"string | null | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 127
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ESCaseConnector",
"type": "Interface",
"tags": [],
"label": "ESCaseConnector",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/api/connectors/index.ts",
"lineNumber": 100
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.ESCaseConnector.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/api/connectors/index.ts",
"lineNumber": 101
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.ESCaseConnector.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/api/connectors/index.ts",
"lineNumber": 102
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.ESCaseConnector.type",
"type": "Enum",
"tags": [],
"label": "type",
"description": [],
"signature": [
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
}
],
"source": {
"path": "x-pack/plugins/cases/common/api/connectors/index.ts",
"lineNumber": 103
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.ESCaseConnector.fields",
"type": "CompoundType",
"tags": [],
"label": "fields",
"description": [],
"signature": [
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ESConnectorFields",
"text": "ESConnectorFields"
},
" | null"
],
"source": {
"path": "x-pack/plugins/cases/common/api/connectors/index.ts",
"lineNumber": 104
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.FetchCasesProps",
"type": "Interface",
"tags": [],
"label": "FetchCasesProps",
"description": [],
"signature": [
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.FetchCasesProps",
"text": "FetchCasesProps"
},
" extends ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ApiProps",
"text": "ApiProps"
}
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 130
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.FetchCasesProps.queryParams",
"type": "Object",
"tags": [],
"label": "queryParams",
"description": [],
"signature": [
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.QueryParams",
"text": "QueryParams"
},
" | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 131
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.FetchCasesProps.filterOptions",
"type": "Object",
"tags": [],
"label": "filterOptions",
"description": [],
"signature": [
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.FilterOptions",
"text": "FilterOptions"
},
" | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 132
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.FieldMappings",
"type": "Interface",
"tags": [],
"label": "FieldMappings",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 158
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.FieldMappings.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 159
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.FieldMappings.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 160
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.FilterOptions",
"type": "Interface",
"tags": [],
"label": "FilterOptions",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 98
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.FilterOptions.search",
"type": "string",
"tags": [],
"label": "search",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 99
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.FilterOptions.status",
"type": "CompoundType",
"tags": [],
"label": "status",
"description": [],
"signature": [
"\"all\" | ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
}
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 100
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.FilterOptions.tags",
"type": "Array",
"tags": [],
"label": "tags",
"description": [],
"signature": [
"string[]"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 101
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.FilterOptions.reporters",
"type": "Array",
"tags": [],
"label": "reporters",
"description": [],
"signature": [
"{ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }[]"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 102
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.FilterOptions.onlyCollectionType",
"type": "CompoundType",
"tags": [],
"label": "onlyCollectionType",
"description": [],
"signature": [
"boolean | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 103
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.QueryParams",
"type": "Interface",
"tags": [],
"label": "QueryParams",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 91
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.QueryParams.page",
"type": "number",
"tags": [],
"label": "page",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 92
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.QueryParams.perPage",
"type": "number",
"tags": [],
"label": "perPage",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 93
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.QueryParams.sortField",
"type": "Enum",
"tags": [],
"label": "sortField",
"description": [],
"signature": [
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.SortFieldCase",
"text": "SortFieldCase"
}
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 94
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.QueryParams.sortOrder",
"type": "CompoundType",
"tags": [],
"label": "sortOrder",
"description": [],
"signature": [
"\"asc\" | \"desc\""
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 95
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.RuleEcs",
"type": "Interface",
"tags": [],
"label": "RuleEcs",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 178
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.RuleEcs.id",
"type": "Array",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string[] | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 179
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.RuleEcs.rule_id",
"type": "Array",
"tags": [],
"label": "rule_id",
"description": [],
"signature": [
"string[] | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 180
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.RuleEcs.name",
"type": "Array",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string[] | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 181
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.RuleEcs.false_positives",
"type": "Array",
"tags": [],
"label": "false_positives",
"description": [],
"signature": [
"string[]"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 182
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.RuleEcs.saved_id",
"type": "Array",
"tags": [],
"label": "saved_id",
"description": [],
"signature": [
"string[] | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 183
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.RuleEcs.timeline_id",
"type": "Array",
"tags": [],
"label": "timeline_id",
"description": [],
"signature": [
"string[] | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 184
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.RuleEcs.timeline_title",
"type": "Array",
"tags": [],
"label": "timeline_title",
"description": [],
"signature": [
"string[] | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 185
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.RuleEcs.max_signals",
"type": "Array",
"tags": [],
"label": "max_signals",
"description": [],
"signature": [
"number[] | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 186
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.RuleEcs.risk_score",
"type": "Array",
"tags": [],
"label": "risk_score",
"description": [],
"signature": [
"string[] | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 187
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.RuleEcs.output_index",
"type": "Array",
"tags": [],
"label": "output_index",
"description": [],
"signature": [
"string[] | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 188
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.RuleEcs.description",
"type": "Array",
"tags": [],
"label": "description",
"description": [],
"signature": [
"string[] | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 189
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.RuleEcs.from",
"type": "Array",
"tags": [],
"label": "from",
"description": [],
"signature": [
"string[] | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 190
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.RuleEcs.immutable",
"type": "Array",
"tags": [],
"label": "immutable",
"description": [],
"signature": [
"boolean[] | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 191
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.RuleEcs.index",
"type": "Array",
"tags": [],
"label": "index",
"description": [],
"signature": [
"string[] | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 192
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.RuleEcs.interval",
"type": "Array",
"tags": [],
"label": "interval",
"description": [],
"signature": [
"string[] | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 193
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.RuleEcs.language",
"type": "Array",
"tags": [],
"label": "language",
"description": [],
"signature": [
"string[] | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 194
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.RuleEcs.query",
"type": "Array",
"tags": [],
"label": "query",
"description": [],
"signature": [
"string[] | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 195
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.RuleEcs.references",
"type": "Array",
"tags": [],
"label": "references",
"description": [],
"signature": [
"string[] | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 196
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.RuleEcs.severity",
"type": "Array",
"tags": [],
"label": "severity",
"description": [],
"signature": [
"string[] | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 197
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.RuleEcs.tags",
"type": "Array",
"tags": [],
"label": "tags",
"description": [],
"signature": [
"string[] | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 198
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.RuleEcs.threat",
"type": "Unknown",
"tags": [],
"label": "threat",
"description": [],
"signature": [
"unknown"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 199
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.RuleEcs.threshold",
"type": "Unknown",
"tags": [],
"label": "threshold",
"description": [],
"signature": [
"unknown"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 200
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.RuleEcs.type",
"type": "Array",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string[] | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 201
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.RuleEcs.size",
"type": "Array",
"tags": [],
"label": "size",
"description": [],
"signature": [
"string[] | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 202
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.RuleEcs.to",
"type": "Array",
"tags": [],
"label": "to",
"description": [],
"signature": [
"string[] | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 203
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.RuleEcs.enabled",
"type": "Array",
"tags": [],
"label": "enabled",
"description": [],
"signature": [
"boolean[] | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 204
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.RuleEcs.filters",
"type": "Unknown",
"tags": [],
"label": "filters",
"description": [],
"signature": [
"unknown"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 205
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.RuleEcs.created_at",
"type": "Array",
"tags": [],
"label": "created_at",
"description": [],
"signature": [
"string[] | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 206
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.RuleEcs.updated_at",
"type": "Array",
"tags": [],
"label": "updated_at",
"description": [],
"signature": [
"string[] | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 207
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.RuleEcs.created_by",
"type": "Array",
"tags": [],
"label": "created_by",
"description": [],
"signature": [
"string[] | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 208
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.RuleEcs.updated_by",
"type": "Array",
"tags": [],
"label": "updated_by",
"description": [],
"signature": [
"string[] | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 209
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.RuleEcs.version",
"type": "Array",
"tags": [],
"label": "version",
"description": [],
"signature": [
"string[] | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 210
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.RuleEcs.note",
"type": "Array",
"tags": [],
"label": "note",
"description": [],
"signature": [
"string[] | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 211
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.RuleEcs.building_block_type",
"type": "Array",
"tags": [],
"label": "building_block_type",
"description": [],
"signature": [
"string[] | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 212
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.SignalEcs",
"type": "Interface",
"tags": [],
"label": "SignalEcs",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 215
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.SignalEcs.rule",
"type": "Object",
"tags": [],
"label": "rule",
"description": [],
"signature": [
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.RuleEcs",
"text": "RuleEcs"
},
" | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 216
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.SignalEcs.original_time",
"type": "Array",
"tags": [],
"label": "original_time",
"description": [],
"signature": [
"string[] | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 217
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.SignalEcs.status",
"type": "Array",
"tags": [],
"label": "status",
"description": [],
"signature": [
"string[] | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 218
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.SignalEcs.group",
"type": "Object",
"tags": [],
"label": "group",
"description": [],
"signature": [
"{ id?: string[] | undefined; } | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 219
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.SignalEcs.threshold_result",
"type": "Unknown",
"tags": [],
"label": "threshold_result",
"description": [],
"signature": [
"unknown"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 222
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.SubCase",
"type": "Interface",
"tags": [],
"label": "SubCase",
"description": [],
"signature": [
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.SubCase",
"text": "SubCase"
},
" extends BasicCase"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 75
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.SubCase.associationType",
"type": "Enum",
"tags": [],
"label": "associationType",
"description": [],
"signature": [
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
}
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 76
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.SubCase.caseParentId",
"type": "string",
"tags": [],
"label": "caseParentId",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 77
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.UpdateByKey",
"type": "Interface",
"tags": [],
"label": "UpdateByKey",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 168
},
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.UpdateByKey.updateKey",
"type": "CompoundType",
"tags": [],
"label": "updateKey",
"description": [],
"signature": [
"\"status\" | \"description\" | \"title\" | \"tags\" | \"settings\" | \"connector\""
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 169
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.UpdateByKey.updateValue",
"type": "CompoundType",
"tags": [],
"label": "updateValue",
"description": [],
"signature": [
"string | string[] | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; }) | { syncAlerts: boolean; } | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 170
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.UpdateByKey.fetchCaseUserActions",
"type": "Function",
"tags": [],
"label": "fetchCaseUserActions",
"description": [],
"signature": [
"((caseId: string, caseConnectorId: string, subCaseId?: string | undefined) => void) | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 171
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.UpdateByKey.updateCase",
"type": "Function",
"tags": [],
"label": "updateCase",
"description": [],
"signature": [
"((newCase: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.Case",
"text": "Case"
},
") => void) | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 172
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.UpdateByKey.caseData",
"type": "Object",
"tags": [],
"label": "caseData",
"description": [],
"signature": [
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.Case",
"text": "Case"
}
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 173
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.UpdateByKey.onSuccess",
"type": "Function",
"tags": [],
"label": "onSuccess",
"description": [],
"signature": [
"(() => void) | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 174
},
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.UpdateByKey.onError",
"type": "Function",
"tags": [],
"label": "onError",
"description": [],
"signature": [
"(() => void) | undefined"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 175
},
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [
{
"parentPluginId": "cases",
"id": "def-common.AssociationType",
"type": "Enum",
"tags": [],
"label": "AssociationType",
"description": [
"\nthis is used to differentiate between an alert attached to a top-level case and a group of alerts that should only\nbe attached to a sub case. The reason we need this is because an alert group comment will have references to both a case and\nsub case when it is created. For us to be able to filter out alert groups in a top-level case we need a field to\nuse as a filter."
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/comment.ts",
"lineNumber": 33
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseStatuses",
"type": "Enum",
"tags": [],
"label": "CaseStatuses",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/status.ts",
"lineNumber": 10
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseType",
"type": "Enum",
"tags": [],
"label": "CaseType",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/case.ts",
"lineNumber": 17
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CommentType",
"type": "Enum",
"tags": [],
"label": "CommentType",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/comment.ts",
"lineNumber": 51
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ConnectorTypes",
"type": "Enum",
"tags": [],
"label": "ConnectorTypes",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/api/connectors/index.ts",
"lineNumber": 33
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.SortFieldCase",
"type": "Enum",
"tags": [],
"label": "SortFieldCase",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 119
},
"deprecated": false,
"initialIsOpen": false
}
],
"misc": [
{
"parentPluginId": "cases",
"id": "def-common.ACTION_TYPES_URL",
"type": "string",
"tags": [],
"label": "ACTION_TYPES_URL",
"description": [],
"signature": [
"\"/api/actions/list_action_types\""
],
"source": {
"path": "x-pack/plugins/cases/common/constants.ts",
"lineNumber": 41
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ACTION_URL",
"type": "string",
"tags": [],
"label": "ACTION_URL",
"description": [
"\nAction routes"
],
"signature": [
"\"/api/actions\""
],
"source": {
"path": "x-pack/plugins/cases/common/constants.ts",
"lineNumber": 40
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ActionConnector",
"type": "Type",
"tags": [],
"label": "ActionConnector",
"description": [],
"signature": [
{
"pluginId": "actions",
"scope": "common",
"docId": "kibActionsPluginApi",
"section": "def-common.ActionResult",
"text": "ActionResult"
}
],
"source": {
"path": "x-pack/plugins/cases/common/api/connectors/index.ts",
"lineNumber": 22
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ActionType",
"type": "Type",
"tags": [],
"label": "ActionType",
"description": [],
"signature": [
"\"append\" | \"overwrite\" | \"nothing\""
],
"source": {
"path": "x-pack/plugins/cases/common/api/connectors/mappings.ts",
"lineNumber": 22
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ActionTypeConnector",
"type": "Type",
"tags": [],
"label": "ActionTypeConnector",
"description": [],
"signature": [
{
"pluginId": "actions",
"scope": "common",
"docId": "kibActionsPluginApi",
"section": "def-common.ActionType",
"text": "ActionType"
}
],
"source": {
"path": "x-pack/plugins/cases/common/api/connectors/index.ts",
"lineNumber": 23
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.AllCommentsResponse",
"type": "Type",
"tags": [],
"label": "AllCommentsResponse",
"description": [],
"signature": [
"(({ comment: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert | ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }))[]"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/comment.ts",
"lineNumber": 135
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.APP_ID",
"type": "string",
"tags": [],
"label": "APP_ID",
"description": [],
"signature": [
"\"cases\""
],
"source": {
"path": "x-pack/plugins/cases/common/constants.ts",
"lineNumber": 10
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.AttributesTypeAlerts",
"type": "Type",
"tags": [],
"label": "AttributesTypeAlerts",
"description": [],
"signature": [
"{ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert | ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/comment.ts",
"lineNumber": 130
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CASE_ALERTS_URL",
"type": "string",
"tags": [],
"label": "CASE_ALERTS_URL",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/constants.ts",
"lineNumber": 34
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CASE_COMMENT_DETAILS_URL",
"type": "string",
"tags": [],
"label": "CASE_COMMENT_DETAILS_URL",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/constants.ts",
"lineNumber": 27
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CASE_COMMENTS_URL",
"type": "string",
"tags": [],
"label": "CASE_COMMENTS_URL",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/constants.ts",
"lineNumber": 26
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CASE_CONFIGURE_CONNECTORS_URL",
"type": "string",
"tags": [],
"label": "CASE_CONFIGURE_CONNECTORS_URL",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/constants.ts",
"lineNumber": 19
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CASE_CONFIGURE_URL",
"type": "string",
"tags": [],
"label": "CASE_CONFIGURE_URL",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/constants.ts",
"lineNumber": 18
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CASE_DETAILS_URL",
"type": "string",
"tags": [],
"label": "CASE_DETAILS_URL",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/constants.ts",
"lineNumber": 17
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CASE_PUSH_URL",
"type": "string",
"tags": [],
"label": "CASE_PUSH_URL",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/constants.ts",
"lineNumber": 28
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CASE_REPORTERS_URL",
"type": "string",
"tags": [],
"label": "CASE_REPORTERS_URL",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/constants.ts",
"lineNumber": 29
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CASE_STATUS_URL",
"type": "string",
"tags": [],
"label": "CASE_STATUS_URL",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/constants.ts",
"lineNumber": 30
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CASE_TAGS_URL",
"type": "string",
"tags": [],
"label": "CASE_TAGS_URL",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/constants.ts",
"lineNumber": 31
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CASE_USER_ACTIONS_URL",
"type": "string",
"tags": [],
"label": "CASE_USER_ACTIONS_URL",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/constants.ts",
"lineNumber": 32
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseAttributes",
"type": "Type",
"tags": [],
"label": "CaseAttributes",
"description": [],
"signature": [
"{ description: string; status: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"; tags: string[]; title: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
"; connector: ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; }); settings: { syncAlerts: boolean; }; } & { closed_at: string | null; closed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; external_service: ({ connector_id: string; connector_name: string; external_id: string; external_title: string; external_url: string; } & { pushed_at: string; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; }) | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/case.ts",
"lineNumber": 175
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseConnector",
"type": "Type",
"tags": [],
"label": "CaseConnector",
"description": [],
"signature": [
"({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; })"
],
"source": {
"path": "x-pack/plugins/cases/common/api/connectors/index.ts",
"lineNumber": 82
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseField",
"type": "Type",
"tags": [],
"label": "CaseField",
"description": [],
"signature": [
"\"description\" | \"title\" | \"comments\""
],
"source": {
"path": "x-pack/plugins/cases/common/api/connectors/mappings.ts",
"lineNumber": 23
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseFullExternalService",
"type": "Type",
"tags": [],
"label": "CaseFullExternalService",
"description": [],
"signature": [
"({ connector_id: string; connector_name: string; external_id: string; external_title: string; external_url: string; } & { pushed_at: string; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; }) | null"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/case.ts",
"lineNumber": 189
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasePatchRequest",
"type": "Type",
"tags": [],
"label": "CasePatchRequest",
"description": [],
"signature": [
"{ description?: string | undefined; status?: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
" | undefined; tags?: string[] | undefined; title?: string | undefined; type?: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
" | undefined; connector?: ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; }) | undefined; settings?: { syncAlerts: boolean; } | undefined; } & { id: string; version: string; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/case.ts",
"lineNumber": 187
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasePostRequest",
"type": "Type",
"tags": [],
"label": "CasePostRequest",
"description": [],
"signature": [
"{ type?: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
" | undefined; } & { description: string; tags: string[]; title: string; connector: ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; }); settings: { syncAlerts: boolean; }; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/case.ts",
"lineNumber": 182
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseResponse",
"type": "Type",
"tags": [],
"label": "CaseResponse",
"description": [],
"signature": [
"{ description: string; status: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"; tags: string[]; title: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
"; connector: ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; }); settings: { syncAlerts: boolean; }; } & { closed_at: string | null; closed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; external_service: ({ connector_id: string; connector_name: string; external_id: string; external_title: string; external_url: string; } & { pushed_at: string; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; }) | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; totalComment: number; totalAlerts: number; version: string; } & { subCaseIds?: string[] | undefined; subCases?: ({ status: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"; } & { closed_at: string | null; closed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; totalComment: number; totalAlerts: number; version: string; } & { comments?: (({ comment: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert | ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }))[] | undefined; })[] | undefined; comments?: (({ comment: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert | ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }))[] | undefined; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/case.ts",
"lineNumber": 183
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CASES_URL",
"type": "string",
"tags": [],
"label": "CASES_URL",
"description": [
"\nCase routes"
],
"signature": [
"\"/api/cases\""
],
"source": {
"path": "x-pack/plugins/cases/common/constants.ts",
"lineNumber": 16
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesClientPostRequest",
"type": "Type",
"tags": [],
"label": "CasesClientPostRequest",
"description": [
"\nThis field differs from the CasePostRequest in that the post request's type field can be optional. This type requires\nthat the type field be defined. The CasePostRequest should be used in most places (the UI etc). This type is really\nonly necessary for validation."
],
"signature": [
"{ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
"; description: string; tags: string[]; title: string; connector: ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; }); settings: { syncAlerts: boolean; }; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/case.ts",
"lineNumber": 181
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesConfigure",
"type": "Type",
"tags": [],
"label": "CasesConfigure",
"description": [],
"signature": [
"{ connector: ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; }); closure_type: \"close-by-user\" | \"close-by-pushing\"; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/configure.ts",
"lineNumber": 47
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesConfigureAttributes",
"type": "Type",
"tags": [],
"label": "CasesConfigureAttributes",
"description": [],
"signature": [
"{ connector: ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; }); closure_type: \"close-by-user\" | \"close-by-pushing\"; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/configure.ts",
"lineNumber": 50
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesConfigurePatch",
"type": "Type",
"tags": [],
"label": "CasesConfigurePatch",
"description": [],
"signature": [
"{ connector?: ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; }) | undefined; closure_type?: \"close-by-user\" | \"close-by-pushing\" | undefined; } & { version: string; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/configure.ts",
"lineNumber": 49
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesConfigureRequest",
"type": "Type",
"tags": [],
"label": "CasesConfigureRequest",
"description": [],
"signature": [
"{ connector: ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; }); closure_type: \"close-by-user\" | \"close-by-pushing\"; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/configure.ts",
"lineNumber": 48
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesConfigureResponse",
"type": "Type",
"tags": [],
"label": "CasesConfigureResponse",
"description": [],
"signature": [
"{ connector: ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; }); closure_type: \"close-by-user\" | \"close-by-pushing\"; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { mappings: { action_type: \"append\" | \"overwrite\" | \"nothing\"; source: \"description\" | \"title\" | \"comments\"; target: string; }[]; } & { version: string; error: string | null; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/configure.ts",
"lineNumber": 51
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseSettings",
"type": "Type",
"tags": [],
"label": "CaseSettings",
"description": [],
"signature": [
"{ syncAlerts: boolean; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/case.ts",
"lineNumber": 190
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesFindRequest",
"type": "Type",
"tags": [],
"label": "CasesFindRequest",
"description": [],
"signature": [
"{ type?: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
" | undefined; tags?: string | string[] | undefined; status?: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
" | undefined; reporters?: string | string[] | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; fields?: string[] | undefined; page?: number | undefined; perPage?: number | undefined; search?: string | undefined; searchFields?: string[] | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/case.ts",
"lineNumber": 185
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesFindResponse",
"type": "Type",
"tags": [],
"label": "CasesFindResponse",
"description": [],
"signature": [
"{ cases: ({ description: string; status: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"; tags: string[]; title: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
"; connector: ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; }); settings: { syncAlerts: boolean; }; } & { closed_at: string | null; closed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; external_service: ({ connector_id: string; connector_name: string; external_id: string; external_title: string; external_url: string; } & { pushed_at: string; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; }) | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; totalComment: number; totalAlerts: number; version: string; } & { subCaseIds?: string[] | undefined; subCases?: ({ status: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"; } & { closed_at: string | null; closed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; totalComment: number; totalAlerts: number; version: string; } & { comments?: (({ comment: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert | ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }))[] | undefined; })[] | undefined; comments?: (({ comment: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert | ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }))[] | undefined; })[]; page: number; per_page: number; total: number; } & { count_open_cases: number; count_in_progress_cases: number; count_closed_cases: number; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/case.ts",
"lineNumber": 186
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesPatchRequest",
"type": "Type",
"tags": [],
"label": "CasesPatchRequest",
"description": [],
"signature": [
"{ cases: ({ description?: string | undefined; status?: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
" | undefined; tags?: string[] | undefined; title?: string | undefined; type?: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
" | undefined; connector?: ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; }) | undefined; settings?: { syncAlerts: boolean; } | undefined; } & { id: string; version: string; })[]; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/case.ts",
"lineNumber": 188
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesResponse",
"type": "Type",
"tags": [],
"label": "CasesResponse",
"description": [],
"signature": [
"({ description: string; status: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"; tags: string[]; title: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
"; connector: ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; }); settings: { syncAlerts: boolean; }; } & { closed_at: string | null; closed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; external_service: ({ connector_id: string; connector_name: string; external_id: string; external_title: string; external_url: string; } & { pushed_at: string; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; }) | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; totalComment: number; totalAlerts: number; version: string; } & { subCaseIds?: string[] | undefined; subCases?: ({ status: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"; } & { closed_at: string | null; closed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; totalComment: number; totalAlerts: number; version: string; } & { comments?: (({ comment: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert | ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }))[] | undefined; })[] | undefined; comments?: (({ comment: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert | ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }))[] | undefined; })[]"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/case.ts",
"lineNumber": 184
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesStatusResponse",
"type": "Type",
"tags": [],
"label": "CasesStatusResponse",
"description": [],
"signature": [
"{ count_open_cases: number; count_in_progress_cases: number; count_closed_cases: number; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/status.ts",
"lineNumber": 30
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.caseStatuses",
"type": "Array",
"tags": [],
"label": "caseStatuses",
"description": [],
"signature": [
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"[]"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/status.ts",
"lineNumber": 22
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseStatusWithAllStatus",
"type": "Type",
"tags": [],
"label": "CaseStatusWithAllStatus",
"description": [],
"signature": [
"\"all\" | ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
}
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 24
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.caseTypeField",
"type": "string",
"tags": [],
"label": "caseTypeField",
"description": [
"\nExposing the field used to define the case type so that it can be used for filtering in saved object find queries."
],
"signature": [
"\"type\""
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/case.ts",
"lineNumber": 25
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseUserActionAttributes",
"type": "Type",
"tags": [],
"label": "CaseUserActionAttributes",
"description": [],
"signature": [
"{ action_field: (\"status\" | \"description\" | \"title\" | \"comment\" | \"tags\" | \"settings\" | \"connector\" | \"pushed\" | \"sub_case\")[]; action: \"add\" | \"delete\" | \"create\" | \"update\" | \"push-to-service\"; action_at: string; action_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; new_value: string | null; old_value: string | null; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/user_actions.ts",
"lineNumber": 59
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseUserActionsResponse",
"type": "Type",
"tags": [],
"label": "CaseUserActionsResponse",
"description": [],
"signature": [
"({ action_field: (\"status\" | \"description\" | \"title\" | \"comment\" | \"tags\" | \"settings\" | \"connector\" | \"pushed\" | \"sub_case\")[]; action: \"add\" | \"delete\" | \"create\" | \"update\" | \"push-to-service\"; action_at: string; action_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; new_value: string | null; old_value: string | null; } & { action_id: string; case_id: string; comment_id: string | null; } & { sub_case_id?: string | undefined; })[]"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/user_actions.ts",
"lineNumber": 60
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ClosureType",
"type": "Type",
"tags": [],
"label": "ClosureType",
"description": [],
"signature": [
"\"close-by-user\" | \"close-by-pushing\""
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/configure.ts",
"lineNumber": 46
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.Comment",
"type": "Type",
"tags": [],
"label": "Comment",
"description": [],
"signature": [
"({ comment: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; id: string; createdAt: string; createdBy: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ElasticUser",
"text": "ElasticUser"
},
"; pushedAt: string | null; pushedBy: string | null; updatedAt: string | null; updatedBy: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ElasticUser",
"text": "ElasticUser"
},
" | null; version: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert | ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; id: string; createdAt: string; createdBy: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ElasticUser",
"text": "ElasticUser"
},
"; pushedAt: string | null; pushedBy: string | null; updatedAt: string | null; updatedBy: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ElasticUser",
"text": "ElasticUser"
},
" | null; version: string; })"
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 26
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CommentAttributes",
"type": "Type",
"tags": [],
"label": "CommentAttributes",
"description": [],
"signature": [
"({ comment: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert | ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; })"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/comment.ts",
"lineNumber": 131
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CommentPatchAttributes",
"type": "Type",
"tags": [],
"label": "CommentPatchAttributes",
"description": [],
"signature": [
"{ associationType?: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
" | undefined; created_at?: string | undefined; created_by?: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | undefined; pushed_at?: string | null | undefined; pushed_by?: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null | undefined; updated_at?: string | null | undefined; updated_by?: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null | undefined; } | ({ type?: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert | ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert | undefined; alertId?: string | string[] | undefined; index?: string | string[] | undefined; rule?: { id: string | null; name: string | null; } | undefined; } & { associationType?: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
" | undefined; created_at?: string | undefined; created_by?: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | undefined; pushed_at?: string | null | undefined; pushed_by?: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null | undefined; updated_at?: string | null | undefined; updated_by?: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null | undefined; })"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/comment.ts",
"lineNumber": 138
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CommentPatchRequest",
"type": "Type",
"tags": [],
"label": "CommentPatchRequest",
"description": [],
"signature": [
"({ comment: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user; } & { id: string; version: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert | ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; } & { id: string; version: string; })"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/comment.ts",
"lineNumber": 137
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CommentRequest",
"type": "Type",
"tags": [],
"label": "CommentRequest",
"description": [],
"signature": [
"{ comment: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user; } | { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert | ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/comment.ts",
"lineNumber": 132
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CommentRequestAlertType",
"type": "Type",
"tags": [],
"label": "CommentRequestAlertType",
"description": [],
"signature": [
"{ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert | ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/comment.ts",
"lineNumber": 140
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CommentRequestUserType",
"type": "Type",
"tags": [],
"label": "CommentRequestUserType",
"description": [],
"signature": [
"{ comment: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/comment.ts",
"lineNumber": 139
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CommentResponse",
"type": "Type",
"tags": [],
"label": "CommentResponse",
"description": [],
"signature": [
"({ comment: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert | ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; })"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/comment.ts",
"lineNumber": 133
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CommentResponseAlertsType",
"type": "Type",
"tags": [],
"label": "CommentResponseAlertsType",
"description": [],
"signature": [
"{ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert | ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/comment.ts",
"lineNumber": 134
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CommentsResponse",
"type": "Type",
"tags": [],
"label": "CommentsResponse",
"description": [],
"signature": [
"{ comments: (({ comment: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert | ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }))[]; page: number; per_page: number; total: number; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/comment.ts",
"lineNumber": 136
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ConnectorField",
"type": "Type",
"tags": [],
"label": "ConnectorField",
"description": [],
"signature": [
"{ id: string; name: string; required: boolean; type: \"text\" | \"textarea\"; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/connectors/mappings.ts",
"lineNumber": 48
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ConnectorFields",
"type": "Type",
"tags": [],
"label": "ConnectorFields",
"description": [],
"signature": [
"{ issueType: string | null; priority: string | null; parent: string | null; } | { incidentTypes: string[] | null; severityCode: string | null; } | { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null"
],
"source": {
"path": "x-pack/plugins/cases/common/api/connectors/index.ts",
"lineNumber": 92
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ConnectorJiraTypeFields",
"type": "Type",
"tags": [],
"label": "ConnectorJiraTypeFields",
"description": [],
"signature": [
"{ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/connectors/index.ts",
"lineNumber": 84
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ConnectorMappings",
"type": "Type",
"tags": [],
"label": "ConnectorMappings",
"description": [],
"signature": [
"{ mappings: { action_type: \"append\" | \"overwrite\" | \"nothing\"; source: \"description\" | \"title\" | \"comments\"; target: string; }[]; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/connectors/mappings.ts",
"lineNumber": 37
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ConnectorMappingsAttributes",
"type": "Type",
"tags": [],
"label": "ConnectorMappingsAttributes",
"description": [],
"signature": [
"{ action_type: \"append\" | \"overwrite\" | \"nothing\"; source: \"description\" | \"title\" | \"comments\"; target: string; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/connectors/mappings.ts",
"lineNumber": 36
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ConnectorResillientTypeFields",
"type": "Type",
"tags": [],
"label": "ConnectorResillientTypeFields",
"description": [],
"signature": [
"{ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/connectors/index.ts",
"lineNumber": 85
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ConnectorServiceNowITSMTypeFields",
"type": "Type",
"tags": [],
"label": "ConnectorServiceNowITSMTypeFields",
"description": [],
"signature": [
"{ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/connectors/index.ts",
"lineNumber": 86
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ConnectorServiceNowSIRTypeFields",
"type": "Type",
"tags": [],
"label": "ConnectorServiceNowSIRTypeFields",
"description": [],
"signature": [
"{ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/connectors/index.ts",
"lineNumber": 89
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ConnectorTypeFields",
"type": "Type",
"tags": [],
"label": "ConnectorTypeFields",
"description": [],
"signature": [
"{ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; } | { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; } | { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; } | { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; } | { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/connectors/index.ts",
"lineNumber": 83
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.DEFAULT_DATE_FORMAT",
"type": "string",
"tags": [],
"label": "DEFAULT_DATE_FORMAT",
"description": [],
"signature": [
"\"dateFormat\""
],
"source": {
"path": "x-pack/plugins/cases/common/constants.ts",
"lineNumber": 7
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.DEFAULT_DATE_FORMAT_TZ",
"type": "string",
"tags": [],
"label": "DEFAULT_DATE_FORMAT_TZ",
"description": [],
"signature": [
"\"dateFormat:tz\""
],
"source": {
"path": "x-pack/plugins/cases/common/constants.ts",
"lineNumber": 8
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ENABLE_CASE_CONNECTOR",
"type": "boolean",
"tags": [],
"label": "ENABLE_CASE_CONNECTOR",
"description": [
"\nThis flag governs enabling the case as a connector feature. It is disabled by default as the feature is not complete."
],
"signature": [
"false"
],
"source": {
"path": "x-pack/plugins/cases/common/constants.ts",
"lineNumber": 63
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ESCaseAttributes",
"type": "Type",
"tags": [],
"label": "ESCaseAttributes",
"description": [],
"signature": [
"Pick<{ description: string; status: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"; tags: string[]; title: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
"; connector: ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; }); settings: { syncAlerts: boolean; }; } & { closed_at: string | null; closed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; external_service: ({ connector_id: string; connector_name: string; external_id: string; external_title: string; external_url: string; } & { pushed_at: string; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; }) | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; }, \"type\" | \"status\" | \"description\" | \"title\" | \"updated_at\" | \"tags\" | \"settings\" | \"created_at\" | \"created_by\" | \"updated_by\" | \"closed_at\" | \"closed_by\" | \"external_service\"> & { connector: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ESCaseConnector",
"text": "ESCaseConnector"
},
"; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/case.ts",
"lineNumber": 193
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ESCaseConnectorTypes",
"type": "Type",
"tags": [],
"label": "ESCaseConnectorTypes",
"description": [],
"signature": [
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
}
],
"source": {
"path": "x-pack/plugins/cases/common/api/connectors/index.ts",
"lineNumber": 99
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ESCasePatchRequest",
"type": "Type",
"tags": [],
"label": "ESCasePatchRequest",
"description": [],
"signature": [
"Pick<{ description?: string | undefined; status?: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
" | undefined; tags?: string[] | undefined; title?: string | undefined; type?: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
" | undefined; connector?: ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; }) | undefined; settings?: { syncAlerts: boolean; } | undefined; } & { id: string; version: string; }, \"type\" | \"status\" | \"description\" | \"title\" | \"id\" | \"version\" | \"tags\" | \"settings\"> & { connector?: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ESCaseConnector",
"text": "ESCaseConnector"
},
" | undefined; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/case.ts",
"lineNumber": 194
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ESCasesConfigureAttributes",
"type": "Type",
"tags": [],
"label": "ESCasesConfigureAttributes",
"description": [],
"signature": [
"Pick<{ connector: ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; }) | ({ id: string; name: string; } & { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; }); closure_type: \"close-by-user\" | \"close-by-pushing\"; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; }, \"updated_at\" | \"created_at\" | \"created_by\" | \"updated_by\" | \"closure_type\"> & { connector: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ESCaseConnector",
"text": "ESCaseConnector"
},
"; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/configure.ts",
"lineNumber": 53
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ESConnectorFields",
"type": "Type",
"tags": [],
"label": "ESConnectorFields",
"description": [],
"signature": [
"{ key: string; value: unknown; }[]"
],
"source": {
"path": "x-pack/plugins/cases/common/api/connectors/index.ts",
"lineNumber": 94
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ExternalServiceResponse",
"type": "Type",
"tags": [],
"label": "ExternalServiceResponse",
"description": [],
"signature": [
"{ title: string; id: string; pushedDate: string; url: string; } & { comments?: ({ commentId: string; pushedDate: string; } & { externalCommentId?: string | undefined; })[] | undefined; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/case.ts",
"lineNumber": 191
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.GetCaseIdsByAlertIdAggs",
"type": "Type",
"tags": [],
"label": "GetCaseIdsByAlertIdAggs",
"description": [],
"signature": [
"{ references: { doc_count: number; caseIds: { buckets: { key: string; }[]; }; }; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/comment.ts",
"lineNumber": 141
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.GetFieldsResponse",
"type": "Type",
"tags": [],
"label": "GetFieldsResponse",
"description": [],
"signature": [
"{ defaultMappings: { action_type: \"append\" | \"overwrite\" | \"nothing\"; source: \"description\" | \"title\" | \"comments\"; target: string; }[]; fields: { id: string; name: string; required: boolean; type: \"text\" | \"textarea\"; }[]; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/connectors/mappings.ts",
"lineNumber": 55
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.JIRA_ACTION_TYPE_ID",
"type": "string",
"tags": [],
"label": "JIRA_ACTION_TYPE_ID",
"description": [],
"signature": [
"\".jira\""
],
"source": {
"path": "x-pack/plugins/cases/common/constants.ts",
"lineNumber": 44
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.JiraFieldsType",
"type": "Type",
"tags": [],
"label": "JiraFieldsType",
"description": [],
"signature": [
"{ issueType: string | null; priority: string | null; parent: string | null; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/connectors/jira.ts",
"lineNumber": 17
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.MAX_ALERTS_PER_SUB_CASE",
"type": "number",
"tags": [],
"label": "MAX_ALERTS_PER_SUB_CASE",
"description": [
"\nAlerts"
],
"signature": [
"5000"
],
"source": {
"path": "x-pack/plugins/cases/common/constants.ts",
"lineNumber": 57
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.MAX_GENERATED_ALERTS_PER_SUB_CASE",
"type": "number",
"tags": [],
"label": "MAX_GENERATED_ALERTS_PER_SUB_CASE",
"description": [],
"signature": [
"50"
],
"source": {
"path": "x-pack/plugins/cases/common/constants.ts",
"lineNumber": 58
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.RESILIENT_ACTION_TYPE_ID",
"type": "string",
"tags": [],
"label": "RESILIENT_ACTION_TYPE_ID",
"description": [],
"signature": [
"\".resilient\""
],
"source": {
"path": "x-pack/plugins/cases/common/constants.ts",
"lineNumber": 45
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ResilientFieldsType",
"type": "Type",
"tags": [],
"label": "ResilientFieldsType",
"description": [],
"signature": [
"{ incidentTypes: string[] | null; severityCode: string | null; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/connectors/resilient.ts",
"lineNumber": 16
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.SavedObjectFindOptions",
"type": "Type",
"tags": [],
"label": "SavedObjectFindOptions",
"description": [],
"signature": [
"{ defaultSearchOperator?: \"AND\" | \"OR\" | undefined; hasReferenceOperator?: \"AND\" | \"OR\" | undefined; hasReference?: { id: string; type: string; } | { id: string; type: string; }[] | undefined; fields?: string[] | undefined; filter?: string | undefined; page?: number | undefined; perPage?: number | undefined; search?: string | undefined; searchFields?: string[] | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/saved_object.ts",
"lineNumber": 39
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.SERVICENOW_ITSM_ACTION_TYPE_ID",
"type": "string",
"tags": [],
"label": "SERVICENOW_ITSM_ACTION_TYPE_ID",
"description": [],
"signature": [
"\".servicenow\""
],
"source": {
"path": "x-pack/plugins/cases/common/constants.ts",
"lineNumber": 42
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.SERVICENOW_SIR_ACTION_TYPE_ID",
"type": "string",
"tags": [],
"label": "SERVICENOW_SIR_ACTION_TYPE_ID",
"description": [],
"signature": [
"\".servicenow-sir\""
],
"source": {
"path": "x-pack/plugins/cases/common/constants.ts",
"lineNumber": 43
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ServiceNowITSMFieldsType",
"type": "Type",
"tags": [],
"label": "ServiceNowITSMFieldsType",
"description": [],
"signature": [
"{ impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/connectors/servicenow_itsm.ts",
"lineNumber": 19
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ServiceNowSIRFieldsType",
"type": "Type",
"tags": [],
"label": "ServiceNowSIRFieldsType",
"description": [],
"signature": [
"{ category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/connectors/servicenow_sir.ts",
"lineNumber": 21
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.StatusAll",
"type": "string",
"tags": [],
"label": "StatusAll",
"description": [],
"signature": [
"\"all\""
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 21
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.StatusAllType",
"type": "Type",
"tags": [],
"label": "StatusAllType",
"description": [],
"signature": [
"\"all\""
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 22
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.SUB_CASE_DETAILS_URL",
"type": "string",
"tags": [],
"label": "SUB_CASE_DETAILS_URL",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/constants.ts",
"lineNumber": 23
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.SUB_CASE_USER_ACTIONS_URL",
"type": "string",
"tags": [],
"label": "SUB_CASE_USER_ACTIONS_URL",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/constants.ts",
"lineNumber": 24
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.SUB_CASES_PATCH_DEL_URL",
"type": "string",
"tags": [],
"label": "SUB_CASES_PATCH_DEL_URL",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/constants.ts",
"lineNumber": 21
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.SUB_CASES_URL",
"type": "string",
"tags": [],
"label": "SUB_CASES_URL",
"description": [],
"source": {
"path": "x-pack/plugins/cases/common/constants.ts",
"lineNumber": 22
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.SubCaseAttributes",
"type": "Type",
"tags": [],
"label": "SubCaseAttributes",
"description": [],
"signature": [
"{ status: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"; } & { closed_at: string | null; closed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/sub_case.ts",
"lineNumber": 75
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.SubCasePatchRequest",
"type": "Type",
"tags": [],
"label": "SubCasePatchRequest",
"description": [],
"signature": [
"{ status?: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
" | undefined; } & { id: string; version: string; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/sub_case.ts",
"lineNumber": 79
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.SubCaseResponse",
"type": "Type",
"tags": [],
"label": "SubCaseResponse",
"description": [],
"signature": [
"{ status: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"; } & { closed_at: string | null; closed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; totalComment: number; totalAlerts: number; version: string; } & { comments?: (({ comment: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert | ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }))[] | undefined; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/sub_case.ts",
"lineNumber": 76
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.SubCasesFindResponse",
"type": "Type",
"tags": [],
"label": "SubCasesFindResponse",
"description": [],
"signature": [
"{ subCases: ({ status: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"; } & { closed_at: string | null; closed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; totalComment: number; totalAlerts: number; version: string; } & { comments?: (({ comment: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert | ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }))[] | undefined; })[]; page: number; per_page: number; total: number; } & { count_open_cases: number; count_in_progress_cases: number; count_closed_cases: number; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/sub_case.ts",
"lineNumber": 78
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.SubCasesPatchRequest",
"type": "Type",
"tags": [],
"label": "SubCasesPatchRequest",
"description": [],
"signature": [
"{ subCases: ({ status?: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
" | undefined; } & { id: string; version: string; })[]; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/sub_case.ts",
"lineNumber": 80
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.SubCasesResponse",
"type": "Type",
"tags": [],
"label": "SubCasesResponse",
"description": [],
"signature": [
"({ status: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"; } & { closed_at: string | null; closed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; totalComment: number; totalAlerts: number; version: string; } & { comments?: (({ comment: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert | ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; } & { associationType: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
"; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; version: string; }))[] | undefined; })[]"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/sub_case.ts",
"lineNumber": 77
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.SUPPORTED_CONNECTORS",
"type": "Array",
"tags": [],
"label": "SUPPORTED_CONNECTORS",
"description": [],
"signature": [
"string[]"
],
"source": {
"path": "x-pack/plugins/cases/common/constants.ts",
"lineNumber": 47
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ThirdPartyField",
"type": "Type",
"tags": [],
"label": "ThirdPartyField",
"description": [],
"signature": [
"string"
],
"source": {
"path": "x-pack/plugins/cases/common/api/connectors/mappings.ts",
"lineNumber": 24
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.UpdateKey",
"type": "Type",
"tags": [],
"label": "UpdateKey",
"description": [],
"signature": [
"\"status\" | \"description\" | \"title\" | \"tags\" | \"settings\" | \"connector\""
],
"source": {
"path": "x-pack/plugins/cases/common/ui/types.ts",
"lineNumber": 163
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.User",
"type": "Type",
"tags": [],
"label": "User",
"description": [],
"signature": [
"{ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }"
],
"source": {
"path": "x-pack/plugins/cases/common/api/user.ts",
"lineNumber": 18
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.UserAction",
"type": "Type",
"tags": [],
"label": "UserAction",
"description": [],
"signature": [
"\"add\" | \"delete\" | \"create\" | \"update\" | \"push-to-service\""
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/user_actions.ts",
"lineNumber": 62
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.UserActionField",
"type": "Type",
"tags": [],
"label": "UserActionField",
"description": [],
"signature": [
"(\"status\" | \"description\" | \"title\" | \"comment\" | \"tags\" | \"settings\" | \"connector\" | \"pushed\" | \"sub_case\")[]"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/user_actions.ts",
"lineNumber": 63
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.UserActionFieldType",
"type": "Type",
"tags": [],
"label": "UserActionFieldType",
"description": [],
"signature": [
"\"status\" | \"description\" | \"title\" | \"comment\" | \"tags\" | \"settings\" | \"connector\" | \"pushed\" | \"sub_case\""
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/user_actions.ts",
"lineNumber": 64
},
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "cases",
"id": "def-common.AlertCommentRequestRt",
"type": "Object",
"tags": [],
"label": "AlertCommentRequestRt",
"description": [
"\nThis defines the structure of how alerts (generated or user attached) are stored in saved objects documents. It also\nrepresents of an alert after it has been transformed. A generated alert will be transformed by the connector so that\nit matches this structure. User attached alerts do not need to be transformed."
],
"signature": [
"TypeC",
"<{ type: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert>]>; alertId: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"StringC",
"]>; index: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"StringC",
"]>; rule: ",
"TypeC",
"<{ id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; name: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>; }>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/comment.ts",
"lineNumber": 67
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.AllCommentsResponseRt",
"type": "Object",
"tags": [],
"label": "AllCommentsResponseRt",
"description": [],
"signature": [
"ArrayC",
"<",
"IntersectionC",
"<[",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ comment: ",
"StringC",
"; type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user>; }>, ",
"TypeC",
"<{ associationType: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".case>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".subCase>]>; created_at: ",
"StringC",
"; created_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; pushed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; pushed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ type: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert>]>; alertId: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"StringC",
"]>; index: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"StringC",
"]>; rule: ",
"TypeC",
"<{ id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; name: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>; }>, ",
"TypeC",
"<{ associationType: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".case>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".subCase>]>; created_at: ",
"StringC",
"; created_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; pushed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; pushed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>]>, ",
"TypeC",
"<{ id: ",
"StringC",
"; version: ",
"StringC",
"; }>]>>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/comment.ts",
"lineNumber": 128
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.AllCommentsResponseRT",
"type": "Object",
"tags": [],
"label": "AllCommentsResponseRT",
"description": [],
"signature": [
"ArrayC",
"<",
"IntersectionC",
"<[",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ comment: ",
"StringC",
"; type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user>; }>, ",
"TypeC",
"<{ associationType: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".case>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".subCase>]>; created_at: ",
"StringC",
"; created_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; pushed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; pushed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ type: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert>]>; alertId: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"StringC",
"]>; index: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"StringC",
"]>; rule: ",
"TypeC",
"<{ id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; name: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>; }>, ",
"TypeC",
"<{ associationType: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".case>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".subCase>]>; created_at: ",
"StringC",
"; created_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; pushed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; pushed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>]>, ",
"TypeC",
"<{ id: ",
"StringC",
"; version: ",
"StringC",
"; }>]>>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/comment.ts",
"lineNumber": 99
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseAttributesRt",
"type": "Object",
"tags": [],
"label": "CaseAttributesRt",
"description": [],
"signature": [
"IntersectionC",
"<[",
"TypeC",
"<{ description: ",
"StringC",
"; status: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
".open>, ",
"LiteralC",
"<typeof ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"[\"in-progress\"]>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
".closed>]>; tags: ",
"ArrayC",
"<",
"StringC",
">; title: ",
"StringC",
"; type: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
".collection>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
".individual>]>; connector: ",
"IntersectionC",
"<[",
"TypeC",
"<{ id: ",
"StringC",
"; name: ",
"StringC",
"; }>, ",
"UnionC",
"<[",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ issueType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; priority: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; parent: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ incidentTypes: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"NullC",
"]>; severityCode: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ impact: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; severity: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; urgency: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; category: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; subcategory: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ category: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; destIp: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; malwareHash: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; malwareUrl: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; priority: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; sourceIp: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; subcategory: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none>; fields: ",
"NullC",
"; }>]>]>; settings: ",
"TypeC",
"<{ syncAlerts: ",
"BooleanC",
"; }>; }>, ",
"TypeC",
"<{ closed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; closed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; created_at: ",
"StringC",
"; created_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; external_service: ",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ connector_id: ",
"StringC",
"; connector_name: ",
"StringC",
"; external_id: ",
"StringC",
"; external_title: ",
"StringC",
"; external_url: ",
"StringC",
"; }>, ",
"TypeC",
"<{ pushed_at: ",
"StringC",
"; pushed_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; }>]>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/case.ts",
"lineNumber": 62
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseConfigureAttributesRt",
"type": "Object",
"tags": [],
"label": "CaseConfigureAttributesRt",
"description": [],
"signature": [
"IntersectionC",
"<[",
"TypeC",
"<{ connector: ",
"IntersectionC",
"<[",
"TypeC",
"<{ id: ",
"StringC",
"; name: ",
"StringC",
"; }>, ",
"UnionC",
"<[",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ issueType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; priority: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; parent: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ incidentTypes: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"NullC",
"]>; severityCode: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ impact: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; severity: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; urgency: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; category: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; subcategory: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ category: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; destIp: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; malwareHash: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; malwareUrl: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; priority: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; sourceIp: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; subcategory: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none>; fields: ",
"NullC",
"; }>]>]>; closure_type: ",
"UnionC",
"<[",
"LiteralC",
"<\"close-by-user\">, ",
"LiteralC",
"<\"close-by-pushing\">]>; }>, ",
"TypeC",
"<{ created_at: ",
"StringC",
"; created_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/configure.ts",
"lineNumber": 27
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseConfigureResponseRt",
"type": "Object",
"tags": [],
"label": "CaseConfigureResponseRt",
"description": [],
"signature": [
"IntersectionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ connector: ",
"IntersectionC",
"<[",
"TypeC",
"<{ id: ",
"StringC",
"; name: ",
"StringC",
"; }>, ",
"UnionC",
"<[",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ issueType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; priority: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; parent: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ incidentTypes: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"NullC",
"]>; severityCode: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ impact: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; severity: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; urgency: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; category: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; subcategory: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ category: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; destIp: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; malwareHash: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; malwareUrl: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; priority: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; sourceIp: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; subcategory: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none>; fields: ",
"NullC",
"; }>]>]>; closure_type: ",
"UnionC",
"<[",
"LiteralC",
"<\"close-by-user\">, ",
"LiteralC",
"<\"close-by-pushing\">]>; }>, ",
"TypeC",
"<{ created_at: ",
"StringC",
"; created_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>, ",
"TypeC",
"<{ mappings: ",
"ArrayC",
"<",
"TypeC",
"<{ action_type: ",
"UnionC",
"<[",
"LiteralC",
"<\"append\">, ",
"LiteralC",
"<\"nothing\">, ",
"LiteralC",
"<\"overwrite\">]>; source: ",
"UnionC",
"<[",
"LiteralC",
"<\"title\">, ",
"LiteralC",
"<\"description\">, ",
"LiteralC",
"<\"comments\">]>; target: ",
"UnionC",
"<[",
"StringC",
", ",
"LiteralC",
"<\"not_mapped\">]>; }>>; }>, ",
"TypeC",
"<{ version: ",
"StringC",
"; error: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>]>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/configure.ts",
"lineNumber": 37
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseConnectorRt",
"type": "Object",
"tags": [],
"label": "CaseConnectorRt",
"description": [],
"signature": [
"IntersectionC",
"<[",
"TypeC",
"<{ id: ",
"StringC",
"; name: ",
"StringC",
"; }>, ",
"UnionC",
"<[",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ issueType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; priority: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; parent: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ incidentTypes: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"NullC",
"]>; severityCode: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ impact: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; severity: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; urgency: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; category: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; subcategory: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ category: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; destIp: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; malwareHash: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; malwareUrl: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; priority: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; sourceIp: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; subcategory: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none>; fields: ",
"NullC",
"; }>]>]>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/connectors/index.ts",
"lineNumber": 74
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasePatchRequestRt",
"type": "Object",
"tags": [],
"label": "CasePatchRequestRt",
"description": [],
"signature": [
"IntersectionC",
"<[",
"PartialC",
"<{ description: ",
"StringC",
"; status: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
".open>, ",
"LiteralC",
"<typeof ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"[\"in-progress\"]>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
".closed>]>; tags: ",
"ArrayC",
"<",
"StringC",
">; title: ",
"StringC",
"; type: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
".collection>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
".individual>]>; connector: ",
"IntersectionC",
"<[",
"TypeC",
"<{ id: ",
"StringC",
"; name: ",
"StringC",
"; }>, ",
"UnionC",
"<[",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ issueType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; priority: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; parent: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ incidentTypes: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"NullC",
"]>; severityCode: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ impact: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; severity: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; urgency: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; category: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; subcategory: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ category: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; destIp: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; malwareHash: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; malwareUrl: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; priority: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; sourceIp: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; subcategory: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none>; fields: ",
"NullC",
"; }>]>]>; settings: ",
"TypeC",
"<{ syncAlerts: ",
"BooleanC",
"; }>; }>, ",
"TypeC",
"<{ id: ",
"StringC",
"; version: ",
"StringC",
"; }>]>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/case.ts",
"lineNumber": 142
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasePostRequestRt",
"type": "Object",
"tags": [],
"label": "CasePostRequestRt",
"description": [
"\nThis type is not used for validation when decoding a request because intersection does not have props defined which\nrequired for the excess function. Instead we use this as the type used by the UI. This allows the type field to be\noptional and the server will handle setting it to a default value before validating that the request\nhas all the necessary fields. CasesClientPostRequestRt is used for validation."
],
"signature": [
"IntersectionC",
"<[",
"PartialC",
"<{ type: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
".collection>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
".individual>]>; }>, ",
"TypeC",
"<{ description: ",
"StringC",
"; tags: ",
"ArrayC",
"<",
"StringC",
">; title: ",
"StringC",
"; connector: ",
"IntersectionC",
"<[",
"TypeC",
"<{ id: ",
"StringC",
"; name: ",
"StringC",
"; }>, ",
"UnionC",
"<[",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ issueType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; priority: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; parent: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ incidentTypes: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"NullC",
"]>; severityCode: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ impact: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; severity: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; urgency: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; category: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; subcategory: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ category: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; destIp: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; malwareHash: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; malwareUrl: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; priority: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; sourceIp: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; subcategory: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none>; fields: ",
"NullC",
"; }>]>]>; settings: ",
"TypeC",
"<{ syncAlerts: ",
"BooleanC",
"; }>; }>]>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/case.ts",
"lineNumber": 97
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasePushRequestParamsRt",
"type": "Object",
"tags": [],
"label": "CasePushRequestParamsRt",
"description": [],
"signature": [
"TypeC",
"<{ case_id: ",
"StringC",
"; connector_id: ",
"StringC",
"; }>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/case.ts",
"lineNumber": 150
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseResponseRt",
"type": "Object",
"tags": [],
"label": "CaseResponseRt",
"description": [],
"signature": [
"IntersectionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ description: ",
"StringC",
"; status: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
".open>, ",
"LiteralC",
"<typeof ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"[\"in-progress\"]>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
".closed>]>; tags: ",
"ArrayC",
"<",
"StringC",
">; title: ",
"StringC",
"; type: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
".collection>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
".individual>]>; connector: ",
"IntersectionC",
"<[",
"TypeC",
"<{ id: ",
"StringC",
"; name: ",
"StringC",
"; }>, ",
"UnionC",
"<[",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ issueType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; priority: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; parent: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ incidentTypes: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"NullC",
"]>; severityCode: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ impact: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; severity: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; urgency: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; category: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; subcategory: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ category: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; destIp: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; malwareHash: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; malwareUrl: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; priority: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; sourceIp: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; subcategory: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none>; fields: ",
"NullC",
"; }>]>]>; settings: ",
"TypeC",
"<{ syncAlerts: ",
"BooleanC",
"; }>; }>, ",
"TypeC",
"<{ closed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; closed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; created_at: ",
"StringC",
"; created_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; external_service: ",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ connector_id: ",
"StringC",
"; connector_name: ",
"StringC",
"; external_id: ",
"StringC",
"; external_title: ",
"StringC",
"; external_url: ",
"StringC",
"; }>, ",
"TypeC",
"<{ pushed_at: ",
"StringC",
"; pushed_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; }>]>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>, ",
"TypeC",
"<{ id: ",
"StringC",
"; totalComment: ",
"NumberC",
"; totalAlerts: ",
"NumberC",
"; version: ",
"StringC",
"; }>, ",
"PartialC",
"<{ subCaseIds: ",
"ArrayC",
"<",
"StringC",
">; subCases: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ status: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
".open>, ",
"LiteralC",
"<typeof ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"[\"in-progress\"]>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
".closed>]>; }>, ",
"TypeC",
"<{ closed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; closed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; created_at: ",
"StringC",
"; created_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>, ",
"TypeC",
"<{ id: ",
"StringC",
"; totalComment: ",
"NumberC",
"; totalAlerts: ",
"NumberC",
"; version: ",
"StringC",
"; }>, ",
"PartialC",
"<{ comments: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ comment: ",
"StringC",
"; type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user>; }>, ",
"TypeC",
"<{ associationType: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".case>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".subCase>]>; created_at: ",
"StringC",
"; created_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; pushed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; pushed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ type: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert>]>; alertId: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"StringC",
"]>; index: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"StringC",
"]>; rule: ",
"TypeC",
"<{ id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; name: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>; }>, ",
"TypeC",
"<{ associationType: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".case>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".subCase>]>; created_at: ",
"StringC",
"; created_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; pushed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; pushed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>]>, ",
"TypeC",
"<{ id: ",
"StringC",
"; version: ",
"StringC",
"; }>]>>; }>]>>; comments: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ comment: ",
"StringC",
"; type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user>; }>, ",
"TypeC",
"<{ associationType: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".case>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".subCase>]>; created_at: ",
"StringC",
"; created_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; pushed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; pushed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ type: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert>]>; alertId: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"StringC",
"]>; index: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"StringC",
"]>; rule: ",
"TypeC",
"<{ id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; name: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>; }>, ",
"TypeC",
"<{ associationType: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".case>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".subCase>]>; created_at: ",
"StringC",
"; created_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; pushed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; pushed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>]>, ",
"TypeC",
"<{ id: ",
"StringC",
"; version: ",
"StringC",
"; }>]>>; }>]>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/case.ts",
"lineNumber": 117
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesClientPostRequestRt",
"type": "Object",
"tags": [],
"label": "CasesClientPostRequestRt",
"description": [
"\nThis type is used for validating a create case request. It requires that the type field be defined."
],
"signature": [
"TypeC",
"<{ type: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
".collection>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
".individual>]>; description: ",
"StringC",
"; tags: ",
"ArrayC",
"<",
"StringC",
">; title: ",
"StringC",
"; connector: ",
"IntersectionC",
"<[",
"TypeC",
"<{ id: ",
"StringC",
"; name: ",
"StringC",
"; }>, ",
"UnionC",
"<[",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ issueType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; priority: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; parent: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ incidentTypes: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"NullC",
"]>; severityCode: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ impact: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; severity: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; urgency: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; category: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; subcategory: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ category: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; destIp: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; malwareHash: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; malwareUrl: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; priority: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; sourceIp: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; subcategory: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none>; fields: ",
"NullC",
"; }>]>]>; settings: ",
"TypeC",
"<{ syncAlerts: ",
"BooleanC",
"; }>; }>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/case.ts",
"lineNumber": 86
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesConfigurePatchRt",
"type": "Object",
"tags": [],
"label": "CasesConfigurePatchRt",
"description": [],
"signature": [
"IntersectionC",
"<[",
"PartialC",
"<{ connector: ",
"IntersectionC",
"<[",
"TypeC",
"<{ id: ",
"StringC",
"; name: ",
"StringC",
"; }>, ",
"UnionC",
"<[",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ issueType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; priority: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; parent: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ incidentTypes: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"NullC",
"]>; severityCode: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ impact: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; severity: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; urgency: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; category: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; subcategory: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ category: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; destIp: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; malwareHash: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; malwareUrl: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; priority: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; sourceIp: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; subcategory: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none>; fields: ",
"NullC",
"; }>]>]>; closure_type: ",
"UnionC",
"<[",
"LiteralC",
"<\"close-by-user\">, ",
"LiteralC",
"<\"close-by-pushing\">]>; }>, ",
"TypeC",
"<{ version: ",
"StringC",
"; }>]>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/configure.ts",
"lineNumber": 22
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesConfigureRequestRt",
"type": "Object",
"tags": [],
"label": "CasesConfigureRequestRt",
"description": [],
"signature": [
"TypeC",
"<{ connector: ",
"IntersectionC",
"<[",
"TypeC",
"<{ id: ",
"StringC",
"; name: ",
"StringC",
"; }>, ",
"UnionC",
"<[",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ issueType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; priority: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; parent: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ incidentTypes: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"NullC",
"]>; severityCode: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ impact: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; severity: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; urgency: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; category: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; subcategory: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ category: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; destIp: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; malwareHash: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; malwareUrl: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; priority: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; sourceIp: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; subcategory: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none>; fields: ",
"NullC",
"; }>]>]>; closure_type: ",
"UnionC",
"<[",
"LiteralC",
"<\"close-by-user\">, ",
"LiteralC",
"<\"close-by-pushing\">]>; }>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/configure.ts",
"lineNumber": 21
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesFindRequestRt",
"type": "Object",
"tags": [],
"label": "CasesFindRequestRt",
"description": [],
"signature": [
"PartialC",
"<{ type: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
".collection>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
".individual>]>; tags: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"StringC",
"]>; status: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
".open>, ",
"LiteralC",
"<typeof ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"[\"in-progress\"]>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
".closed>]>; reporters: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"StringC",
"]>; defaultSearchOperator: ",
"UnionC",
"<[",
"LiteralC",
"<\"AND\">, ",
"LiteralC",
"<\"OR\">]>; fields: ",
"ArrayC",
"<",
"StringC",
">; page: ",
"Type",
"<number, string, unknown>; perPage: ",
"Type",
"<number, string, unknown>; search: ",
"StringC",
"; searchFields: ",
"ArrayC",
"<",
"StringC",
">; sortField: ",
"StringC",
"; sortOrder: ",
"UnionC",
"<[",
"LiteralC",
"<\"desc\">, ",
"LiteralC",
"<\"asc\">]>; }>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/case.ts",
"lineNumber": 102
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesFindResponseRt",
"type": "Object",
"tags": [],
"label": "CasesFindResponseRt",
"description": [],
"signature": [
"IntersectionC",
"<[",
"TypeC",
"<{ cases: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ description: ",
"StringC",
"; status: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
".open>, ",
"LiteralC",
"<typeof ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"[\"in-progress\"]>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
".closed>]>; tags: ",
"ArrayC",
"<",
"StringC",
">; title: ",
"StringC",
"; type: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
".collection>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
".individual>]>; connector: ",
"IntersectionC",
"<[",
"TypeC",
"<{ id: ",
"StringC",
"; name: ",
"StringC",
"; }>, ",
"UnionC",
"<[",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ issueType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; priority: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; parent: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ incidentTypes: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"NullC",
"]>; severityCode: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ impact: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; severity: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; urgency: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; category: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; subcategory: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ category: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; destIp: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; malwareHash: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; malwareUrl: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; priority: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; sourceIp: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; subcategory: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none>; fields: ",
"NullC",
"; }>]>]>; settings: ",
"TypeC",
"<{ syncAlerts: ",
"BooleanC",
"; }>; }>, ",
"TypeC",
"<{ closed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; closed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; created_at: ",
"StringC",
"; created_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; external_service: ",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ connector_id: ",
"StringC",
"; connector_name: ",
"StringC",
"; external_id: ",
"StringC",
"; external_title: ",
"StringC",
"; external_url: ",
"StringC",
"; }>, ",
"TypeC",
"<{ pushed_at: ",
"StringC",
"; pushed_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; }>]>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>, ",
"TypeC",
"<{ id: ",
"StringC",
"; totalComment: ",
"NumberC",
"; totalAlerts: ",
"NumberC",
"; version: ",
"StringC",
"; }>, ",
"PartialC",
"<{ subCaseIds: ",
"ArrayC",
"<",
"StringC",
">; subCases: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ status: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
".open>, ",
"LiteralC",
"<typeof ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"[\"in-progress\"]>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
".closed>]>; }>, ",
"TypeC",
"<{ closed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; closed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; created_at: ",
"StringC",
"; created_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>, ",
"TypeC",
"<{ id: ",
"StringC",
"; totalComment: ",
"NumberC",
"; totalAlerts: ",
"NumberC",
"; version: ",
"StringC",
"; }>, ",
"PartialC",
"<{ comments: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ comment: ",
"StringC",
"; type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user>; }>, ",
"TypeC",
"<{ associationType: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".case>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".subCase>]>; created_at: ",
"StringC",
"; created_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; pushed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; pushed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ type: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert>]>; alertId: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"StringC",
"]>; index: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"StringC",
"]>; rule: ",
"TypeC",
"<{ id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; name: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>; }>, ",
"TypeC",
"<{ associationType: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".case>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".subCase>]>; created_at: ",
"StringC",
"; created_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; pushed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; pushed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>]>, ",
"TypeC",
"<{ id: ",
"StringC",
"; version: ",
"StringC",
"; }>]>>; }>]>>; comments: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ comment: ",
"StringC",
"; type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user>; }>, ",
"TypeC",
"<{ associationType: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".case>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".subCase>]>; created_at: ",
"StringC",
"; created_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; pushed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; pushed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ type: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert>]>; alertId: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"StringC",
"]>; index: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"StringC",
"]>; rule: ",
"TypeC",
"<{ id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; name: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>; }>, ",
"TypeC",
"<{ associationType: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".case>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".subCase>]>; created_at: ",
"StringC",
"; created_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; pushed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; pushed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>]>, ",
"TypeC",
"<{ id: ",
"StringC",
"; version: ",
"StringC",
"; }>]>>; }>]>>; page: ",
"NumberC",
"; per_page: ",
"NumberC",
"; total: ",
"NumberC",
"; }>, ",
"TypeC",
"<{ count_open_cases: ",
"NumberC",
"; count_in_progress_cases: ",
"NumberC",
"; count_closed_cases: ",
"NumberC",
"; }>]>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/case.ts",
"lineNumber": 132
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesPatchRequestRt",
"type": "Object",
"tags": [],
"label": "CasesPatchRequestRt",
"description": [],
"signature": [
"TypeC",
"<{ cases: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"PartialC",
"<{ description: ",
"StringC",
"; status: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
".open>, ",
"LiteralC",
"<typeof ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"[\"in-progress\"]>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
".closed>]>; tags: ",
"ArrayC",
"<",
"StringC",
">; title: ",
"StringC",
"; type: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
".collection>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
".individual>]>; connector: ",
"IntersectionC",
"<[",
"TypeC",
"<{ id: ",
"StringC",
"; name: ",
"StringC",
"; }>, ",
"UnionC",
"<[",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ issueType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; priority: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; parent: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ incidentTypes: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"NullC",
"]>; severityCode: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ impact: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; severity: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; urgency: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; category: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; subcategory: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ category: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; destIp: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; malwareHash: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; malwareUrl: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; priority: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; sourceIp: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; subcategory: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none>; fields: ",
"NullC",
"; }>]>]>; settings: ",
"TypeC",
"<{ syncAlerts: ",
"BooleanC",
"; }>; }>, ",
"TypeC",
"<{ id: ",
"StringC",
"; version: ",
"StringC",
"; }>]>>; }>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/case.ts",
"lineNumber": 147
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesResponseRt",
"type": "Object",
"tags": [],
"label": "CasesResponseRt",
"description": [],
"signature": [
"ArrayC",
"<",
"IntersectionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ description: ",
"StringC",
"; status: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
".open>, ",
"LiteralC",
"<typeof ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"[\"in-progress\"]>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
".closed>]>; tags: ",
"ArrayC",
"<",
"StringC",
">; title: ",
"StringC",
"; type: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
".collection>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseType",
"text": "CaseType"
},
".individual>]>; connector: ",
"IntersectionC",
"<[",
"TypeC",
"<{ id: ",
"StringC",
"; name: ",
"StringC",
"; }>, ",
"UnionC",
"<[",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ issueType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; priority: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; parent: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ incidentTypes: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"NullC",
"]>; severityCode: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ impact: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; severity: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; urgency: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; category: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; subcategory: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ category: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; destIp: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; malwareHash: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; malwareUrl: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; priority: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; sourceIp: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; subcategory: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none>; fields: ",
"NullC",
"; }>]>]>; settings: ",
"TypeC",
"<{ syncAlerts: ",
"BooleanC",
"; }>; }>, ",
"TypeC",
"<{ closed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; closed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; created_at: ",
"StringC",
"; created_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; external_service: ",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ connector_id: ",
"StringC",
"; connector_name: ",
"StringC",
"; external_id: ",
"StringC",
"; external_title: ",
"StringC",
"; external_url: ",
"StringC",
"; }>, ",
"TypeC",
"<{ pushed_at: ",
"StringC",
"; pushed_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; }>]>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>, ",
"TypeC",
"<{ id: ",
"StringC",
"; totalComment: ",
"NumberC",
"; totalAlerts: ",
"NumberC",
"; version: ",
"StringC",
"; }>, ",
"PartialC",
"<{ subCaseIds: ",
"ArrayC",
"<",
"StringC",
">; subCases: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ status: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
".open>, ",
"LiteralC",
"<typeof ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"[\"in-progress\"]>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
".closed>]>; }>, ",
"TypeC",
"<{ closed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; closed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; created_at: ",
"StringC",
"; created_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>, ",
"TypeC",
"<{ id: ",
"StringC",
"; totalComment: ",
"NumberC",
"; totalAlerts: ",
"NumberC",
"; version: ",
"StringC",
"; }>, ",
"PartialC",
"<{ comments: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ comment: ",
"StringC",
"; type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user>; }>, ",
"TypeC",
"<{ associationType: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".case>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".subCase>]>; created_at: ",
"StringC",
"; created_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; pushed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; pushed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ type: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert>]>; alertId: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"StringC",
"]>; index: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"StringC",
"]>; rule: ",
"TypeC",
"<{ id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; name: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>; }>, ",
"TypeC",
"<{ associationType: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".case>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".subCase>]>; created_at: ",
"StringC",
"; created_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; pushed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; pushed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>]>, ",
"TypeC",
"<{ id: ",
"StringC",
"; version: ",
"StringC",
"; }>]>>; }>]>>; comments: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ comment: ",
"StringC",
"; type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user>; }>, ",
"TypeC",
"<{ associationType: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".case>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".subCase>]>; created_at: ",
"StringC",
"; created_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; pushed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; pushed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ type: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert>]>; alertId: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"StringC",
"]>; index: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"StringC",
"]>; rule: ",
"TypeC",
"<{ id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; name: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>; }>, ",
"TypeC",
"<{ associationType: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".case>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".subCase>]>; created_at: ",
"StringC",
"; created_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; pushed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; pushed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>]>, ",
"TypeC",
"<{ id: ",
"StringC",
"; version: ",
"StringC",
"; }>]>>; }>]>>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/case.ts",
"lineNumber": 148
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesStatusResponseRt",
"type": "Object",
"tags": [],
"label": "CasesStatusResponseRt",
"description": [],
"signature": [
"TypeC",
"<{ count_open_cases: ",
"NumberC",
"; count_in_progress_cases: ",
"NumberC",
"; count_closed_cases: ",
"NumberC",
"; }>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/status.ts",
"lineNumber": 24
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseStatusRt",
"type": "Object",
"tags": [],
"label": "CaseStatusRt",
"description": [],
"signature": [
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
".open>, ",
"LiteralC",
"<typeof ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"[\"in-progress\"]>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
".closed>]>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/status.ts",
"lineNumber": 16
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseUserActionAttributesRt",
"type": "Object",
"tags": [],
"label": "CaseUserActionAttributesRt",
"description": [],
"signature": [
"TypeC",
"<{ action_field: ",
"ArrayC",
"<",
"UnionC",
"<[",
"LiteralC",
"<\"comment\">, ",
"LiteralC",
"<\"connector\">, ",
"LiteralC",
"<\"description\">, ",
"LiteralC",
"<\"pushed\">, ",
"LiteralC",
"<\"tags\">, ",
"LiteralC",
"<\"title\">, ",
"LiteralC",
"<\"status\">, ",
"LiteralC",
"<\"settings\">, ",
"LiteralC",
"<\"sub_case\">]>>; action: ",
"UnionC",
"<[",
"LiteralC",
"<\"add\">, ",
"LiteralC",
"<\"create\">, ",
"LiteralC",
"<\"delete\">, ",
"LiteralC",
"<\"update\">, ",
"LiteralC",
"<\"push-to-service\">]>; action_at: ",
"StringC",
"; action_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; new_value: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; old_value: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/user_actions.ts",
"lineNumber": 55
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseUserActionsResponseRt",
"type": "Object",
"tags": [],
"label": "CaseUserActionsResponseRt",
"description": [],
"signature": [
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ action_field: ",
"ArrayC",
"<",
"UnionC",
"<[",
"LiteralC",
"<\"comment\">, ",
"LiteralC",
"<\"connector\">, ",
"LiteralC",
"<\"description\">, ",
"LiteralC",
"<\"pushed\">, ",
"LiteralC",
"<\"tags\">, ",
"LiteralC",
"<\"title\">, ",
"LiteralC",
"<\"status\">, ",
"LiteralC",
"<\"settings\">, ",
"LiteralC",
"<\"sub_case\">]>>; action: ",
"UnionC",
"<[",
"LiteralC",
"<\"add\">, ",
"LiteralC",
"<\"create\">, ",
"LiteralC",
"<\"delete\">, ",
"LiteralC",
"<\"update\">, ",
"LiteralC",
"<\"push-to-service\">]>; action_at: ",
"StringC",
"; action_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; new_value: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; old_value: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ action_id: ",
"StringC",
"; case_id: ",
"StringC",
"; comment_id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"PartialC",
"<{ sub_case_id: ",
"StringC",
"; }>]>>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/user_actions.ts",
"lineNumber": 57
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CommentAttributesBasicRt",
"type": "Object",
"tags": [],
"label": "CommentAttributesBasicRt",
"description": [],
"signature": [
"TypeC",
"<{ associationType: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".case>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".subCase>]>; created_at: ",
"StringC",
"; created_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; pushed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; pushed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/comment.ts",
"lineNumber": 38
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CommentPatchAttributesRt",
"type": "Object",
"tags": [],
"label": "CommentPatchAttributesRt",
"description": [
"\nThis type is used by the CaseService.\nBecause the type for the attributes of savedObjectClient update function is Partial<T>\nwe need to make all of our attributes partial too.\nWe ensure that partial updates of CommentContext is not going to happen inside the patch comment route."
],
"signature": [
"IntersectionC",
"<[",
"UnionC",
"<[",
"PartialC",
"<{ associationType: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".case>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".subCase>]>; created_at: ",
"StringC",
"; created_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; pushed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; pushed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"PartialC",
"<{ type: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert>]>; alertId: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"StringC",
"]>; index: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"StringC",
"]>; rule: ",
"TypeC",
"<{ id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; name: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>; }>]>, ",
"PartialC",
"<{ associationType: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".case>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".subCase>]>; created_at: ",
"StringC",
"; created_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; pushed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; pushed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/comment.ts",
"lineNumber": 116
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CommentPatchRequestRt",
"type": "Object",
"tags": [],
"label": "CommentPatchRequestRt",
"description": [],
"signature": [
"IntersectionC",
"<[",
"UnionC",
"<[",
"TypeC",
"<{ comment: ",
"StringC",
"; type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user>; }>, ",
"TypeC",
"<{ type: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert>]>; alertId: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"StringC",
"]>; index: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"StringC",
"]>; rule: ",
"TypeC",
"<{ id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; name: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>; }>]>, ",
"TypeC",
"<{ id: ",
"StringC",
"; version: ",
"StringC",
"; }>]>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/comment.ts",
"lineNumber": 101
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CommentRequestRt",
"type": "Object",
"tags": [],
"label": "CommentRequestRt",
"description": [],
"signature": [
"UnionC",
"<[",
"TypeC",
"<{ comment: ",
"StringC",
"; type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user>; }>, ",
"TypeC",
"<{ type: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert>]>; alertId: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"StringC",
"]>; index: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"StringC",
"]>; rule: ",
"TypeC",
"<{ id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; name: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>; }>]>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/comment.ts",
"lineNumber": 81
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CommentResponseRt",
"type": "Object",
"tags": [],
"label": "CommentResponseRt",
"description": [],
"signature": [
"IntersectionC",
"<[",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ comment: ",
"StringC",
"; type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user>; }>, ",
"TypeC",
"<{ associationType: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".case>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".subCase>]>; created_at: ",
"StringC",
"; created_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; pushed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; pushed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ type: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert>]>; alertId: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"StringC",
"]>; index: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"StringC",
"]>; rule: ",
"TypeC",
"<{ id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; name: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>; }>, ",
"TypeC",
"<{ associationType: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".case>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".subCase>]>; created_at: ",
"StringC",
"; created_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; pushed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; pushed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>]>, ",
"TypeC",
"<{ id: ",
"StringC",
"; version: ",
"StringC",
"; }>]>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/comment.ts",
"lineNumber": 83
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CommentResponseTypeAlertsRt",
"type": "Object",
"tags": [],
"label": "CommentResponseTypeAlertsRt",
"description": [],
"signature": [
"IntersectionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ type: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert>]>; alertId: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"StringC",
"]>; index: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"StringC",
"]>; rule: ",
"TypeC",
"<{ id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; name: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>; }>, ",
"TypeC",
"<{ associationType: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".case>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".subCase>]>; created_at: ",
"StringC",
"; created_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; pushed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; pushed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>, ",
"TypeC",
"<{ id: ",
"StringC",
"; version: ",
"StringC",
"; }>]>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/comment.ts",
"lineNumber": 91
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CommentsResponseRt",
"type": "Object",
"tags": [],
"label": "CommentsResponseRt",
"description": [],
"signature": [
"TypeC",
"<{ comments: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ comment: ",
"StringC",
"; type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user>; }>, ",
"TypeC",
"<{ associationType: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".case>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".subCase>]>; created_at: ",
"StringC",
"; created_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; pushed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; pushed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ type: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert>]>; alertId: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"StringC",
"]>; index: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"StringC",
"]>; rule: ",
"TypeC",
"<{ id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; name: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>; }>, ",
"TypeC",
"<{ associationType: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".case>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".subCase>]>; created_at: ",
"StringC",
"; created_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; pushed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; pushed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>]>, ",
"TypeC",
"<{ id: ",
"StringC",
"; version: ",
"StringC",
"; }>]>>; page: ",
"NumberC",
"; per_page: ",
"NumberC",
"; total: ",
"NumberC",
"; }>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/comment.ts",
"lineNumber": 121
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ConnectorFieldsRt",
"type": "Object",
"tags": [],
"label": "ConnectorFieldsRt",
"description": [],
"signature": [
"UnionC",
"<[",
"TypeC",
"<{ issueType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; priority: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; parent: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ incidentTypes: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"NullC",
"]>; severityCode: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ impact: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; severity: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; urgency: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; category: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; subcategory: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ category: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; destIp: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; malwareHash: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; malwareUrl: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; priority: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; sourceIp: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; subcategory: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/connectors/index.ts",
"lineNumber": 25
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ConnectorMappingsAttributesRT",
"type": "Object",
"tags": [],
"label": "ConnectorMappingsAttributesRT",
"description": [],
"signature": [
"TypeC",
"<{ action_type: ",
"UnionC",
"<[",
"LiteralC",
"<\"append\">, ",
"LiteralC",
"<\"nothing\">, ",
"LiteralC",
"<\"overwrite\">]>; source: ",
"UnionC",
"<[",
"LiteralC",
"<\"title\">, ",
"LiteralC",
"<\"description\">, ",
"LiteralC",
"<\"comments\">]>; target: ",
"UnionC",
"<[",
"StringC",
", ",
"LiteralC",
"<\"not_mapped\">]>; }>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/connectors/mappings.ts",
"lineNumber": 26
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ConnectorMappingsRt",
"type": "Object",
"tags": [],
"label": "ConnectorMappingsRt",
"description": [],
"signature": [
"TypeC",
"<{ mappings: ",
"ArrayC",
"<",
"TypeC",
"<{ action_type: ",
"UnionC",
"<[",
"LiteralC",
"<\"append\">, ",
"LiteralC",
"<\"nothing\">, ",
"LiteralC",
"<\"overwrite\">]>; source: ",
"UnionC",
"<[",
"LiteralC",
"<\"title\">, ",
"LiteralC",
"<\"description\">, ",
"LiteralC",
"<\"comments\">]>; target: ",
"UnionC",
"<[",
"StringC",
", ",
"LiteralC",
"<\"not_mapped\">]>; }>>; }>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/connectors/mappings.ts",
"lineNumber": 32
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ConnectorTypeFieldsRt",
"type": "Object",
"tags": [],
"label": "ConnectorTypeFieldsRt",
"description": [],
"signature": [
"UnionC",
"<[",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ issueType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; priority: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; parent: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ incidentTypes: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"NullC",
"]>; severityCode: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ impact: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; severity: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; urgency: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; category: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; subcategory: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR>; fields: ",
"UnionC",
"<[",
"TypeC",
"<{ category: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; destIp: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; malwareHash: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; malwareUrl: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; priority: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; sourceIp: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; subcategory: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none>; fields: ",
"NullC",
"; }>]>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/connectors/index.ts",
"lineNumber": 66
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ContextTypeUserRt",
"type": "Object",
"tags": [],
"label": "ContextTypeUserRt",
"description": [],
"signature": [
"TypeC",
"<{ comment: ",
"StringC",
"; type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user>; }>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/comment.ts",
"lineNumber": 57
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ExternalServiceResponseRt",
"type": "Object",
"tags": [],
"label": "ExternalServiceResponseRt",
"description": [],
"signature": [
"IntersectionC",
"<[",
"TypeC",
"<{ title: ",
"StringC",
"; id: ",
"StringC",
"; pushedDate: ",
"StringC",
"; url: ",
"StringC",
"; }>, ",
"PartialC",
"<{ comments: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ commentId: ",
"StringC",
"; pushedDate: ",
"StringC",
"; }>, ",
"PartialC",
"<{ externalCommentId: ",
"StringC",
"; }>]>>; }>]>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/case.ts",
"lineNumber": 155
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.GetCaseIdsByAlertIdAggsRt",
"type": "Object",
"tags": [],
"label": "GetCaseIdsByAlertIdAggsRt",
"description": [],
"signature": [
"TypeC",
"<{ references: ",
"TypeC",
"<{ doc_count: ",
"NumberC",
"; caseIds: ",
"TypeC",
"<{ buckets: ",
"ArrayC",
"<",
"TypeC",
"<{ key: ",
"StringC",
"; }>>; }>; }>; }>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/comment.ts",
"lineNumber": 18
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.JiraFieldsRT",
"type": "Object",
"tags": [],
"label": "JiraFieldsRT",
"description": [],
"signature": [
"TypeC",
"<{ issueType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; priority: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; parent: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/connectors/jira.ts",
"lineNumber": 11
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.NumberFromString",
"type": "Object",
"tags": [],
"label": "NumberFromString",
"description": [],
"signature": [
"Type",
"<number, string, unknown>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/saved_object.ts",
"lineNumber": 12
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ResilientFieldsRT",
"type": "Object",
"tags": [],
"label": "ResilientFieldsRT",
"description": [],
"signature": [
"TypeC",
"<{ incidentTypes: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"NullC",
"]>; severityCode: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/connectors/resilient.ts",
"lineNumber": 11
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.SavedObjectFindOptionsRt",
"type": "Object",
"tags": [],
"label": "SavedObjectFindOptionsRt",
"description": [],
"signature": [
"PartialC",
"<{ defaultSearchOperator: ",
"UnionC",
"<[",
"LiteralC",
"<\"AND\">, ",
"LiteralC",
"<\"OR\">]>; hasReferenceOperator: ",
"UnionC",
"<[",
"LiteralC",
"<\"AND\">, ",
"LiteralC",
"<\"OR\">]>; hasReference: ",
"UnionC",
"<[",
"ArrayC",
"<",
"TypeC",
"<{ id: ",
"StringC",
"; type: ",
"StringC",
"; }>>, ",
"TypeC",
"<{ id: ",
"StringC",
"; type: ",
"StringC",
"; }>]>; fields: ",
"ArrayC",
"<",
"StringC",
">; filter: ",
"StringC",
"; page: ",
"Type",
"<number, string, unknown>; perPage: ",
"Type",
"<number, string, unknown>; search: ",
"StringC",
"; searchFields: ",
"ArrayC",
"<",
"StringC",
">; sortField: ",
"StringC",
"; sortOrder: ",
"UnionC",
"<[",
"LiteralC",
"<\"desc\">, ",
"LiteralC",
"<\"asc\">]>; }>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/saved_object.ts",
"lineNumber": 25
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ServiceNowITSMFieldsRT",
"type": "Object",
"tags": [],
"label": "ServiceNowITSMFieldsRT",
"description": [],
"signature": [
"TypeC",
"<{ impact: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; severity: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; urgency: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; category: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; subcategory: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/connectors/servicenow_itsm.ts",
"lineNumber": 11
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ServiceNowSIRFieldsRT",
"type": "Object",
"tags": [],
"label": "ServiceNowSIRFieldsRT",
"description": [],
"signature": [
"TypeC",
"<{ category: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; destIp: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; malwareHash: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; malwareUrl: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; priority: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; sourceIp: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; subcategory: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/connectors/servicenow_sir.ts",
"lineNumber": 11
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.SubCaseAttributesRt",
"type": "Object",
"tags": [],
"label": "SubCaseAttributesRt",
"description": [],
"signature": [
"IntersectionC",
"<[",
"TypeC",
"<{ status: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
".open>, ",
"LiteralC",
"<typeof ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"[\"in-progress\"]>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
".closed>]>; }>, ",
"TypeC",
"<{ closed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; closed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; created_at: ",
"StringC",
"; created_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/sub_case.ts",
"lineNumber": 20
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.SubCasePatchRequestRt",
"type": "Object",
"tags": [],
"label": "SubCasePatchRequestRt",
"description": [],
"signature": [
"IntersectionC",
"<[",
"PartialC",
"<{ status: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
".open>, ",
"LiteralC",
"<typeof ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"[\"in-progress\"]>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
".closed>]>; }>, ",
"TypeC",
"<{ id: ",
"StringC",
"; version: ",
"StringC",
"; }>]>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/sub_case.ts",
"lineNumber": 67
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.SubCaseResponseRt",
"type": "Object",
"tags": [],
"label": "SubCaseResponseRt",
"description": [],
"signature": [
"IntersectionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ status: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
".open>, ",
"LiteralC",
"<typeof ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"[\"in-progress\"]>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
".closed>]>; }>, ",
"TypeC",
"<{ closed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; closed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; created_at: ",
"StringC",
"; created_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>, ",
"TypeC",
"<{ id: ",
"StringC",
"; totalComment: ",
"NumberC",
"; totalAlerts: ",
"NumberC",
"; version: ",
"StringC",
"; }>, ",
"PartialC",
"<{ comments: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ comment: ",
"StringC",
"; type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user>; }>, ",
"TypeC",
"<{ associationType: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".case>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".subCase>]>; created_at: ",
"StringC",
"; created_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; pushed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; pushed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ type: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert>]>; alertId: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"StringC",
"]>; index: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"StringC",
"]>; rule: ",
"TypeC",
"<{ id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; name: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>; }>, ",
"TypeC",
"<{ associationType: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".case>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".subCase>]>; created_at: ",
"StringC",
"; created_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; pushed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; pushed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>]>, ",
"TypeC",
"<{ id: ",
"StringC",
"; version: ",
"StringC",
"; }>]>>; }>]>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/sub_case.ts",
"lineNumber": 44
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.SubCasesFindRequestRt",
"type": "Object",
"tags": [],
"label": "SubCasesFindRequestRt",
"description": [],
"signature": [
"PartialC",
"<{ status: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
".open>, ",
"LiteralC",
"<typeof ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"[\"in-progress\"]>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
".closed>]>; defaultSearchOperator: ",
"UnionC",
"<[",
"LiteralC",
"<\"AND\">, ",
"LiteralC",
"<\"OR\">]>; fields: ",
"ArrayC",
"<",
"StringC",
">; page: ",
"Type",
"<number, string, unknown>; perPage: ",
"Type",
"<number, string, unknown>; search: ",
"StringC",
"; searchFields: ",
"ArrayC",
"<",
"StringC",
">; sortField: ",
"StringC",
"; sortOrder: ",
"UnionC",
"<[",
"LiteralC",
"<\"desc\">, ",
"LiteralC",
"<\"asc\">]>; }>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/sub_case.ts",
"lineNumber": 32
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.SubCasesFindResponseRt",
"type": "Object",
"tags": [],
"label": "SubCasesFindResponseRt",
"description": [],
"signature": [
"IntersectionC",
"<[",
"TypeC",
"<{ subCases: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ status: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
".open>, ",
"LiteralC",
"<typeof ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"[\"in-progress\"]>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
".closed>]>; }>, ",
"TypeC",
"<{ closed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; closed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; created_at: ",
"StringC",
"; created_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>, ",
"TypeC",
"<{ id: ",
"StringC",
"; totalComment: ",
"NumberC",
"; totalAlerts: ",
"NumberC",
"; version: ",
"StringC",
"; }>, ",
"PartialC",
"<{ comments: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ comment: ",
"StringC",
"; type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user>; }>, ",
"TypeC",
"<{ associationType: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".case>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".subCase>]>; created_at: ",
"StringC",
"; created_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; pushed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; pushed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ type: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert>]>; alertId: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"StringC",
"]>; index: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"StringC",
"]>; rule: ",
"TypeC",
"<{ id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; name: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>; }>, ",
"TypeC",
"<{ associationType: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".case>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".subCase>]>; created_at: ",
"StringC",
"; created_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; pushed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; pushed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>]>, ",
"TypeC",
"<{ id: ",
"StringC",
"; version: ",
"StringC",
"; }>]>>; }>]>>; page: ",
"NumberC",
"; per_page: ",
"NumberC",
"; total: ",
"NumberC",
"; }>, ",
"TypeC",
"<{ count_open_cases: ",
"NumberC",
"; count_in_progress_cases: ",
"NumberC",
"; count_closed_cases: ",
"NumberC",
"; }>]>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/sub_case.ts",
"lineNumber": 57
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.SubCasesPatchRequestRt",
"type": "Object",
"tags": [],
"label": "SubCasesPatchRequestRt",
"description": [],
"signature": [
"TypeC",
"<{ subCases: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"PartialC",
"<{ status: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
".open>, ",
"LiteralC",
"<typeof ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"[\"in-progress\"]>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
".closed>]>; }>, ",
"TypeC",
"<{ id: ",
"StringC",
"; version: ",
"StringC",
"; }>]>>; }>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/sub_case.ts",
"lineNumber": 72
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.SubCasesResponseRt",
"type": "Object",
"tags": [],
"label": "SubCasesResponseRt",
"description": [],
"signature": [
"ArrayC",
"<",
"IntersectionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ status: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
".open>, ",
"LiteralC",
"<typeof ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"[\"in-progress\"]>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
".closed>]>; }>, ",
"TypeC",
"<{ closed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; closed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; created_at: ",
"StringC",
"; created_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>, ",
"TypeC",
"<{ id: ",
"StringC",
"; totalComment: ",
"NumberC",
"; totalAlerts: ",
"NumberC",
"; version: ",
"StringC",
"; }>, ",
"PartialC",
"<{ comments: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"UnionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ comment: ",
"StringC",
"; type: ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".user>; }>, ",
"TypeC",
"<{ associationType: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".case>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".subCase>]>; created_at: ",
"StringC",
"; created_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; pushed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; pushed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ type: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".generatedAlert>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CommentType",
"text": "CommentType"
},
".alert>]>; alertId: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"StringC",
"]>; index: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"StringC",
"]>; rule: ",
"TypeC",
"<{ id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; name: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>; }>, ",
"TypeC",
"<{ associationType: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".case>, ",
"LiteralC",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AssociationType",
"text": "AssociationType"
},
".subCase>]>; created_at: ",
"StringC",
"; created_by: ",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>; pushed_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; pushed_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; updated_at: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated_by: ",
"UnionC",
"<[",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>, ",
"NullC",
"]>; }>]>]>, ",
"TypeC",
"<{ id: ",
"StringC",
"; version: ",
"StringC",
"; }>]>>; }>]>>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/cases/sub_case.ts",
"lineNumber": 73
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.UserRT",
"type": "Object",
"tags": [],
"label": "UserRT",
"description": [],
"signature": [
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/user.ts",
"lineNumber": 10
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.UsersRt",
"type": "Object",
"tags": [],
"label": "UsersRt",
"description": [],
"signature": [
"ArrayC",
"<",
"TypeC",
"<{ email: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; full_name: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; username: ",
"UnionC",
"<[",
"UndefinedC",
", ",
"NullC",
", ",
"StringC",
"]>; }>>"
],
"source": {
"path": "x-pack/plugins/cases/common/api/user.ts",
"lineNumber": 16
},
"deprecated": false,
"initialIsOpen": false
}
]
}
}