mirror of
https://github.com/elastic/kibana.git
synced 2025-04-23 17:28:26 -04:00
[DOCS] Automate docs for get case APIs (#144950)
This commit is contained in:
Lisa Cawley
GitHub
parent
d5ed159eb5
commit
6804cffc5f
17 changed files with 1412 additions and 50 deletions
|
|
@ -21,9 +21,16 @@ Any modifications made to this file will be overwritten.
|
|||
<li><a href="#addCaseComment"><code><span class="http-method">post</span> /s/{spaceId}/api/cases/{caseId}/comments</code></a></li>
|
||||
<li><a href="#createCase"><code><span class="http-method">post</span> /s/{spaceId}/api/cases</code></a></li>
|
||||
<li><a href="#deleteCase"><code><span class="http-method">delete</span> /s/{spaceId}/api/cases</code></a></li>
|
||||
<li><a href="#deleteCaseComment"><code><span class="http-method">delete</span> /s/{spaceId}/api/cases/{caseId}/comments/{commentId}</code></a></li>
|
||||
<li><a href="#deleteCaseComments"><code><span class="http-method">delete</span> /s/{spaceId}/api/cases/{caseId}/comments</code></a></li>
|
||||
<li><a href="#getAllCaseComments"><code><span class="http-method">get</span> /s/{spaceId}/api/cases/{caseId}/comments</code></a></li>
|
||||
<li><a href="#getCase"><code><span class="http-method">get</span> /s/{spaceId}/api/cases/{caseId}</code></a></li>
|
||||
<li><a href="#getCaseComment"><code><span class="http-method">get</span> /s/{spaceId}/api/cases/{caseId}/comments/{commentId}</code></a></li>
|
||||
<li><a href="#getCaseConfiguration"><code><span class="http-method">get</span> /s/{spaceId}/api/cases/configure</code></a></li>
|
||||
<li><a href="#getCaseReporters"><code><span class="http-method">get</span> /s/{spaceId}/api/cases/reporters</code></a></li>
|
||||
<li><a href="#getCaseStatus"><code><span class="http-method">get</span> /s/{spaceId}/api/cases/status</code></a></li>
|
||||
<li><a href="#getCaseTags"><code><span class="http-method">get</span> /s/{spaceId}/api/cases/tags</code></a></li>
|
||||
<li><a href="#getCasesByAlert"><code><span class="http-method">get</span> /s/{spaceId}/api/cases/alerts/{alertId}</code></a></li>
|
||||
<li><a href="#pushCase"><code><span class="http-method">post</span> /s/{spaceId}/api/cases/{caseId}/connector/{connectorId}/_push</code></a></li>
|
||||
<li><a href="#setCaseConfiguration"><code><span class="http-method">post</span> /s/{spaceId}/api/cases/configure</code></a></li>
|
||||
<li><a href="#updateCase"><code><span class="http-method">patch</span> /s/{spaceId}/api/cases</code></a></li>
|
||||
|
|
@ -301,6 +308,47 @@ Any modifications made to this file will be overwritten.
|
|||
|
||||
|
||||
|
||||
<!--Todo: process Response Object and its headers, schema, examples -->
|
||||
|
||||
|
||||
|
||||
<h3 class="field-label">Responses</h3>
|
||||
<h4 class="field-label">204</h4>
|
||||
Indicates a successful call.
|
||||
<a href="#"></a>
|
||||
</div> <!-- method -->
|
||||
<hr/>
|
||||
<div class="method"><a name="deleteCaseComment"/>
|
||||
<div class="method-path">
|
||||
<a class="up" href="#__Methods">Up</a>
|
||||
<pre class="delete"><code class="huge"><span class="http-method">delete</span> /s/{spaceId}/api/cases/{caseId}/comments/{commentId}</code></pre></div>
|
||||
<div class="method-summary">Deletes a comment or alert from a case. (<span class="nickname">deleteCaseComment</span>)</div>
|
||||
<div class="method-notes">You must have <code>all</code> privileges for the <strong>Cases</strong> feature in the <strong>Management</strong>, <strong>Observability</strong>, or <strong>Security</strong> section of the Kibana feature privileges, depending on the owner of the cases you're deleting.</div>
|
||||
|
||||
<h3 class="field-label">Path parameters</h3>
|
||||
<div class="field-items">
|
||||
<div class="param">caseId (required)</div>
|
||||
|
||||
<div class="param-desc"><span class="param-type">Path Parameter</span> — The identifier for the case. To retrieve case IDs, use the find cases API. All non-ASCII characters must be URL encoded. default: null </div><div class="param">commentId (required)</div>
|
||||
|
||||
<div class="param-desc"><span class="param-type">Path Parameter</span> — The identifier for the comment. To retrieve comment IDs, use the get case or find cases APIs. default: null </div><div class="param">spaceId (required)</div>
|
||||
|
||||
<div class="param-desc"><span class="param-type">Path Parameter</span> — An identifier for the space. If <code>/s/</code> and the identifier are omitted from the path, the default space is used. default: null </div>
|
||||
</div> <!-- field-items -->
|
||||
|
||||
|
||||
|
||||
<h3 class="field-label">Request headers</h3>
|
||||
<div class="field-items">
|
||||
<div class="param">kbn-xsrf (required)</div>
|
||||
|
||||
<div class="param-desc"><span class="param-type">Header Parameter</span> — default: null </div>
|
||||
|
||||
</div> <!-- field-items -->
|
||||
|
||||
|
||||
|
||||
|
||||
<!--Todo: process Response Object and its headers, schema, examples -->
|
||||
|
||||
|
||||
|
|
@ -450,6 +498,160 @@ Any modifications made to this file will be overwritten.
|
|||
<a href="#case_response_properties">case_response_properties</a>
|
||||
</div> <!-- method -->
|
||||
<hr/>
|
||||
<div class="method"><a name="getCase"/>
|
||||
<div class="method-path">
|
||||
<a class="up" href="#__Methods">Up</a>
|
||||
<pre class="get"><code class="huge"><span class="http-method">get</span> /s/{spaceId}/api/cases/{caseId}</code></pre></div>
|
||||
<div class="method-summary">Retrieves information about a case. (<span class="nickname">getCase</span>)</div>
|
||||
<div class="method-notes">You must have <code>read</code> privileges for the <strong>Cases</strong> feature in the <strong>Management</strong>, <strong>Observability</strong>, or <strong>Security</strong> section of the Kibana feature privileges, depending on the owner of the case you're seeking.</div>
|
||||
|
||||
<h3 class="field-label">Path parameters</h3>
|
||||
<div class="field-items">
|
||||
<div class="param">caseId (required)</div>
|
||||
|
||||
<div class="param-desc"><span class="param-type">Path Parameter</span> — The identifier for the case. To retrieve case IDs, use the find cases API. All non-ASCII characters must be URL encoded. default: null </div><div class="param">spaceId (required)</div>
|
||||
|
||||
<div class="param-desc"><span class="param-type">Path Parameter</span> — An identifier for the space. If <code>/s/</code> and the identifier are omitted from the path, the default space is used. default: null </div>
|
||||
</div> <!-- field-items -->
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 class="field-label">Query parameters</h3>
|
||||
<div class="field-items">
|
||||
<div class="param">includeComments (optional)</div>
|
||||
|
||||
<div class="param-desc"><span class="param-type">Query Parameter</span> — Determines whether case comments are returned. default: true </div>
|
||||
</div> <!-- field-items -->
|
||||
|
||||
|
||||
<h3 class="field-label">Return type</h3>
|
||||
<div class="return-type">
|
||||
<a href="#case_response_properties">case_response_properties</a>
|
||||
|
||||
</div>
|
||||
|
||||
<!--Todo: process Response Object and its headers, schema, examples -->
|
||||
|
||||
<h3 class="field-label">Example data</h3>
|
||||
<div class="example-data-content-type">Content-Type: application/json</div>
|
||||
<pre class="example"><code>{
|
||||
"owner" : "cases",
|
||||
"totalComment" : 0,
|
||||
"settings" : {
|
||||
"syncAlerts" : true
|
||||
},
|
||||
"totalAlerts" : 0,
|
||||
"closed_at" : "2000-01-23T04:56:07.000+00:00",
|
||||
"comments" : [ null, null ],
|
||||
"assignees" : [ {
|
||||
"uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0"
|
||||
}, {
|
||||
"uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0"
|
||||
} ],
|
||||
"created_at" : "2022-05-13T09:16:17.416Z",
|
||||
"description" : "A case description.",
|
||||
"title" : "Case title 1",
|
||||
"created_by" : {
|
||||
"full_name" : "full_name",
|
||||
"profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
|
||||
"email" : "email",
|
||||
"username" : "elastic"
|
||||
},
|
||||
"version" : "WzUzMiwxXQ==",
|
||||
"closed_by" : {
|
||||
"full_name" : "full_name",
|
||||
"profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
|
||||
"email" : "email",
|
||||
"username" : "elastic"
|
||||
},
|
||||
"tags" : [ "tag-1" ],
|
||||
"duration" : 120,
|
||||
"updated_at" : "2000-01-23T04:56:07.000+00:00",
|
||||
"updated_by" : {
|
||||
"full_name" : "full_name",
|
||||
"profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
|
||||
"email" : "email",
|
||||
"username" : "elastic"
|
||||
},
|
||||
"id" : "66b9aa00-94fa-11ea-9f74-e7e108796192",
|
||||
"external_service" : {
|
||||
"external_title" : "external_title",
|
||||
"pushed_by" : {
|
||||
"full_name" : "full_name",
|
||||
"profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
|
||||
"email" : "email",
|
||||
"username" : "elastic"
|
||||
},
|
||||
"external_url" : "external_url",
|
||||
"pushed_at" : "2000-01-23T04:56:07.000+00:00",
|
||||
"connector_id" : "connector_id",
|
||||
"external_id" : "external_id",
|
||||
"connector_name" : "connector_name"
|
||||
}
|
||||
}</code></pre>
|
||||
|
||||
<h3 class="field-label">Produces</h3>
|
||||
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
||||
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
||||
<ul>
|
||||
<li><code>application/json</code></li>
|
||||
</ul>
|
||||
|
||||
<h3 class="field-label">Responses</h3>
|
||||
<h4 class="field-label">200</h4>
|
||||
Indicates a successful call.
|
||||
<a href="#case_response_properties">case_response_properties</a>
|
||||
</div> <!-- method -->
|
||||
<hr/>
|
||||
<div class="method"><a name="getCaseComment"/>
|
||||
<div class="method-path">
|
||||
<a class="up" href="#__Methods">Up</a>
|
||||
<pre class="get"><code class="huge"><span class="http-method">get</span> /s/{spaceId}/api/cases/{caseId}/comments/{commentId}</code></pre></div>
|
||||
<div class="method-summary">Retrieves a comment from a case. (<span class="nickname">getCaseComment</span>)</div>
|
||||
<div class="method-notes">You must have <code>read</code> privileges for the <strong>Cases</strong> feature in the <strong>Management</strong>, <strong>Observability</strong>, or <strong>Security</strong> section of the Kibana feature privileges, depending on the owner of the cases with the comments you're seeking.</div>
|
||||
|
||||
<h3 class="field-label">Path parameters</h3>
|
||||
<div class="field-items">
|
||||
<div class="param">caseId (required)</div>
|
||||
|
||||
<div class="param-desc"><span class="param-type">Path Parameter</span> — The identifier for the case. To retrieve case IDs, use the find cases API. All non-ASCII characters must be URL encoded. default: null </div><div class="param">commentId (required)</div>
|
||||
|
||||
<div class="param-desc"><span class="param-type">Path Parameter</span> — The identifier for the comment. To retrieve comment IDs, use the get case or find cases APIs. default: null </div><div class="param">spaceId (required)</div>
|
||||
|
||||
<div class="param-desc"><span class="param-type">Path Parameter</span> — An identifier for the space. If <code>/s/</code> and the identifier are omitted from the path, the default space is used. default: null </div>
|
||||
</div> <!-- field-items -->
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 class="field-label">Return type</h3>
|
||||
<div class="return-type">
|
||||
<a href="#getCaseComment_200_response">getCaseComment_200_response</a>
|
||||
|
||||
</div>
|
||||
|
||||
<!--Todo: process Response Object and its headers, schema, examples -->
|
||||
|
||||
<h3 class="field-label">Example data</h3>
|
||||
<div class="example-data-content-type">Content-Type: application/json</div>
|
||||
<pre class="example"><code>null</code></pre>
|
||||
|
||||
<h3 class="field-label">Produces</h3>
|
||||
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
||||
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
||||
<ul>
|
||||
<li><code>application/json</code></li>
|
||||
</ul>
|
||||
|
||||
<h3 class="field-label">Responses</h3>
|
||||
<h4 class="field-label">200</h4>
|
||||
Indicates a successful call.
|
||||
<a href="#getCaseComment_200_response">getCaseComment_200_response</a>
|
||||
</div> <!-- method -->
|
||||
<hr/>
|
||||
<div class="method"><a name="getCaseConfiguration"/>
|
||||
<div class="method-path">
|
||||
<a class="up" href="#__Methods">Up</a>
|
||||
|
|
@ -484,7 +686,7 @@ Any modifications made to this file will be overwritten.
|
|||
<!--Todo: process Response Object and its headers, schema, examples -->
|
||||
|
||||
<h3 class="field-label">Example data</h3>
|
||||
<div class="example-data-content-type">Content-Type: application/json; charset=utf-8</div>
|
||||
<div class="example-data-content-type">Content-Type: application/json</div>
|
||||
<pre class="example"><code>{
|
||||
"closure_type" : "close-by-user",
|
||||
"owner" : "cases",
|
||||
|
|
@ -524,7 +726,221 @@ Any modifications made to this file will be overwritten.
|
|||
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
||||
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
||||
<ul>
|
||||
<li><code>application/json; charset=utf-8</code></li>
|
||||
<li><code>application/json</code></li>
|
||||
</ul>
|
||||
|
||||
<h3 class="field-label">Responses</h3>
|
||||
<h4 class="field-label">200</h4>
|
||||
Indicates a successful call.
|
||||
|
||||
</div> <!-- method -->
|
||||
<hr/>
|
||||
<div class="method"><a name="getCaseReporters"/>
|
||||
<div class="method-path">
|
||||
<a class="up" href="#__Methods">Up</a>
|
||||
<pre class="get"><code class="huge"><span class="http-method">get</span> /s/{spaceId}/api/cases/reporters</code></pre></div>
|
||||
<div class="method-summary">Returns information about the users who opened cases. (<span class="nickname">getCaseReporters</span>)</div>
|
||||
<div class="method-notes">You must have read privileges for the <strong>Cases</strong> feature in the <strong>Management</strong>, <strong>Observability</strong>, or <strong>Security</strong> section of the Kibana feature privileges, depending on the owner of the cases. The API returns information about the users as they existed at the time of the case creation, including their name, full name, and email address. If any of those details change thereafter or if a user is deleted, the information returned by this API is unchanged.</div>
|
||||
|
||||
<h3 class="field-label">Path parameters</h3>
|
||||
<div class="field-items">
|
||||
<div class="param">spaceId (required)</div>
|
||||
|
||||
<div class="param-desc"><span class="param-type">Path Parameter</span> — An identifier for the space. If <code>/s/</code> and the identifier are omitted from the path, the default space is used. default: null </div>
|
||||
</div> <!-- field-items -->
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 class="field-label">Query parameters</h3>
|
||||
<div class="field-items">
|
||||
<div class="param">owner (optional)</div>
|
||||
|
||||
<div class="param-desc"><span class="param-type">Query Parameter</span> — A filter to limit the response to a specific set of applications. If this parameter is omitted, the response contains information about all the cases that the user has access to read. default: null </div>
|
||||
</div> <!-- field-items -->
|
||||
|
||||
|
||||
<h3 class="field-label">Return type</h3>
|
||||
<div class="return-type">
|
||||
array[<a href="#getCaseReporters_200_response_inner">getCaseReporters_200_response_inner</a>]
|
||||
|
||||
</div>
|
||||
|
||||
<!--Todo: process Response Object and its headers, schema, examples -->
|
||||
|
||||
<h3 class="field-label">Example data</h3>
|
||||
<div class="example-data-content-type">Content-Type: application/json</div>
|
||||
<pre class="example"><code>{
|
||||
"full_name" : "full_name",
|
||||
"profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
|
||||
"email" : "email",
|
||||
"username" : "elastic"
|
||||
}</code></pre>
|
||||
|
||||
<h3 class="field-label">Produces</h3>
|
||||
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
||||
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
||||
<ul>
|
||||
<li><code>application/json</code></li>
|
||||
</ul>
|
||||
|
||||
<h3 class="field-label">Responses</h3>
|
||||
<h4 class="field-label">200</h4>
|
||||
Indicates a successful call.
|
||||
|
||||
</div> <!-- method -->
|
||||
<hr/>
|
||||
<div class="method"><a name="getCaseStatus"/>
|
||||
<div class="method-path">
|
||||
<a class="up" href="#__Methods">Up</a>
|
||||
<pre class="get"><code class="huge"><span class="http-method">get</span> /s/{spaceId}/api/cases/status</code></pre></div>
|
||||
<div class="method-summary">Returns the number of cases that are open, closed, and in progress. (<span class="nickname">getCaseStatus</span>)</div>
|
||||
<div class="method-notes">You must have <code>read</code> privileges for the <strong>Cases</strong> feature in the <strong>Management</strong>, <strong>Observability</strong>, or <strong>Security</strong> section of the Kibana feature privileges, depending on the owner of the cases you're seeking.</div>
|
||||
|
||||
<h3 class="field-label">Path parameters</h3>
|
||||
<div class="field-items">
|
||||
<div class="param">spaceId (required)</div>
|
||||
|
||||
<div class="param-desc"><span class="param-type">Path Parameter</span> — An identifier for the space. If <code>/s/</code> and the identifier are omitted from the path, the default space is used. default: null </div>
|
||||
</div> <!-- field-items -->
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 class="field-label">Query parameters</h3>
|
||||
<div class="field-items">
|
||||
<div class="param">owner (optional)</div>
|
||||
|
||||
<div class="param-desc"><span class="param-type">Query Parameter</span> — A filter to limit the response to a specific set of applications. If this parameter is omitted, the response contains information about all the cases that the user has access to read. default: null </div>
|
||||
</div> <!-- field-items -->
|
||||
|
||||
|
||||
<h3 class="field-label">Return type</h3>
|
||||
<div class="return-type">
|
||||
<a href="#getCaseStatus_200_response">getCaseStatus_200_response</a>
|
||||
|
||||
</div>
|
||||
|
||||
<!--Todo: process Response Object and its headers, schema, examples -->
|
||||
|
||||
<h3 class="field-label">Example data</h3>
|
||||
<div class="example-data-content-type">Content-Type: application/json</div>
|
||||
<pre class="example"><code>{
|
||||
"count_in_progress_cases" : 6,
|
||||
"count_open_cases" : 1,
|
||||
"count_closed_cases" : 0
|
||||
}</code></pre>
|
||||
|
||||
<h3 class="field-label">Produces</h3>
|
||||
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
||||
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
||||
<ul>
|
||||
<li><code>application/json</code></li>
|
||||
</ul>
|
||||
|
||||
<h3 class="field-label">Responses</h3>
|
||||
<h4 class="field-label">200</h4>
|
||||
Indicates a successful call.
|
||||
<a href="#getCaseStatus_200_response">getCaseStatus_200_response</a>
|
||||
</div> <!-- method -->
|
||||
<hr/>
|
||||
<div class="method"><a name="getCaseTags"/>
|
||||
<div class="method-path">
|
||||
<a class="up" href="#__Methods">Up</a>
|
||||
<pre class="get"><code class="huge"><span class="http-method">get</span> /s/{spaceId}/api/cases/tags</code></pre></div>
|
||||
<div class="method-summary">Aggregates and returns a list of case tags. (<span class="nickname">getCaseTags</span>)</div>
|
||||
<div class="method-notes">You must have read privileges for the <strong>Cases</strong> feature in the <strong>Management</strong>, <strong>Observability</strong>, or <strong>Security</strong> section of the Kibana feature privileges, depending on the owner of the cases you're seeking.</div>
|
||||
|
||||
<h3 class="field-label">Path parameters</h3>
|
||||
<div class="field-items">
|
||||
<div class="param">spaceId (required)</div>
|
||||
|
||||
<div class="param-desc"><span class="param-type">Path Parameter</span> — An identifier for the space. If <code>/s/</code> and the identifier are omitted from the path, the default space is used. default: null </div>
|
||||
</div> <!-- field-items -->
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 class="field-label">Query parameters</h3>
|
||||
<div class="field-items">
|
||||
<div class="param">owner (optional)</div>
|
||||
|
||||
<div class="param-desc"><span class="param-type">Query Parameter</span> — A filter to limit the retrieved case statistics to a specific set of applications. If this parameter is omitted, the response contains tags from all cases that the user has access to read. default: null </div>
|
||||
</div> <!-- field-items -->
|
||||
|
||||
|
||||
<h3 class="field-label">Return type</h3>
|
||||
<div class="return-type">
|
||||
|
||||
array[String]
|
||||
</div>
|
||||
|
||||
<!--Todo: process Response Object and its headers, schema, examples -->
|
||||
|
||||
<h3 class="field-label">Example data</h3>
|
||||
<div class="example-data-content-type">Content-Type: application/json</div>
|
||||
<pre class="example"><code>""</code></pre>
|
||||
|
||||
<h3 class="field-label">Produces</h3>
|
||||
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
||||
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
||||
<ul>
|
||||
<li><code>application/json</code></li>
|
||||
</ul>
|
||||
|
||||
<h3 class="field-label">Responses</h3>
|
||||
<h4 class="field-label">200</h4>
|
||||
Indicates a successful call.
|
||||
|
||||
</div> <!-- method -->
|
||||
<hr/>
|
||||
<div class="method"><a name="getCasesByAlert"/>
|
||||
<div class="method-path">
|
||||
<a class="up" href="#__Methods">Up</a>
|
||||
<pre class="get"><code class="huge"><span class="http-method">get</span> /s/{spaceId}/api/cases/alerts/{alertId}</code></pre></div>
|
||||
<div class="method-summary">Returns the cases associated with a specific alert. (<span class="nickname">getCasesByAlert</span>)</div>
|
||||
<div class="method-notes">You must have <code>read</code> privileges for the <strong>Cases</strong> feature in the <strong>Management</strong>, <strong>Observability</strong>, or <strong>Security</strong> section of the Kibana feature privileges, depending on the owner of the cases you're seeking.</div>
|
||||
|
||||
<h3 class="field-label">Path parameters</h3>
|
||||
<div class="field-items">
|
||||
<div class="param">alertId (required)</div>
|
||||
|
||||
<div class="param-desc"><span class="param-type">Path Parameter</span> — An identifier for the alert. default: null </div><div class="param">spaceId (required)</div>
|
||||
|
||||
<div class="param-desc"><span class="param-type">Path Parameter</span> — An identifier for the space. If <code>/s/</code> and the identifier are omitted from the path, the default space is used. default: null </div>
|
||||
</div> <!-- field-items -->
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 class="field-label">Query parameters</h3>
|
||||
<div class="field-items">
|
||||
<div class="param">owner (optional)</div>
|
||||
|
||||
<div class="param-desc"><span class="param-type">Query Parameter</span> — A filter to limit the response to a specific set of applications. If this parameter is omitted, the response contains information about all the cases that the user has access to read. default: null </div>
|
||||
</div> <!-- field-items -->
|
||||
|
||||
|
||||
<h3 class="field-label">Return type</h3>
|
||||
<div class="return-type">
|
||||
array[<a href="#getCasesByAlert_200_response_inner">getCasesByAlert_200_response_inner</a>]
|
||||
|
||||
</div>
|
||||
|
||||
<!--Todo: process Response Object and its headers, schema, examples -->
|
||||
|
||||
<h3 class="field-label">Example data</h3>
|
||||
<div class="example-data-content-type">Content-Type: application/json</div>
|
||||
<pre class="example"><code>[ {
|
||||
"id" : "06116b80-e1c3-11ec-be9b-9b1838238ee6",
|
||||
"title" : "security_case"
|
||||
} ]</code></pre>
|
||||
|
||||
<h3 class="field-label">Produces</h3>
|
||||
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
||||
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
||||
<ul>
|
||||
<li><code>application/json</code></li>
|
||||
</ul>
|
||||
|
||||
<h3 class="field-label">Responses</h3>
|
||||
|
|
@ -701,7 +1117,7 @@ Any modifications made to this file will be overwritten.
|
|||
<!--Todo: process Response Object and its headers, schema, examples -->
|
||||
|
||||
<h3 class="field-label">Example data</h3>
|
||||
<div class="example-data-content-type">Content-Type: application/json; charset=utf-8</div>
|
||||
<div class="example-data-content-type">Content-Type: application/json</div>
|
||||
<pre class="example"><code>{
|
||||
"closure_type" : "close-by-user",
|
||||
"owner" : "cases",
|
||||
|
|
@ -741,7 +1157,7 @@ Any modifications made to this file will be overwritten.
|
|||
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
||||
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
||||
<ul>
|
||||
<li><code>application/json; charset=utf-8</code></li>
|
||||
<li><code>application/json</code></li>
|
||||
</ul>
|
||||
|
||||
<h3 class="field-label">Responses</h3>
|
||||
|
|
@ -1035,7 +1451,7 @@ Any modifications made to this file will be overwritten.
|
|||
<!--Todo: process Response Object and its headers, schema, examples -->
|
||||
|
||||
<h3 class="field-label">Example data</h3>
|
||||
<div class="example-data-content-type">Content-Type: application/json; charset=utf-8</div>
|
||||
<div class="example-data-content-type">Content-Type: application/json</div>
|
||||
<pre class="example"><code>{
|
||||
"closure_type" : "close-by-user",
|
||||
"owner" : "cases",
|
||||
|
|
@ -1075,7 +1491,7 @@ Any modifications made to this file will be overwritten.
|
|||
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
||||
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
|
||||
<ul>
|
||||
<li><code>application/json; charset=utf-8</code></li>
|
||||
<li><code>application/json</code></li>
|
||||
</ul>
|
||||
|
||||
<h3 class="field-label">Responses</h3>
|
||||
|
|
@ -1096,7 +1512,6 @@ Any modifications made to this file will be overwritten.
|
|||
<li><a href="#add_case_comment_request"><code>add_case_comment_request</code> - Add case comment request</a></li>
|
||||
<li><a href="#add_user_comment_request_properties"><code>add_user_comment_request_properties</code> - Add case comment request properties for user comments</a></li>
|
||||
<li><a href="#alert_comment_response_properties"><code>alert_comment_response_properties</code> - Add case comment response properties for alerts</a></li>
|
||||
<li><a href="#alert_comment_response_properties_created_by"><code>alert_comment_response_properties_created_by</code> - </a></li>
|
||||
<li><a href="#alert_comment_response_properties_pushed_by"><code>alert_comment_response_properties_pushed_by</code> - </a></li>
|
||||
<li><a href="#alert_comment_response_properties_rule"><code>alert_comment_response_properties_rule</code> - </a></li>
|
||||
<li><a href="#alert_identifiers"><code>alert_identifiers</code> - Alert identifiers</a></li>
|
||||
|
|
@ -1125,12 +1540,16 @@ Any modifications made to this file will be overwritten.
|
|||
<li><a href="#create_case_request_assignees_inner"><code>create_case_request_assignees_inner</code> - </a></li>
|
||||
<li><a href="#create_case_request_connector"><code>create_case_request_connector</code> - </a></li>
|
||||
<li><a href="#external_service"><code>external_service</code> - </a></li>
|
||||
<li><a href="#getCaseComment_200_response"><code>getCaseComment_200_response</code> - </a></li>
|
||||
<li><a href="#getCaseConfiguration_200_response_inner"><code>getCaseConfiguration_200_response_inner</code> - </a></li>
|
||||
<li><a href="#getCaseConfiguration_200_response_inner_connector"><code>getCaseConfiguration_200_response_inner_connector</code> - </a></li>
|
||||
<li><a href="#getCaseConfiguration_200_response_inner_created_by"><code>getCaseConfiguration_200_response_inner_created_by</code> - </a></li>
|
||||
<li><a href="#getCaseConfiguration_200_response_inner_mappings_inner"><code>getCaseConfiguration_200_response_inner_mappings_inner</code> - </a></li>
|
||||
<li><a href="#getCaseConfiguration_200_response_inner_updated_by"><code>getCaseConfiguration_200_response_inner_updated_by</code> - </a></li>
|
||||
<li><a href="#getCaseConfiguration_owner_parameter"><code>getCaseConfiguration_owner_parameter</code> - </a></li>
|
||||
<li><a href="#getCaseReporters_200_response_inner"><code>getCaseReporters_200_response_inner</code> - </a></li>
|
||||
<li><a href="#getCaseStatus_200_response"><code>getCaseStatus_200_response</code> - </a></li>
|
||||
<li><a href="#getCasesByAlert_200_response_inner"><code>getCasesByAlert_200_response_inner</code> - </a></li>
|
||||
<li><a href="#getCasesByAlert_owner_parameter"><code>getCasesByAlert_owner_parameter</code> - </a></li>
|
||||
<li><a href="#owners"><code>owners</code> - </a></li>
|
||||
<li><a href="#rule"><code>rule</code> - Alerting rule</a></li>
|
||||
<li><a href="#setCaseConfiguration_request"><code>setCaseConfiguration_request</code> - </a></li>
|
||||
|
|
@ -1226,7 +1645,7 @@ Any modifications made to this file will be overwritten.
|
|||
<div class="field-items">
|
||||
<div class="param">alertId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
||||
<div class="param">created_at (optional)</div><div class="param-desc"><span class="param-type"><a href="#DateTime">Date</a></span> format: date-time</div>
|
||||
<div class="param">created_by (optional)</div><div class="param-desc"><span class="param-type"><a href="#alert_comment_response_properties_created_by">alert_comment_response_properties_created_by</a></span> </div>
|
||||
<div class="param">created_by (optional)</div><div class="param-desc"><span class="param-type"><a href="#getCaseReporters_200_response_inner">getCaseReporters_200_response_inner</a></span> </div>
|
||||
<div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
||||
<div class="param">index (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
||||
<div class="param">owner (optional)</div><div class="param-desc"><span class="param-type"><a href="#owners">owners</a></span> </div>
|
||||
|
|
@ -1237,20 +1656,10 @@ Any modifications made to this file will be overwritten.
|
|||
<div class="param-enum-header">Enum:</div>
|
||||
<div class="param-enum">alert</div>
|
||||
<div class="param">updated_at (optional)</div><div class="param-desc"><span class="param-type"><a href="#DateTime">Date</a></span> format: date-time</div>
|
||||
<div class="param">updated_by (optional)</div><div class="param-desc"><span class="param-type"><a href="#alert_comment_response_properties_created_by">alert_comment_response_properties_created_by</a></span> </div>
|
||||
<div class="param">updated_by (optional)</div><div class="param-desc"><span class="param-type"><a href="#getCaseReporters_200_response_inner">getCaseReporters_200_response_inner</a></span> </div>
|
||||
<div class="param">version (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
||||
</div> <!-- field-items -->
|
||||
</div>
|
||||
<div class="model">
|
||||
<h3><a name="alert_comment_response_properties_created_by"><code>alert_comment_response_properties_created_by</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
||||
<div class='model-description'></div>
|
||||
<div class="field-items">
|
||||
<div class="param">email (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
||||
<div class="param">full_name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
||||
<div class="param">username (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
||||
<div class="param">profile_uid (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
||||
</div> <!-- field-items -->
|
||||
</div>
|
||||
<div class="model">
|
||||
<h3><a name="alert_comment_response_properties_pushed_by"><code>alert_comment_response_properties_pushed_by</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
||||
<div class='model-description'></div>
|
||||
|
|
@ -1546,6 +1955,28 @@ Any modifications made to this file will be overwritten.
|
|||
<div class="param">pushed_by (optional)</div><div class="param-desc"><span class="param-type"><a href="#alert_comment_response_properties_pushed_by">alert_comment_response_properties_pushed_by</a></span> </div>
|
||||
</div> <!-- field-items -->
|
||||
</div>
|
||||
<div class="model">
|
||||
<h3><a name="getCaseComment_200_response"><code>getCaseComment_200_response</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
||||
<div class='model-description'></div>
|
||||
<div class="field-items">
|
||||
<div class="param">alertId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
||||
<div class="param">created_at (optional)</div><div class="param-desc"><span class="param-type"><a href="#DateTime">Date</a></span> format: date-time</div>
|
||||
<div class="param">created_by (optional)</div><div class="param-desc"><span class="param-type"><a href="#case_response_created_by_properties">case_response_created_by_properties</a></span> </div>
|
||||
<div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
||||
<div class="param">index (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
||||
<div class="param">owner (optional)</div><div class="param-desc"><span class="param-type"><a href="#owners">owners</a></span> </div>
|
||||
<div class="param">pushed_at (optional)</div><div class="param-desc"><span class="param-type"><a href="#DateTime">Date</a></span> format: date-time</div>
|
||||
<div class="param">pushed_by (optional)</div><div class="param-desc"><span class="param-type"><a href="#case_response_pushed_by_properties">case_response_pushed_by_properties</a></span> </div>
|
||||
<div class="param">rule (optional)</div><div class="param-desc"><span class="param-type"><a href="#alert_comment_response_properties_rule">alert_comment_response_properties_rule</a></span> </div>
|
||||
<div class="param">type </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
||||
<div class="param-enum-header">Enum:</div>
|
||||
<div class="param-enum">user</div>
|
||||
<div class="param">updated_at (optional)</div><div class="param-desc"><span class="param-type"><a href="#DateTime">Date</a></span> format: date-time</div>
|
||||
<div class="param">updated_by (optional)</div><div class="param-desc"><span class="param-type"><a href="#case_response_updated_by_properties">case_response_updated_by_properties</a></span> </div>
|
||||
<div class="param">version (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
||||
<div class="param">comment (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
||||
</div> <!-- field-items -->
|
||||
</div>
|
||||
<div class="model">
|
||||
<h3><a name="getCaseConfiguration_200_response_inner"><code>getCaseConfiguration_200_response_inner</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
||||
<div class='model-description'></div>
|
||||
|
|
@ -1601,7 +2032,34 @@ Any modifications made to this file will be overwritten.
|
|||
</div> <!-- field-items -->
|
||||
</div>
|
||||
<div class="model">
|
||||
<h3><a name="getCaseConfiguration_owner_parameter"><code>getCaseConfiguration_owner_parameter</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
||||
<h3><a name="getCaseReporters_200_response_inner"><code>getCaseReporters_200_response_inner</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
||||
<div class='model-description'></div>
|
||||
<div class="field-items">
|
||||
<div class="param">email (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
||||
<div class="param">full_name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
||||
<div class="param">username (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
||||
<div class="param">profile_uid (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
||||
</div> <!-- field-items -->
|
||||
</div>
|
||||
<div class="model">
|
||||
<h3><a name="getCaseStatus_200_response"><code>getCaseStatus_200_response</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
||||
<div class='model-description'></div>
|
||||
<div class="field-items">
|
||||
<div class="param">count_closed_cases (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> </div>
|
||||
<div class="param">count_in_progress_cases (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> </div>
|
||||
<div class="param">count_open_cases (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> </div>
|
||||
</div> <!-- field-items -->
|
||||
</div>
|
||||
<div class="model">
|
||||
<h3><a name="getCasesByAlert_200_response_inner"><code>getCasesByAlert_200_response_inner</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
||||
<div class='model-description'></div>
|
||||
<div class="field-items">
|
||||
<div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The case identifier. </div>
|
||||
<div class="param">title (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The case title. </div>
|
||||
</div> <!-- field-items -->
|
||||
</div>
|
||||
<div class="model">
|
||||
<h3><a name="getCasesByAlert_owner_parameter"><code>getCasesByAlert_owner_parameter</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
||||
<div class='model-description'></div>
|
||||
<div class="field-items">
|
||||
</div> <!-- field-items -->
|
||||
|
|
|
|||
|
|
@ -6,6 +6,12 @@
|
|||
|
||||
Returns information about a case.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
For the most up-to-date API details, refer to the
|
||||
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification]. For a preview, check out <<case-apis>>.
|
||||
====
|
||||
|
||||
=== {api-request-title}
|
||||
|
||||
`GET <kibana host>:<port>/api/cases/<case ID>`
|
||||
|
|
|
|||
|
|
@ -8,6 +8,13 @@ preview::[]
|
|||
|
||||
Returns the cases associated with a specific alert.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
For the most up-to-date API details, refer to the
|
||||
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification]. For a preview, check out <<case-apis>>.
|
||||
====
|
||||
|
||||
|
||||
=== {api-request-title}
|
||||
|
||||
`GET <kibana host>:<port>/api/cases/alerts/<alert_id>`
|
||||
|
|
|
|||
|
|
@ -6,6 +6,13 @@
|
|||
|
||||
Returns information about the users who opened cases.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
For the most up-to-date API details, refer to the
|
||||
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification]. For a preview, check out <<case-apis>>.
|
||||
====
|
||||
|
||||
|
||||
=== {api-request-title}
|
||||
|
||||
`GET <kibana host>:<port>/api/cases/reporters`
|
||||
|
|
|
|||
|
|
@ -6,6 +6,12 @@
|
|||
|
||||
Returns the number of cases that are open, closed, and in progress.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
For the most up-to-date API details, refer to the
|
||||
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification]. For a preview, check out <<case-apis>>.
|
||||
====
|
||||
|
||||
deprecated::[8.1.0]
|
||||
|
||||
=== {api-request-title}
|
||||
|
|
|
|||
|
|
@ -6,6 +6,12 @@
|
|||
|
||||
Aggregates and returns a list of case tags.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
For the most up-to-date API details, refer to the
|
||||
{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification]. For a preview, check out <<case-apis>>.
|
||||
====
|
||||
|
||||
=== {api-request-title}
|
||||
|
||||
`GET <kibana host>:<port>/api/cases/tags`
|
||||
|
|
|
|||
|
|
@ -176,6 +176,69 @@
|
|||
}
|
||||
]
|
||||
},
|
||||
"/s/{spaceId}/api/cases/alerts/{alertId}": {
|
||||
"get": {
|
||||
"summary": "Returns the cases associated with a specific alert.",
|
||||
"operationId": "getCasesByAlert",
|
||||
"description": "You must have `read` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the cases you're seeking.\n",
|
||||
"x-technical-preview": true,
|
||||
"tags": [
|
||||
"cases"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"$ref": "#/components/parameters/alert_id"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/parameters/space_id"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/parameters/owner"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Indicates a successful call.",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"description": "The case identifier."
|
||||
},
|
||||
"title": {
|
||||
"type": "string",
|
||||
"description": "The case title."
|
||||
}
|
||||
}
|
||||
},
|
||||
"example": [
|
||||
{
|
||||
"id": "06116b80-e1c3-11ec-be9b-9b1838238ee6",
|
||||
"title": "security_case"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"servers": [
|
||||
{
|
||||
"url": "https://localhost:5601"
|
||||
}
|
||||
]
|
||||
},
|
||||
"servers": [
|
||||
{
|
||||
"url": "https://localhost:5601"
|
||||
}
|
||||
]
|
||||
},
|
||||
"/s/{spaceId}/api/cases/configure": {
|
||||
"get": {
|
||||
"summary": "Retrieves external connection details, such as the closure type and default connector for cases.",
|
||||
|
|
@ -196,7 +259,7 @@
|
|||
"200": {
|
||||
"description": "Indicates a successful call.",
|
||||
"content": {
|
||||
"application/json; charset=utf-8": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
|
|
@ -417,7 +480,7 @@
|
|||
"200": {
|
||||
"description": "Indicates a successful call.",
|
||||
"content": {
|
||||
"application/json; charset=utf-8": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
|
|
@ -631,7 +694,7 @@
|
|||
"200": {
|
||||
"description": "Indicates a successful call.",
|
||||
"content": {
|
||||
"application/json; charset=utf-8": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
|
|
@ -768,6 +831,250 @@
|
|||
}
|
||||
]
|
||||
},
|
||||
"/s/{spaceId}/api/cases/reporters": {
|
||||
"get": {
|
||||
"summary": "Returns information about the users who opened cases.",
|
||||
"operationId": "getCaseReporters",
|
||||
"description": "You must have read privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the cases. The API returns information about the users as they existed at the time of the case creation, including their name, full name, and email address. If any of those details change thereafter or if a user is deleted, the information returned by this API is unchanged.\n",
|
||||
"tags": [
|
||||
"cases"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"$ref": "#/components/parameters/space_id"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/parameters/owner"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Indicates a successful call.",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"email": {
|
||||
"type": "string",
|
||||
"example": null,
|
||||
"nullable": true
|
||||
},
|
||||
"full_name": {
|
||||
"type": "string",
|
||||
"example": null,
|
||||
"nullable": true
|
||||
},
|
||||
"username": {
|
||||
"type": "string",
|
||||
"example": "elastic",
|
||||
"nullable": true
|
||||
},
|
||||
"profile_uid": {
|
||||
"type": "string",
|
||||
"example": "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"examples": {
|
||||
"getReportersResponse": {
|
||||
"$ref": "#/components/examples/get_reporters_response"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"servers": [
|
||||
{
|
||||
"url": "https://localhost:5601"
|
||||
}
|
||||
]
|
||||
},
|
||||
"servers": [
|
||||
{
|
||||
"url": "https://localhost:5601"
|
||||
}
|
||||
]
|
||||
},
|
||||
"/s/{spaceId}/api/cases/status": {
|
||||
"get": {
|
||||
"summary": "Returns the number of cases that are open, closed, and in progress.",
|
||||
"operationId": "getCaseStatus",
|
||||
"description": "You must have `read` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the cases you're seeking.\n",
|
||||
"deprecated": true,
|
||||
"tags": [
|
||||
"cases"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"$ref": "#/components/parameters/space_id"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/parameters/owner"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Indicates a successful call.",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"count_closed_cases": {
|
||||
"type": "integer"
|
||||
},
|
||||
"count_in_progress_cases": {
|
||||
"type": "integer"
|
||||
},
|
||||
"count_open_cases": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"examples": {
|
||||
"getStatusResponse": {
|
||||
"$ref": "#/components/examples/get_status_response"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"servers": [
|
||||
{
|
||||
"url": "https://localhost:5601"
|
||||
}
|
||||
]
|
||||
},
|
||||
"servers": [
|
||||
{
|
||||
"url": "https://localhost:5601"
|
||||
}
|
||||
]
|
||||
},
|
||||
"/s/{spaceId}/api/cases/tags": {
|
||||
"get": {
|
||||
"summary": "Aggregates and returns a list of case tags.",
|
||||
"operationId": "getCaseTags",
|
||||
"description": "You must have read privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the cases you're seeking.\n",
|
||||
"tags": [
|
||||
"cases"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"$ref": "#/components/parameters/space_id"
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "owner",
|
||||
"description": "A filter to limit the retrieved case statistics to a specific set of applications. If this parameter is omitted, the response contains tags from all cases that the user has access to read.",
|
||||
"schema": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/owners"
|
||||
},
|
||||
{
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/owners"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Indicates a successful call.",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"examples": {
|
||||
"getTagsResponse": {
|
||||
"$ref": "#/components/examples/get_tags_response"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"servers": [
|
||||
{
|
||||
"url": "https://localhost:5601"
|
||||
}
|
||||
]
|
||||
},
|
||||
"servers": [
|
||||
{
|
||||
"url": "https://localhost:5601"
|
||||
}
|
||||
]
|
||||
},
|
||||
"/s/{spaceId}/api/cases/{caseId}": {
|
||||
"get": {
|
||||
"summary": "Retrieves information about a case.",
|
||||
"operationId": "getCase",
|
||||
"description": "You must have `read` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the case you're seeking.\n",
|
||||
"tags": [
|
||||
"cases"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"$ref": "#/components/parameters/case_id"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/parameters/space_id"
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "includeComments",
|
||||
"description": "Determines whether case comments are returned.",
|
||||
"deprecated": true,
|
||||
"schema": {
|
||||
"type": "boolean",
|
||||
"default": true
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Indicates a successful call.",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/case_response_properties"
|
||||
},
|
||||
"examples": {
|
||||
"getCaseResponse": {
|
||||
"$ref": "#/components/examples/get_case_response"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"servers": [
|
||||
{
|
||||
"url": "https://localhost:5601"
|
||||
}
|
||||
]
|
||||
},
|
||||
"servers": [
|
||||
{
|
||||
"url": "https://localhost:5601"
|
||||
}
|
||||
]
|
||||
},
|
||||
"/s/{spaceId}/api/cases/{caseId}/comments": {
|
||||
"post": {
|
||||
"summary": "Adds a comment or alert to a case.",
|
||||
|
|
@ -950,6 +1257,93 @@
|
|||
}
|
||||
]
|
||||
},
|
||||
"/s/{spaceId}/api/cases/{caseId}/comments/{commentId}": {
|
||||
"delete": {
|
||||
"summary": "Deletes a comment or alert from a case.",
|
||||
"operationId": "deleteCaseComment",
|
||||
"description": "You must have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the cases you're deleting.\n",
|
||||
"tags": [
|
||||
"cases"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"$ref": "#/components/parameters/kbn_xsrf"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/parameters/case_id"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/parameters/comment_id"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/parameters/space_id"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"204": {
|
||||
"description": "Indicates a successful call."
|
||||
}
|
||||
},
|
||||
"servers": [
|
||||
{
|
||||
"url": "https://localhost:5601"
|
||||
}
|
||||
]
|
||||
},
|
||||
"get": {
|
||||
"summary": "Retrieves a comment from a case.",
|
||||
"operationId": "getCaseComment",
|
||||
"description": "You must have `read` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the cases with the comments you're seeking.\n",
|
||||
"tags": [
|
||||
"cases"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"$ref": "#/components/parameters/case_id"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/parameters/comment_id"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/parameters/space_id"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Indicates a successful call.",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/alert_comment_response_properties"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/user_comment_response_properties"
|
||||
}
|
||||
]
|
||||
},
|
||||
"examples": {
|
||||
"getCaseCommentResponse": {
|
||||
"$ref": "#/components/examples/get_comment_response"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"servers": [
|
||||
{
|
||||
"url": "https://localhost:5601"
|
||||
}
|
||||
]
|
||||
},
|
||||
"servers": [
|
||||
{
|
||||
"url": "https://localhost:5601"
|
||||
}
|
||||
]
|
||||
},
|
||||
"/s/{spaceId}/api/cases/{caseId}/connector/{connectorId}/_push": {
|
||||
"post": {
|
||||
"summary": "Pushes a case to an external service.",
|
||||
|
|
@ -1043,6 +1437,16 @@
|
|||
"example": "default"
|
||||
}
|
||||
},
|
||||
"alert_id": {
|
||||
"in": "path",
|
||||
"name": "alertId",
|
||||
"description": "An identifier for the alert.",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"example": "09f0c261e39e36351d75995b78bb83673774d1bc2cca9df2d15f0e5c0a99a540"
|
||||
}
|
||||
},
|
||||
"owner": {
|
||||
"in": "query",
|
||||
"name": "owner",
|
||||
|
|
@ -1082,6 +1486,16 @@
|
|||
"example": "9c235210-6834-11ea-a78c-6ffb38a34414"
|
||||
}
|
||||
},
|
||||
"comment_id": {
|
||||
"in": "path",
|
||||
"name": "commentId",
|
||||
"description": "The identifier for the comment. To retrieve comment IDs, use the get case or find cases APIs.\n",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"example": "71ec1870-725b-11ea-a0b2-c51ea50a58e2"
|
||||
}
|
||||
},
|
||||
"connector_id": {
|
||||
"in": "path",
|
||||
"name": "connectorId",
|
||||
|
|
@ -2691,6 +3105,109 @@
|
|||
"id": "4a97a440-e1cd-11ec-be9b-9b1838238ee6"
|
||||
}
|
||||
},
|
||||
"get_reporters_response": {
|
||||
"summary": "A list of three users that opened cases",
|
||||
"value": [
|
||||
{
|
||||
"username": "elastic",
|
||||
"full_name": null,
|
||||
"email": null
|
||||
},
|
||||
{
|
||||
"username": "user1",
|
||||
"full_name": "User 1",
|
||||
"email": "user1@elastic.co"
|
||||
},
|
||||
{
|
||||
"username": "user2",
|
||||
"full_name": "User 2",
|
||||
"email": "user2@elastic.co"
|
||||
}
|
||||
]
|
||||
},
|
||||
"get_status_response": {
|
||||
"summary": "Get the number of cases in each state.",
|
||||
"value": {
|
||||
"count_open_cases": 27,
|
||||
"count_in_progress_cases": 50,
|
||||
"count_closed_cases": 198
|
||||
}
|
||||
},
|
||||
"get_tags_response": {
|
||||
"summary": "A list of tags that are used in cases",
|
||||
"value": [
|
||||
"observability",
|
||||
"security",
|
||||
"tag 1",
|
||||
"tag 2"
|
||||
]
|
||||
},
|
||||
"get_case_response": {
|
||||
"summary": "Retrieves information about a case including its comments.",
|
||||
"value": {
|
||||
"id": "31cdada0-02c1-11ed-85f2-4f7c222ca2fa",
|
||||
"version": "WzM2LDFd",
|
||||
"comments": [
|
||||
{
|
||||
"id": "2134c1d0-02c2-11ed-85f2-4f7c222ca2fa",
|
||||
"version": "WzM3LDFd",
|
||||
"type": "user",
|
||||
"owner": "cases",
|
||||
"comment": "A new comment",
|
||||
"created_at": "2022-07-13T15:40:32.335Z",
|
||||
"created_by": {
|
||||
"email": null,
|
||||
"full_name": null,
|
||||
"username": "elastic"
|
||||
},
|
||||
"pushed_at": null,
|
||||
"pushed_by": null,
|
||||
"updated_at": null,
|
||||
"updated_by": null
|
||||
}
|
||||
],
|
||||
"totalComment": 1,
|
||||
"totalAlerts": 0,
|
||||
"title": "Case title 1",
|
||||
"tags": [
|
||||
"tag 1"
|
||||
],
|
||||
"settings": {
|
||||
"syncAlerts": true
|
||||
},
|
||||
"owner": "cases",
|
||||
"description": "A case description",
|
||||
"duration": null,
|
||||
"severity": "low",
|
||||
"closed_at": null,
|
||||
"closed_by": null,
|
||||
"created_at": "2022-07-13T15:33:50.604Z",
|
||||
"created_by": {
|
||||
"username": "elastic",
|
||||
"email": null,
|
||||
"full_name": null
|
||||
},
|
||||
"status": "open",
|
||||
"updated_at": "2022-07-13T15:40:32.335Z",
|
||||
"updated_by": {
|
||||
"full_name": null,
|
||||
"email": null,
|
||||
"username": "elastic"
|
||||
},
|
||||
"assignees": [
|
||||
{
|
||||
"uid": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0"
|
||||
}
|
||||
],
|
||||
"connector": {
|
||||
"id": "none",
|
||||
"name": "none",
|
||||
"type": ".none",
|
||||
"fields": null
|
||||
},
|
||||
"external_service": null
|
||||
}
|
||||
},
|
||||
"add_comment_request": {
|
||||
"summary": "Adds a comment to a case.",
|
||||
"value": {
|
||||
|
|
@ -2831,6 +3348,26 @@
|
|||
"external_service": null
|
||||
}
|
||||
},
|
||||
"get_comment_response": {
|
||||
"summary": "A single user comment retrieved from a case",
|
||||
"value": {
|
||||
"id": "8048b460-fe2b-11ec-b15d-779a7c8bbcc3",
|
||||
"version": "WzIzLDFd",
|
||||
"type": "user",
|
||||
"owner": "cases",
|
||||
"comment": "A new comment",
|
||||
"created_at": "2022-07-07T19:32:13.104Z",
|
||||
"created_by": {
|
||||
"email": null,
|
||||
"full_name": null,
|
||||
"username": "elastic"
|
||||
},
|
||||
"pushed_at": null,
|
||||
"pushed_by": null,
|
||||
"updated_at": null,
|
||||
"updated_by": null
|
||||
}
|
||||
},
|
||||
"push_case_response": {
|
||||
"summary": "The push case API returns a JSON object with details about the case and the external service.",
|
||||
"value": {
|
||||
|
|
|
|||
|
|
@ -103,6 +103,42 @@ paths:
|
|||
- url: https://localhost:5601
|
||||
servers:
|
||||
- url: https://localhost:5601
|
||||
/s/{spaceId}/api/cases/alerts/{alertId}:
|
||||
get:
|
||||
summary: Returns the cases associated with a specific alert.
|
||||
operationId: getCasesByAlert
|
||||
description: |
|
||||
You must have `read` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the cases you're seeking.
|
||||
x-technical-preview: true
|
||||
tags:
|
||||
- cases
|
||||
parameters:
|
||||
- $ref: '#/components/parameters/alert_id'
|
||||
- $ref: '#/components/parameters/space_id'
|
||||
- $ref: '#/components/parameters/owner'
|
||||
responses:
|
||||
'200':
|
||||
description: Indicates a successful call.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The case identifier.
|
||||
title:
|
||||
type: string
|
||||
description: The case title.
|
||||
example:
|
||||
- id: 06116b80-e1c3-11ec-be9b-9b1838238ee6
|
||||
title: security_case
|
||||
servers:
|
||||
- url: https://localhost:5601
|
||||
servers:
|
||||
- url: https://localhost:5601
|
||||
/s/{spaceId}/api/cases/configure:
|
||||
get:
|
||||
summary: Retrieves external connection details, such as the closure type and default connector for cases.
|
||||
|
|
@ -118,7 +154,7 @@ paths:
|
|||
'200':
|
||||
description: Indicates a successful call.
|
||||
content:
|
||||
application/json; charset=utf-8:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
|
|
@ -273,7 +309,7 @@ paths:
|
|||
'200':
|
||||
description: Indicates a successful call.
|
||||
content:
|
||||
application/json; charset=utf-8:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
|
|
@ -421,7 +457,7 @@ paths:
|
|||
'200':
|
||||
description: Indicates a successful call.
|
||||
content:
|
||||
application/json; charset=utf-8:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
|
|
@ -514,6 +550,149 @@ paths:
|
|||
- url: https://localhost:5601
|
||||
servers:
|
||||
- url: https://localhost:5601
|
||||
/s/{spaceId}/api/cases/reporters:
|
||||
get:
|
||||
summary: Returns information about the users who opened cases.
|
||||
operationId: getCaseReporters
|
||||
description: |
|
||||
You must have read privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the cases. The API returns information about the users as they existed at the time of the case creation, including their name, full name, and email address. If any of those details change thereafter or if a user is deleted, the information returned by this API is unchanged.
|
||||
tags:
|
||||
- cases
|
||||
parameters:
|
||||
- $ref: '#/components/parameters/space_id'
|
||||
- $ref: '#/components/parameters/owner'
|
||||
responses:
|
||||
'200':
|
||||
description: Indicates a successful call.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
email:
|
||||
type: string
|
||||
example: null
|
||||
nullable: true
|
||||
full_name:
|
||||
type: string
|
||||
example: null
|
||||
nullable: true
|
||||
username:
|
||||
type: string
|
||||
example: elastic
|
||||
nullable: true
|
||||
profile_uid:
|
||||
type: string
|
||||
example: u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0
|
||||
examples:
|
||||
getReportersResponse:
|
||||
$ref: '#/components/examples/get_reporters_response'
|
||||
servers:
|
||||
- url: https://localhost:5601
|
||||
servers:
|
||||
- url: https://localhost:5601
|
||||
/s/{spaceId}/api/cases/status:
|
||||
get:
|
||||
summary: Returns the number of cases that are open, closed, and in progress.
|
||||
operationId: getCaseStatus
|
||||
description: |
|
||||
You must have `read` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the cases you're seeking.
|
||||
deprecated: true
|
||||
tags:
|
||||
- cases
|
||||
parameters:
|
||||
- $ref: '#/components/parameters/space_id'
|
||||
- $ref: '#/components/parameters/owner'
|
||||
responses:
|
||||
'200':
|
||||
description: Indicates a successful call.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
count_closed_cases:
|
||||
type: integer
|
||||
count_in_progress_cases:
|
||||
type: integer
|
||||
count_open_cases:
|
||||
type: integer
|
||||
examples:
|
||||
getStatusResponse:
|
||||
$ref: '#/components/examples/get_status_response'
|
||||
servers:
|
||||
- url: https://localhost:5601
|
||||
servers:
|
||||
- url: https://localhost:5601
|
||||
/s/{spaceId}/api/cases/tags:
|
||||
get:
|
||||
summary: Aggregates and returns a list of case tags.
|
||||
operationId: getCaseTags
|
||||
description: |
|
||||
You must have read privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the cases you're seeking.
|
||||
tags:
|
||||
- cases
|
||||
parameters:
|
||||
- $ref: '#/components/parameters/space_id'
|
||||
- in: query
|
||||
name: owner
|
||||
description: A filter to limit the retrieved case statistics to a specific set of applications. If this parameter is omitted, the response contains tags from all cases that the user has access to read.
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/owners'
|
||||
- type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/owners'
|
||||
responses:
|
||||
'200':
|
||||
description: Indicates a successful call.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
examples:
|
||||
getTagsResponse:
|
||||
$ref: '#/components/examples/get_tags_response'
|
||||
servers:
|
||||
- url: https://localhost:5601
|
||||
servers:
|
||||
- url: https://localhost:5601
|
||||
/s/{spaceId}/api/cases/{caseId}:
|
||||
get:
|
||||
summary: Retrieves information about a case.
|
||||
operationId: getCase
|
||||
description: |
|
||||
You must have `read` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the case you're seeking.
|
||||
tags:
|
||||
- cases
|
||||
parameters:
|
||||
- $ref: '#/components/parameters/case_id'
|
||||
- $ref: '#/components/parameters/space_id'
|
||||
- in: query
|
||||
name: includeComments
|
||||
description: Determines whether case comments are returned.
|
||||
deprecated: true
|
||||
schema:
|
||||
type: boolean
|
||||
default: true
|
||||
responses:
|
||||
'200':
|
||||
description: Indicates a successful call.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/case_response_properties'
|
||||
examples:
|
||||
getCaseResponse:
|
||||
$ref: '#/components/examples/get_case_response'
|
||||
servers:
|
||||
- url: https://localhost:5601
|
||||
servers:
|
||||
- url: https://localhost:5601
|
||||
/s/{spaceId}/api/cases/{caseId}/comments:
|
||||
post:
|
||||
summary: Adds a comment or alert to a case.
|
||||
|
|
@ -617,6 +796,51 @@ paths:
|
|||
- url: https://localhost:5601
|
||||
servers:
|
||||
- url: https://localhost:5601
|
||||
/s/{spaceId}/api/cases/{caseId}/comments/{commentId}:
|
||||
delete:
|
||||
summary: Deletes a comment or alert from a case.
|
||||
operationId: deleteCaseComment
|
||||
description: |
|
||||
You must have `all` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the cases you're deleting.
|
||||
tags:
|
||||
- cases
|
||||
parameters:
|
||||
- $ref: '#/components/parameters/kbn_xsrf'
|
||||
- $ref: '#/components/parameters/case_id'
|
||||
- $ref: '#/components/parameters/comment_id'
|
||||
- $ref: '#/components/parameters/space_id'
|
||||
responses:
|
||||
'204':
|
||||
description: Indicates a successful call.
|
||||
servers:
|
||||
- url: https://localhost:5601
|
||||
get:
|
||||
summary: Retrieves a comment from a case.
|
||||
operationId: getCaseComment
|
||||
description: |
|
||||
You must have `read` privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the cases with the comments you're seeking.
|
||||
tags:
|
||||
- cases
|
||||
parameters:
|
||||
- $ref: '#/components/parameters/case_id'
|
||||
- $ref: '#/components/parameters/comment_id'
|
||||
- $ref: '#/components/parameters/space_id'
|
||||
responses:
|
||||
'200':
|
||||
description: Indicates a successful call.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/alert_comment_response_properties'
|
||||
- $ref: '#/components/schemas/user_comment_response_properties'
|
||||
examples:
|
||||
getCaseCommentResponse:
|
||||
$ref: '#/components/examples/get_comment_response'
|
||||
servers:
|
||||
- url: https://localhost:5601
|
||||
servers:
|
||||
- url: https://localhost:5601
|
||||
/s/{spaceId}/api/cases/{caseId}/connector/{connectorId}/_push:
|
||||
post:
|
||||
summary: Pushes a case to an external service.
|
||||
|
|
@ -674,6 +898,14 @@ components:
|
|||
schema:
|
||||
type: string
|
||||
example: default
|
||||
alert_id:
|
||||
in: path
|
||||
name: alertId
|
||||
description: An identifier for the alert.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
example: 09f0c261e39e36351d75995b78bb83673774d1bc2cca9df2d15f0e5c0a99a540
|
||||
owner:
|
||||
in: query
|
||||
name: owner
|
||||
|
|
@ -702,6 +934,15 @@ components:
|
|||
schema:
|
||||
type: string
|
||||
example: 9c235210-6834-11ea-a78c-6ffb38a34414
|
||||
comment_id:
|
||||
in: path
|
||||
name: commentId
|
||||
description: |
|
||||
The identifier for the comment. To retrieve comment IDs, use the get case or find cases APIs.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
example: 71ec1870-725b-11ea-a0b2-c51ea50a58e2
|
||||
connector_id:
|
||||
in: path
|
||||
name: connectorId
|
||||
|
|
@ -1887,6 +2128,83 @@ components:
|
|||
version: WzIwNzMsMV0=
|
||||
error: null
|
||||
id: 4a97a440-e1cd-11ec-be9b-9b1838238ee6
|
||||
get_reporters_response:
|
||||
summary: A list of three users that opened cases
|
||||
value:
|
||||
- username: elastic
|
||||
full_name: null
|
||||
email: null
|
||||
- username: user1
|
||||
full_name: User 1
|
||||
email: user1@elastic.co
|
||||
- username: user2
|
||||
full_name: User 2
|
||||
email: user2@elastic.co
|
||||
get_status_response:
|
||||
summary: Get the number of cases in each state.
|
||||
value:
|
||||
count_open_cases: 27
|
||||
count_in_progress_cases: 50
|
||||
count_closed_cases: 198
|
||||
get_tags_response:
|
||||
summary: A list of tags that are used in cases
|
||||
value:
|
||||
- observability
|
||||
- security
|
||||
- tag 1
|
||||
- tag 2
|
||||
get_case_response:
|
||||
summary: Retrieves information about a case including its comments.
|
||||
value:
|
||||
id: 31cdada0-02c1-11ed-85f2-4f7c222ca2fa
|
||||
version: WzM2LDFd
|
||||
comments:
|
||||
- id: 2134c1d0-02c2-11ed-85f2-4f7c222ca2fa
|
||||
version: WzM3LDFd
|
||||
type: user
|
||||
owner: cases
|
||||
comment: A new comment
|
||||
created_at: '2022-07-13T15:40:32.335Z'
|
||||
created_by:
|
||||
email: null
|
||||
full_name: null
|
||||
username: elastic
|
||||
pushed_at: null
|
||||
pushed_by: null
|
||||
updated_at: null
|
||||
updated_by: null
|
||||
totalComment: 1
|
||||
totalAlerts: 0
|
||||
title: Case title 1
|
||||
tags:
|
||||
- tag 1
|
||||
settings:
|
||||
syncAlerts: true
|
||||
owner: cases
|
||||
description: A case description
|
||||
duration: null
|
||||
severity: low
|
||||
closed_at: null
|
||||
closed_by: null
|
||||
created_at: '2022-07-13T15:33:50.604Z'
|
||||
created_by:
|
||||
username: elastic
|
||||
email: null
|
||||
full_name: null
|
||||
status: open
|
||||
updated_at: '2022-07-13T15:40:32.335Z'
|
||||
updated_by:
|
||||
full_name: null
|
||||
email: null
|
||||
username: elastic
|
||||
assignees:
|
||||
- uid: u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0
|
||||
connector:
|
||||
id: none
|
||||
name: none
|
||||
type: .none
|
||||
fields: null
|
||||
external_service: null
|
||||
add_comment_request:
|
||||
summary: Adds a comment to a case.
|
||||
value:
|
||||
|
|
@ -2000,6 +2318,23 @@ components:
|
|||
type: .none
|
||||
fields: null
|
||||
external_service: null
|
||||
get_comment_response:
|
||||
summary: A single user comment retrieved from a case
|
||||
value:
|
||||
id: 8048b460-fe2b-11ec-b15d-779a7c8bbcc3
|
||||
version: WzIzLDFd
|
||||
type: user
|
||||
owner: cases
|
||||
comment: A new comment
|
||||
created_at: '2022-07-07T19:32:13.104Z'
|
||||
created_by:
|
||||
email: null
|
||||
full_name: null
|
||||
username: elastic
|
||||
pushed_at: null
|
||||
pushed_by: null
|
||||
updated_at: null
|
||||
updated_by: null
|
||||
push_case_response:
|
||||
summary: The push case API returns a JSON object with details about the case and the external service.
|
||||
value:
|
||||
|
|
|
|||
|
|
@ -19,28 +19,28 @@ paths:
|
|||
$ref: 'paths/s@{spaceid}@api@cases.yaml'
|
||||
# '/s/{spaceId}/api/cases/_find':
|
||||
# $ref: 'paths/s@{spaceid}@api@cases@_find.yaml'
|
||||
# '/s/{spaceId}/api/cases/alerts/{alertId}':
|
||||
# $ref: 'paths/s@{spaceid}@api@cases@alerts@{alertid}.yaml'
|
||||
'/s/{spaceId}/api/cases/alerts/{alertId}':
|
||||
$ref: 'paths/s@{spaceid}@api@cases@alerts@{alertid}.yaml'
|
||||
'/s/{spaceId}/api/cases/configure':
|
||||
$ref: paths/s@{spaceid}@api@cases@configure.yaml
|
||||
'/s/{spaceId}/api/cases/configure/{configurationId}':
|
||||
$ref: paths/s@{spaceid}@api@cases@configure@{configurationid}.yaml
|
||||
# '/s/{spaceId}/api/cases/configure/connectors/_find':
|
||||
# $ref: paths/s@{spaceid}@api@cases@configure@connectors@_find.yaml
|
||||
# '/s/{spaceId}/api/cases/reporters':
|
||||
# $ref: 'paths/s@{spaceid}@api@cases@reporters.yaml'
|
||||
# '/s/{spaceId}/api/cases/status':
|
||||
# $ref: 'paths/s@{spaceid}@api@cases@status.yaml'
|
||||
# '/s/{spaceId}/api/cases/tags':
|
||||
# $ref: 'paths/s@{spaceid}@api@cases@tags.yaml'
|
||||
# '/s/{spaceId}/api/cases/{caseId}':
|
||||
# $ref: 'paths/s@{spaceid}@api@cases@{caseid}.yaml'
|
||||
'/s/{spaceId}/api/cases/reporters':
|
||||
$ref: 'paths/s@{spaceid}@api@cases@reporters.yaml'
|
||||
'/s/{spaceId}/api/cases/status':
|
||||
$ref: 'paths/s@{spaceid}@api@cases@status.yaml'
|
||||
'/s/{spaceId}/api/cases/tags':
|
||||
$ref: 'paths/s@{spaceid}@api@cases@tags.yaml'
|
||||
'/s/{spaceId}/api/cases/{caseId}':
|
||||
$ref: 'paths/s@{spaceid}@api@cases@{caseid}.yaml'
|
||||
# '/s/{spaceId}/api/cases/{caseId}/alerts':
|
||||
# $ref: 'paths/s@{spaceid}@api@cases@{caseid}@alerts.yaml'
|
||||
'/s/{spaceId}/api/cases/{caseId}/comments':
|
||||
$ref: 'paths/s@{spaceid}@api@cases@{caseid}@comments.yaml'
|
||||
# '/s/{spaceId}/api/cases/{caseId}/comments/{commentId}':
|
||||
# $ref: 'paths/s@{spaceid}@api@cases@{caseid}@comments@{commentid}.yaml'
|
||||
'/s/{spaceId}/api/cases/{caseId}/comments/{commentId}':
|
||||
$ref: 'paths/s@{spaceid}@api@cases@{caseid}@comments@{commentid}.yaml'
|
||||
'/s/{spaceId}/api/cases/{caseId}/connector/{connectorId}/_push':
|
||||
$ref: 'paths/s@{spaceid}@api@cases@{caseid}@connector@{connectorid}@_push.yaml'
|
||||
# '/s/{spaceId}/api/cases/{caseId}/user_actions':
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ get:
|
|||
'200':
|
||||
description: Indicates a successful call.
|
||||
content:
|
||||
application/json; charset=utf-8:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ get:
|
|||
'200':
|
||||
description: Indicates a successful call.
|
||||
content:
|
||||
application/json; charset=utf-8:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
|
|
@ -82,7 +82,7 @@ post:
|
|||
'200':
|
||||
description: Indicates a successful call.
|
||||
content:
|
||||
application/json; charset=utf-8:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ patch:
|
|||
'200':
|
||||
description: Indicates a successful call.
|
||||
content:
|
||||
application/json; charset=utf-8:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ get:
|
|||
'200':
|
||||
description: Indicates a successful call.
|
||||
content:
|
||||
application/json; charset=utf-8:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ get:
|
|||
'200':
|
||||
description: Indicates a successful call.
|
||||
content:
|
||||
application/json; charset=utf-8:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@ get:
|
|||
summary: Aggregates and returns a list of case tags.
|
||||
operationId: getCaseTags
|
||||
description: >
|
||||
You must have read privileges for the **Cases*** feature in the
|
||||
You must have read privileges for the **Cases** feature in the
|
||||
**Management**, **Observability**, or **Security** section of the Kibana
|
||||
feature privileges, depending on the owner of the cases you're seeking.
|
||||
tags:
|
||||
|
|
@ -22,7 +22,7 @@ get:
|
|||
'200':
|
||||
description: Indicates a successful call.
|
||||
content:
|
||||
application/json; charset=utf-8:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ get:
|
|||
'200':
|
||||
description: Indicates a successful call.
|
||||
content:
|
||||
application/json; charset=utf-8:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ get:
|
|||
operationId: getCaseComment
|
||||
description: >
|
||||
You must have `read` privileges for the **Cases** feature in the **Management**,
|
||||
**Observability**, or **Security*** section of the Kibana feature privileges,
|
||||
**Observability**, or **Security** section of the Kibana feature privileges,
|
||||
depending on the owner of the cases with the comments you're seeking.
|
||||
tags:
|
||||
- cases
|
||||
|
|
@ -35,7 +35,7 @@ get:
|
|||
'200':
|
||||
description: Indicates a successful call.
|
||||
content:
|
||||
application/json; charset=utf-8:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: '../components/schemas/alert_comment_response_properties.yaml'
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue