[DOCS] Automate final case APIs (#145007)

This commit is contained in:
Lisa Cawley 2022-11-14 18:19:40 -08:00 committed by GitHub
parent 8974e826bf
commit 5348e39a36
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
25 changed files with 3437 additions and 11620 deletions

View file

@ -25,11 +25,15 @@ Any modifications made to this file will be overwritten.
<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="#getCaseActivity"><code><span class="http-method">get</span> /s/{spaceId}/api/cases/{caseId}/user_actions</code></a></li>
<li><a href="#getCaseAlerts"><code><span class="http-method">get</span> /s/{spaceId}/api/cases/{caseId}/alerts</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="#getCaseConnectors"><code><span class="http-method">get</span> /s/{spaceId}/api/cases/configure/connectors/_find</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="#getCases"><code><span class="http-method">get</span> /s/{spaceId}/api/cases/_find</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>
@ -604,6 +608,116 @@ 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="getCaseActivity"/>
<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}/user_actions</code></pre></div>
<div class="method-summary">Returns all user activity for a case. (<span class="nickname">getCaseActivity</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> &mdash; 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> &mdash; 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">
array[<a href="#user_actions_response_properties">user_actions_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",
"action_id" : "22fd3e30-03b1-11ed-920c-974bfa104448",
"case_id" : "22df07d0-03b1-11ed-920c-974bfa104448",
"action" : "create",
"created_at" : "2022-05-13T09:16:17.416Z",
"comment_id" : "578608d0-03b1-11ed-920c-974bfa104448",
"type" : "create_case",
"created_by" : {
"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="getCaseAlerts"/>
<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}/alerts</code></pre></div>
<div class="method-summary">Gets all alerts attached to a case. (<span class="nickname">getCaseAlerts</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">caseId (required)</div>
<div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; 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> &mdash; 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">
array[<a href="#alert_response_properties">alert_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>{
"index" : "index",
"id" : "id",
"attached_at" : "2000-01-23T04:56:07.000+00:00"
}</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="getCaseComment"/>
<div class="method-path">
<a class="up" href="#__Methods">Up</a>
@ -708,6 +822,7 @@ Any modifications made to this file will be overwritten.
"updated_at" : "2022-06-01T19:58:48.169Z",
"updated_by" : {
"full_name" : "full_name",
"profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
"email" : "email",
"username" : "elastic"
},
@ -716,6 +831,7 @@ Any modifications made to this file will be overwritten.
"error" : "error",
"created_by" : {
"full_name" : "full_name",
"profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
"email" : "email",
"username" : "elastic"
},
@ -733,6 +849,62 @@ Any modifications made to this file will be overwritten.
<h4 class="field-label">200</h4>
Indicates a successful call.
</div> <!-- method -->
<hr/>
<div class="method"><a name="getCaseConnectors"/>
<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/configure/connectors/_find</code></pre></div>
<div class="method-summary">Retrieves information about connectors. (<span class="nickname">getCaseConnectors</span>)</div>
<div class="method-notes">In particular, only the connectors that are supported for use in cases are returned. You must have <code>read</code> privileges for the <strong>Actions and Connectors</strong> feature in the <strong>Management</strong> section of the Kibana feature privileges.</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> &mdash; 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">
array[<a href="#getCaseConnectors_200_response_inner">getCaseConnectors_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>{
"isPreconfigured" : true,
"isDeprecated" : true,
"actionTypeId" : ".none",
"referencedByCount" : 0,
"name" : "name",
"id" : "id",
"config" : {
"projectKey" : "projectKey",
"apiUrl" : "apiUrl"
},
"isMissingSecrets" : true
}</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="getCaseReporters"/>
@ -762,7 +934,7 @@ Any modifications made to this file will be overwritten.
<h3 class="field-label">Return type</h3>
<div class="return-type">
array[<a href="#getCaseReporters_200_response_inner">getCaseReporters_200_response_inner</a>]
array[<a href="#getCaseConfiguration_200_response_inner_created_by">getCaseConfiguration_200_response_inner_created_by</a>]
</div>
@ -894,6 +1066,200 @@ Any modifications made to this file will be overwritten.
</div> <!-- method -->
<hr/>
<div class="method"><a name="getCases"/>
<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/_find</code></pre></div>
<div class="method-summary">Retrieves a paginated subset of cases. (<span class="nickname">getCases</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> &mdash; 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">defaultSearchOperator (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; The default operator to use for the simple_query_string. default: OR </div><div class="param">fields (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; The fields in the entity to return in the response. default: null </div><div class="param">from (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; [preview] Returns only cases that were created after a specific date. The date must be specified as a KQL data range or date match expression. This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. default: null </div><div class="param">owner (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; 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 class="param">page (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; The page number to return. default: 1 </div><div class="param">perPage (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; The number of rules to return per page. default: 20 </div><div class="param">reporters (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Filters the returned cases by the user name of the reporter. default: null </div><div class="param">search (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; An Elasticsearch simple_query_string query that filters the objects in the response. default: null </div><div class="param">searchFields (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; The fields to perform the simple_query_string parsed query against. default: null </div><div class="param">severity (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; The severity of the case. default: null </div><div class="param">sortField (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Determines which field is used to sort the results. default: createdAt </div><div class="param">sortOrder (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Determines the sort order. default: desc </div><div class="param">status (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Filters the returned cases by state. default: null </div><div class="param">tags (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Filters the returned cases by tags. default: null </div><div class="param">to (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; [preview] Returns only cases that were created before a specific date. The date must be specified as a KQL data range or date match expression. This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. default: null </div>
</div> <!-- field-items -->
<h3 class="field-label">Return type</h3>
<div class="return-type">
<a href="#getCases_200_response">getCases_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,
"per_page" : 5,
"total" : 2,
"cases" : [ {
"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"
}
}, {
"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"
}
} ],
"count_open_cases" : 1,
"count_closed_cases" : 0,
"page" : 5
}</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="#getCases_200_response">getCases_200_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="getCasesByAlert"/>
<div class="method-path">
<a class="up" href="#__Methods">Up</a>
@ -1139,6 +1505,7 @@ Any modifications made to this file will be overwritten.
"updated_at" : "2022-06-01T19:58:48.169Z",
"updated_by" : {
"full_name" : "full_name",
"profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
"email" : "email",
"username" : "elastic"
},
@ -1147,6 +1514,7 @@ Any modifications made to this file will be overwritten.
"error" : "error",
"created_by" : {
"full_name" : "full_name",
"profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
"email" : "email",
"username" : "elastic"
},
@ -1473,6 +1841,7 @@ Any modifications made to this file will be overwritten.
"updated_at" : "2022-06-01T19:58:48.169Z",
"updated_by" : {
"full_name" : "full_name",
"profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
"email" : "email",
"username" : "elastic"
},
@ -1481,6 +1850,7 @@ Any modifications made to this file will be overwritten.
"error" : "error",
"created_by" : {
"full_name" : "full_name",
"profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
"email" : "email",
"username" : "elastic"
},
@ -1508,18 +1878,20 @@ Any modifications made to this file will be overwritten.
<ol>
<li><a href="#Case_response_properties_for_comments_inner"><code>Case_response_properties_for_comments_inner</code> - </a></li>
<li><a href="#Case_response_properties_for_connectors"><code>Case_response_properties_for_connectors</code> - Case response properties for connectors</a></li>
<li><a href="#action_types"><code>action_types</code> - </a></li>
<li><a href="#actions"><code>actions</code> - </a></li>
<li><a href="#add_alert_comment_request_properties"><code>add_alert_comment_request_properties</code> - Add case comment request properties for alerts</a></li>
<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_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>
<li><a href="#alert_indices"><code>alert_indices</code> - Alert indices</a></li>
<li><a href="#alert_response_properties"><code>alert_response_properties</code> - </a></li>
<li><a href="#assignees_inner"><code>assignees_inner</code> - </a></li>
<li><a href="#case_response_closed_by_properties"><code>case_response_closed_by_properties</code> - Case response properties for closed_by</a></li>
<li><a href="#case_response_created_by_properties"><code>case_response_created_by_properties</code> - Case response properties for created_by</a></li>
<li><a href="#case_response_properties"><code>case_response_properties</code> - Case response properties</a></li>
<li><a href="#case_response_properties_assignees_inner"><code>case_response_properties_assignees_inner</code> - </a></li>
<li><a href="#case_response_pushed_by_properties"><code>case_response_pushed_by_properties</code> - Case response properties for pushed_by</a></li>
<li><a href="#case_response_updated_by_properties"><code>case_response_updated_by_properties</code> - Case response properties for updated_by</a></li>
<li><a href="#closure_types"><code>closure_types</code> - </a></li>
@ -1537,7 +1909,6 @@ Any modifications made to this file will be overwritten.
<li><a href="#connector_properties_swimlane_fields"><code>connector_properties_swimlane_fields</code> - </a></li>
<li><a href="#connector_types"><code>connector_types</code> - </a></li>
<li><a href="#create_case_request"><code>create_case_request</code> - Create case request</a></li>
<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>
@ -1546,11 +1917,32 @@ Any modifications made to this file will be overwritten.
<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="#getCaseReporters_200_response_inner"><code>getCaseReporters_200_response_inner</code> - </a></li>
<li><a href="#getCaseConnectors_200_response_inner"><code>getCaseConnectors_200_response_inner</code> - </a></li>
<li><a href="#getCaseConnectors_200_response_inner_config"><code>getCaseConnectors_200_response_inner_config</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="#getCases_200_response"><code>getCases_200_response</code> - </a></li>
<li><a href="#getCases_owner_parameter"><code>getCases_owner_parameter</code> - </a></li>
<li><a href="#getCases_reporters_parameter"><code>getCases_reporters_parameter</code> - </a></li>
<li><a href="#owners"><code>owners</code> - </a></li>
<li><a href="#payload_alert_comment"><code>payload_alert_comment</code> - </a></li>
<li><a href="#payload_alert_comment_comment"><code>payload_alert_comment_comment</code> - </a></li>
<li><a href="#payload_alert_comment_comment_alertId"><code>payload_alert_comment_comment_alertId</code> - </a></li>
<li><a href="#payload_alert_comment_comment_index"><code>payload_alert_comment_comment_index</code> - </a></li>
<li><a href="#payload_assignees"><code>payload_assignees</code> - </a></li>
<li><a href="#payload_connector"><code>payload_connector</code> - </a></li>
<li><a href="#payload_connector_connector"><code>payload_connector_connector</code> - </a></li>
<li><a href="#payload_connector_connector_fields"><code>payload_connector_connector_fields</code> - </a></li>
<li><a href="#payload_create_case"><code>payload_create_case</code> - </a></li>
<li><a href="#payload_description"><code>payload_description</code> - </a></li>
<li><a href="#payload_pushed"><code>payload_pushed</code> - </a></li>
<li><a href="#payload_settings"><code>payload_settings</code> - </a></li>
<li><a href="#payload_severity"><code>payload_severity</code> - </a></li>
<li><a href="#payload_status"><code>payload_status</code> - </a></li>
<li><a href="#payload_tags"><code>payload_tags</code> - </a></li>
<li><a href="#payload_title"><code>payload_title</code> - </a></li>
<li><a href="#payload_user_comment"><code>payload_user_comment</code> - </a></li>
<li><a href="#payload_user_comment_comment"><code>payload_user_comment_comment</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>
<li><a href="#setCaseConfiguration_request_connector"><code>setCaseConfiguration_request_connector</code> - </a></li>
@ -1564,6 +1956,9 @@ Any modifications made to this file will be overwritten.
<li><a href="#update_case_request"><code>update_case_request</code> - Update case request</a></li>
<li><a href="#update_case_request_cases_inner"><code>update_case_request_cases_inner</code> - </a></li>
<li><a href="#update_user_comment_request_properties"><code>update_user_comment_request_properties</code> - Update case comment request properties for user comments</a></li>
<li><a href="#user_actions_response_properties"><code>user_actions_response_properties</code> - </a></li>
<li><a href="#user_actions_response_properties_created_by"><code>user_actions_response_properties_created_by</code> - </a></li>
<li><a href="#user_actions_response_properties_payload"><code>user_actions_response_properties_payload</code> - </a></li>
<li><a href="#user_comment_response_properties"><code>user_comment_response_properties</code> - Case response properties for user comments</a></li>
</ol>
@ -1601,6 +1996,18 @@ Any modifications made to this file will be overwritten.
<div class="param-enum">.swimlane</div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="action_types"><code>action_types</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>The type of action.</div>
<div class="field-items">
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="actions"><code>actions</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="add_alert_comment_request_properties"><code>add_alert_comment_request_properties</code> - Add case comment request properties for alerts</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>Defines properties for case comment requests when type is alert.</div>
@ -1645,31 +2052,21 @@ 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="#getCaseReporters_200_response_inner">getCaseReporters_200_response_inner</a></span> </div>
<div class="param">created_by (optional)</div><div class="param-desc"><span class="param-type"><a href="#getCaseConfiguration_200_response_inner_created_by">getCaseConfiguration_200_response_inner_created_by</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="#alert_comment_response_properties_pushed_by">alert_comment_response_properties_pushed_by</a></span> </div>
<div class="param">pushed_by (optional)</div><div class="param-desc"><span class="param-type"><a href="#getCaseConfiguration_200_response_inner_updated_by">getCaseConfiguration_200_response_inner_updated_by</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">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="#getCaseReporters_200_response_inner">getCaseReporters_200_response_inner</a></span> </div>
<div class="param">updated_by (optional)</div><div class="param-desc"><span class="param-type"><a href="#getCaseConfiguration_200_response_inner_created_by">getCaseConfiguration_200_response_inner_created_by</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_pushed_by"><code>alert_comment_response_properties_pushed_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_rule"><code>alert_comment_response_properties_rule</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
@ -1690,6 +2087,22 @@ Any modifications made to this file will be overwritten.
<div class="field-items">
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="alert_response_properties"><code>alert_response_properties</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">attached_at (optional)</div><div class="param-desc"><span class="param-type"><a href="#DateTime">Date</a></span> format: date-time</div>
<div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The alert identifier. </div>
<div class="param">index (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The alert index. </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="assignees_inner"><code>assignees_inner</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">uid </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> A unique identifier for the user profile. These identifiers can be found by using the suggest user profile API. </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="case_response_closed_by_properties"><code>case_response_closed_by_properties</code> - Case response properties for closed_by</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
@ -1714,7 +2127,7 @@ Any modifications made to this file will be overwritten.
<h3><a name="case_response_properties"><code>case_response_properties</code> - Case response properties</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">assignees (optional)</div><div class="param-desc"><span class="param-type"><a href="#case_response_properties_assignees_inner">array[case_response_properties_assignees_inner]</a></span> An array containing users that are assigned to the case. </div>
<div class="param">assignees (optional)</div><div class="param-desc"><span class="param-type"><a href="#assignees_inner">array[assignees_inner]</a></span> An array containing users that are assigned to the case. </div>
<div class="param">closed_at </div><div class="param-desc"><span class="param-type"><a href="#DateTime">Date</a></span> format: date-time</div>
<div class="param">closed_by </div><div class="param-desc"><span class="param-type"><a href="#case_response_closed_by_properties">case_response_closed_by_properties</a></span> </div>
<div class="param">comments </div><div class="param-desc"><span class="param-type"><a href="#Case_response_properties_for_comments_inner">array[Case_response_properties_for_comments_inner]</a></span> An array of comment objects for the case. </div>
@ -1738,13 +2151,6 @@ Any modifications made to this file will be overwritten.
<div class="param">version </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="case_response_properties_assignees_inner"><code>case_response_properties_assignees_inner</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">uid </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> A unique identifier for the user profile. You can use the get user profile API to retrieve more details. </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="case_response_pushed_by_properties"><code>case_response_pushed_by_properties</code> - Case response properties for pushed_by</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
@ -1913,7 +2319,7 @@ Any modifications made to this file will be overwritten.
<h3><a name="create_case_request"><code>create_case_request</code> - Create case request</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>The create case API request body varies depending on the type of connector.</div>
<div class="field-items">
<div class="param">assignees (optional)</div><div class="param-desc"><span class="param-type"><a href="#create_case_request_assignees_inner">array[create_case_request_assignees_inner]</a></span> An array containing users that are assigned to the case. </div>
<div class="param">assignees (optional)</div><div class="param-desc"><span class="param-type"><a href="#assignees_inner">array[assignees_inner]</a></span> An array containing users that are assigned to the case. </div>
<div class="param">connector </div><div class="param-desc"><span class="param-type"><a href="#create_case_request_connector">create_case_request_connector</a></span> </div>
<div class="param">description </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The description for the case. </div>
<div class="param">owner </div><div class="param-desc"><span class="param-type"><a href="#owners">owners</a></span> </div>
@ -1923,13 +2329,6 @@ Any modifications made to this file will be overwritten.
<div class="param">title </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> A title for the case. </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="create_case_request_assignees_inner"><code>create_case_request_assignees_inner</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">uid </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> A unique identifier for the user profile. These identifiers can be found by using the suggest user profile API. </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="create_case_request_connector"><code>create_case_request_connector</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
@ -1952,7 +2351,7 @@ Any modifications made to this file will be overwritten.
<div class="param">external_title (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">external_url (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</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="#alert_comment_response_properties_pushed_by">alert_comment_response_properties_pushed_by</a></span> </div>
<div class="param">pushed_by (optional)</div><div class="param-desc"><span class="param-type"><a href="#getCaseConfiguration_200_response_inner_updated_by">getCaseConfiguration_200_response_inner_updated_by</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
@ -2011,6 +2410,7 @@ Any modifications made to this file will be overwritten.
<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">
@ -2029,16 +2429,29 @@ Any modifications made to this file will be overwritten.
<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="getCaseReporters_200_response_inner"><code>getCaseReporters_200_response_inner</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<h3><a name="getCaseConnectors_200_response_inner"><code>getCaseConnectors_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 class="param">actionTypeId (optional)</div><div class="param-desc"><span class="param-type"><a href="#connector_types">connector_types</a></span> </div>
<div class="param">config (optional)</div><div class="param-desc"><span class="param-type"><a href="#getCaseConnectors_200_response_inner_config">getCaseConnectors_200_response_inner_config</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">isDeprecated (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
<div class="param">isMissingSecrets (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
<div class="param">isPreconfigured (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">referencedByCount (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="getCaseConnectors_200_response_inner_config"><code>getCaseConnectors_200_response_inner_config</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">apiUrl (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">projectKey (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
@ -2059,7 +2472,26 @@ Any modifications made to this file will be overwritten.
</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>
<h3><a name="getCases_200_response"><code>getCases_200_response</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">cases (optional)</div><div class="param-desc"><span class="param-type"><a href="#case_response_properties">array[case_response_properties]</a></span> </div>
<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 class="param">page (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> </div>
<div class="param">per_page (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> </div>
<div class="param">total (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="getCases_owner_parameter"><code>getCases_owner_parameter</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="getCases_reporters_parameter"><code>getCases_reporters_parameter</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
</div> <!-- field-items -->
@ -2070,6 +2502,165 @@ Any modifications made to this file will be overwritten.
<div class="field-items">
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="payload_alert_comment"><code>payload_alert_comment</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">comment (optional)</div><div class="param-desc"><span class="param-type"><a href="#payload_alert_comment_comment">payload_alert_comment_comment</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="payload_alert_comment_comment"><code>payload_alert_comment_comment</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="#payload_alert_comment_comment_alertId">payload_alert_comment_comment_alertId</a></span> </div>
<div class="param">index (optional)</div><div class="param-desc"><span class="param-type"><a href="#payload_alert_comment_comment_index">payload_alert_comment_comment_index</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">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 (optional)</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">alert</div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="payload_alert_comment_comment_alertId"><code>payload_alert_comment_comment_alertId</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="payload_alert_comment_comment_index"><code>payload_alert_comment_comment_index</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="payload_assignees"><code>payload_assignees</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">assignees (optional)</div><div class="param-desc"><span class="param-type"><a href="#assignees_inner">array[assignees_inner]</a></span> An array containing users that are assigned to the case. </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="payload_connector"><code>payload_connector</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">connector (optional)</div><div class="param-desc"><span class="param-type"><a href="#payload_connector_connector">payload_connector_connector</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="payload_connector_connector"><code>payload_connector_connector</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">fields (optional)</div><div class="param-desc"><span class="param-type"><a href="#payload_connector_connector_fields">payload_connector_connector_fields</a></span> </div>
<div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The identifier for the connector. To create a case without a connector, use <code>none</code>. </div>
<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The name of the connector. To create a case without a connector, use <code>none</code>. </div>
<div class="param">type (optional)</div><div class="param-desc"><span class="param-type"><a href="#connector_types">connector_types</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="payload_connector_connector_fields"><code>payload_connector_connector_fields</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>An object containing the connector fields. To create a case without a connector, specify null. If you want to omit any individual field, specify null as its value.</div>
<div class="field-items">
<div class="param">caseId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The case identifier for Swimlane connectors. </div>
<div class="param">category (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The category of the incident for ServiceNow ITSM and ServiceNow SecOps connectors. </div>
<div class="param">destIp (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether cases will send a comma-separated list of destination IPs for ServiceNow SecOps connectors. </div>
<div class="param">impact (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The effect an incident had on business for ServiceNow ITSM connectors. </div>
<div class="param">issueType (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of issue for Jira connectors. </div>
<div class="param">issueTypes (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> The type of incident for IBM Resilient connectors. </div>
<div class="param">malwareHash (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether cases will send a comma-separated list of malware hashes for ServiceNow SecOps connectors. </div>
<div class="param">malwareUrl (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether cases will send a comma-separated list of malware URLs for ServiceNow SecOps connectors. </div>
<div class="param">parent (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The key of the parent issue, when the issue type is sub-task for Jira connectors. </div>
<div class="param">priority (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The priority of the issue for Jira and ServiceNow SecOps connectors. </div>
<div class="param">severity (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The severity of the incident for ServiceNow ITSM connectors. </div>
<div class="param">severityCode (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The severity code of the incident for IBM Resilient connectors. </div>
<div class="param">sourceIp (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether cases will send a comma-separated list of source IPs for ServiceNow SecOps connectors. </div>
<div class="param">subcategory (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The subcategory of the incident for ServiceNow ITSM connectors. </div>
<div class="param">urgency (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The extent to which the incident resolution can be delayed for ServiceNow ITSM connectors. </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="payload_create_case"><code>payload_create_case</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">assignees (optional)</div><div class="param-desc"><span class="param-type"><a href="#assignees_inner">array[assignees_inner]</a></span> An array containing users that are assigned to the case. </div>
<div class="param">connector (optional)</div><div class="param-desc"><span class="param-type"><a href="#payload_connector_connector">payload_connector_connector</a></span> </div>
<div class="param">description (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">settings (optional)</div><div class="param-desc"><span class="param-type"><a href="#settings">settings</a></span> </div>
<div class="param">severity (optional)</div><div class="param-desc"><span class="param-type"><a href="#severity_property">severity_property</a></span> </div>
<div class="param">status (optional)</div><div class="param-desc"><span class="param-type"><a href="#status">status</a></span> </div>
<div class="param">tags (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> </div>
<div class="param">title (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="payload_description"><code>payload_description</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">description (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="payload_pushed"><code>payload_pushed</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">externalService (optional)</div><div class="param-desc"><span class="param-type"><a href="#external_service">external_service</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="payload_settings"><code>payload_settings</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">settings (optional)</div><div class="param-desc"><span class="param-type"><a href="#settings">settings</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="payload_severity"><code>payload_severity</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">severity (optional)</div><div class="param-desc"><span class="param-type"><a href="#severity_property">severity_property</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="payload_status"><code>payload_status</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">status (optional)</div><div class="param-desc"><span class="param-type"><a href="#status">status</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="payload_tags"><code>payload_tags</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">tags (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="payload_title"><code>payload_title</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">title (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="payload_user_comment"><code>payload_user_comment</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">comment (optional)</div><div class="param-desc"><span class="param-type"><a href="#payload_user_comment_comment">payload_user_comment_comment</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="payload_user_comment_comment"><code>payload_user_comment_comment</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">comment (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">type (optional)</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> <!-- field-items -->
</div>
<div class="model">
<h3><a name="rule"><code>rule</code> - Alerting rule</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>The rule that is associated with the alert. It is required only when <code>type</code> is <code>alert</code>. This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.</div>
@ -2175,7 +2766,7 @@ Any modifications made to this file will be overwritten.
<h3><a name="update_case_request_cases_inner"><code>update_case_request_cases_inner</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">assignees (optional)</div><div class="param-desc"><span class="param-type"><a href="#create_case_request_assignees_inner">array[create_case_request_assignees_inner]</a></span> An array containing users that are assigned to the case. </div>
<div class="param">assignees (optional)</div><div class="param-desc"><span class="param-type"><a href="#assignees_inner">array[assignees_inner]</a></span> An array containing users that are assigned to the case. </div>
<div class="param">connector (optional)</div><div class="param-desc"><span class="param-type"><a href="#create_case_request_connector">create_case_request_connector</a></span> </div>
<div class="param">description (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> An updated description for the case. </div>
<div class="param">id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The identifier for the case. </div>
@ -2200,6 +2791,48 @@ Any modifications made to this file will be overwritten.
<div class="param">version </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The current comment version. To retrieve version values, use the get comments API. </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="user_actions_response_properties"><code>user_actions_response_properties</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">action </div><div class="param-desc"><span class="param-type"><a href="#actions">actions</a></span> </div>
<div class="param">action_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">case_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">comment_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">created_at </div><div class="param-desc"><span class="param-type"><a href="#DateTime">Date</a></span> format: date-time</div>
<div class="param">created_by </div><div class="param-desc"><span class="param-type"><a href="#user_actions_response_properties_created_by">user_actions_response_properties_created_by</a></span> </div>
<div class="param">owner </div><div class="param-desc"><span class="param-type"><a href="#owners">owners</a></span> </div>
<div class="param">payload </div><div class="param-desc"><span class="param-type"><a href="#user_actions_response_properties_payload">user_actions_response_properties_payload</a></span> </div>
<div class="param">type </div><div class="param-desc"><span class="param-type"><a href="#action_types">action_types</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="user_actions_response_properties_created_by"><code>user_actions_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 </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">full_name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">username </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="user_actions_response_properties_payload"><code>user_actions_response_properties_payload</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">comment (optional)</div><div class="param-desc"><span class="param-type"><a href="#payload_user_comment_comment">payload_user_comment_comment</a></span> </div>
<div class="param">assignees (optional)</div><div class="param-desc"><span class="param-type"><a href="#assignees_inner">array[assignees_inner]</a></span> An array containing users that are assigned to the case. </div>
<div class="param">connector (optional)</div><div class="param-desc"><span class="param-type"><a href="#payload_connector_connector">payload_connector_connector</a></span> </div>
<div class="param">description (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">settings (optional)</div><div class="param-desc"><span class="param-type"><a href="#settings">settings</a></span> </div>
<div class="param">severity (optional)</div><div class="param-desc"><span class="param-type"><a href="#severity_property">severity_property</a></span> </div>
<div class="param">status (optional)</div><div class="param-desc"><span class="param-type"><a href="#status">status</a></span> </div>
<div class="param">tags (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> </div>
<div class="param">title (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">externalService (optional)</div><div class="param-desc"><span class="param-type"><a href="#external_service">external_service</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="user_comment_response_properties"><code>user_comment_response_properties</code> - Case response properties for user comments</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>

View file

@ -6,6 +6,12 @@
Retrieves a paginated subset of 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/_find`

View file

@ -10,6 +10,12 @@ In particular, only the connectors that are supported for use in cases are
returned. Refer to the list of supported external incident management systems in
<<add-case-connectors>>.
[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/configure/connectors/_find`

View file

@ -8,6 +8,12 @@ preview::[]
Gets all alerts attached to 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>/alerts`

View file

@ -8,6 +8,12 @@ Returns all user activity for a case.
deprecated::[8.1.0]
[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>/user_actions`

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

View file

@ -1,37 +1,72 @@
summary: Retrieves all activity for a case
value:
[
{
"created_at":"2022-07-14T20:11:24.947Z",
"created_by":{"username":"elastic","email":null,"full_name":null},
"owner":"cases",
"action":"create",
"payload":{
"description":"A case description",
"title":"Case title 1",
"tags":["tag 1"],
"connector":{"name":"none","type":".none","fields":null,"id":"none"},
"settings":{"syncAlerts":true},
"owner":"cases",
"severity":"low",
"status":"open"
},
"type":"create_case",
"action_id":"22fd3e30-03b1-11ed-920c-974bfa104448",
"case_id":"22df07d0-03b1-11ed-920c-974bfa104448",
"comment_id":null
},
{
"created_at":"2022-07-14T20:12:53.354Z",
"created_by":{"username":"elastic","email":null,"full_name":null},
"owner":"cases",
"action":"create",
"payload":{
"comment":{"type":"user","owner":"cases","comment":"A new comment"}
},
"type":"comment",
"action_id":"57af14a0-03b1-11ed-920c-974bfa104448",
"case_id":"22df07d0-03b1-11ed-920c-974bfa104448",
"comment_id":"578608d0-03b1-11ed-920c-974bfa104448"
}
]
value:
- action_id: b4cd0770-07c9-11ed-a5fd-47154cb8767e
action: create
case_id: 22df07d0-03b1-11ed-920c-974bfa104448
comment_id: 578608d0-03b1-11ed-920c-974bfa104448
created_at: 2022-07-20T01:17:22.150Z
created_by:
username: elastic
email: null
full_name: null
owner: cases
payload:
assignees:
connector:
name: none
type: .none
fields: null
id: none
description: test
tags:
- mine
title: test-case
owner: cases
settings:
syncAlerts: false
severity: low
status: open
type: create_case
type: comment
- action_id: 57af14a0-03b1-11ed-920c-974bfa104448
action: create
case_id: 22df07d0-03b1-11ed-920c-974bfa104448
comment_id: 578608d0-03b1-11ed-920c-974bfa104448
created_at: 2022-07-14T20:12:53.354Z
created_by:
username: elastic
email: null
full_name: null
owner: cases
payload:
comment: A new comment
owner: cases
type: user
type: comment
- action_id: 573c6980-6123-11ed-aa41-81a0a61fe447
action: add
case_id: 22df07d0-03b1-11ed-920c-974bfa104448
comment_id: null
created_at: 2022-07-20T01:10:28.238Z
created_by:
username: elastic
email: null
full_name: null
profile_uid: u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0
owner: cases
payload:
assignees:
uid: u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0
type: assignees
- action_id: fff460e0-07c9-11ed-a5fd-47154cb8767e
action: delete
case_id: 22df07d0-03b1-11ed-920c-974bfa104448
comment_id: null
created_at: 2022-07-20T01:19:28.238Z
created_by:
username: elastic
email: null
full_name: null
owner: cases
payload:
type: delete_case

View file

@ -0,0 +1,12 @@
type: array
description: An array containing users that are assigned to the case.
nullable: true
items:
type: object
required:
- uid
properties:
uid:
type: string
description: A unique identifier for the user profile. These identifiers can be found by using the suggest user profile API.
example: u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0

View file

@ -11,17 +11,7 @@ created_at:
created_by:
type: object
properties:
email:
type: string
example: null
nullable: true
full_name:
type: string
example: null
nullable: true
username:
type: string
example: elastic
$ref: 'user_properties.yaml'
error:
type: string
nullable: true
@ -53,17 +43,7 @@ updated_at:
updated_by:
type: object
properties:
email:
type: string
example: null
nullable: true
full_name:
type: string
example: null
nullable: true
username:
type: string
example: elastic
$ref: 'user_properties.yaml'
nullable: true
version:
type: string

View file

@ -24,18 +24,7 @@ required:
- version
properties:
assignees:
type: array
description: An array containing users that are assigned to the case.
nullable: true
items:
type: object
required:
- uid
properties:
uid:
type: string
description: A unique identifier for the user profile. You can use the get user profile API to retrieve more details.
example: u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0
$ref: 'assignees.yaml'
closed_at:
type: string
format: date-time

View file

@ -11,18 +11,7 @@ required:
- title
properties:
assignees:
type: array
description: An array containing users that are assigned to the case.
nullable: true
items:
type: object
required:
- uid
properties:
uid:
type: string
description: A unique identifier for the user profile. These identifiers can be found by using the suggest user profile API.
example: u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0
$ref: 'assignees.yaml'
connector:
oneOf:
- $ref: 'connector_properties_none.yaml'

View file

@ -1,9 +1,4 @@
type: object
properties:
assignees:
type: array
items:
type: object
properties:
uid:
type: string
$ref: 'assignees.yaml'

View file

@ -1,5 +1,7 @@
type: object
properties:
assignees:
$ref: 'assignees.yaml'
connector:
type: object
properties:

View file

@ -0,0 +1,3 @@
type: object
description: If the `action` is `delete` and the `type` is `delete_case`, the payload is nullable.
nullable: true

View file

@ -10,4 +10,4 @@ properties:
type:
type: string
enum:
- user
- user

View file

@ -15,18 +15,7 @@ properties:
- version
properties:
assignees:
type: array
description: An array containing users that are assigned to the case.
nullable: true
items:
type: object
required:
- uid
properties:
uid:
type: string
description: A unique identifier for the user profile. These identifiers can be found by using the suggest user profile API.
example: u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0
$ref: 'assignees.yaml'
connector:
oneOf:
- $ref: 'connector_properties_none.yaml'

View file

@ -1,4 +1,14 @@
type: object
required:
- action
- action_id
- case_id
- comment_id
- created_at
- created_by
- owner
- payload
- type
properties:
action:
$ref: 'actions.yaml'
@ -10,6 +20,7 @@ properties:
example: 22df07d0-03b1-11ed-920c-974bfa104448
comment_id:
type: string
nullable: true
example: 578608d0-03b1-11ed-920c-974bfa104448
created_at:
type: string
@ -19,6 +30,10 @@ properties:
type: object
properties:
$ref: 'user_properties.yaml'
required:
- email
- full_name
- username
owner:
$ref: 'owners.yaml'
payload:
@ -27,6 +42,7 @@ properties:
- $ref: 'payload_assignees.yaml'
- $ref: 'payload_connector.yaml'
- $ref: 'payload_create_case.yaml'
- $ref: 'payload_delete.yaml'
- $ref: 'payload_description.yaml'
- $ref: 'payload_pushed.yaml'
- $ref: 'payload_settings.yaml'
@ -35,6 +51,5 @@ properties:
- $ref: 'payload_tags.yaml'
- $ref: 'payload_title.yaml'
- $ref: 'payload_user_comment.yaml'
nullable: true
type:
type:
$ref: 'action_types.yaml'

View file

@ -1,59 +0,0 @@
openapi: 3.0.1
info:
title: Cases
description: OpenAPI schema for Cases endpoints
version: '0.2'
contact:
name: Cases Team
license:
name: Elastic License 2.0
url: https://www.elastic.co/licensing/elastic-license
tags:
- name: cases
description: Case APIs enable you to open and track issues.
servers:
- url: 'http://localhost:5601'
description: local
paths:
'/s/{spaceId}/api/cases':
$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/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/{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}/connector/{connectorId}/_push':
$ref: 'paths/s@{spaceid}@api@cases@{caseid}@connector@{connectorid}@_push.yaml'
# '/s/{spaceId}/api/cases/{caseId}/user_actions':
# $ref: 'paths/s@{spaceid}@api@cases@{caseid}@user_actions.yaml'
components:
securitySchemes:
basicAuth:
type: http
scheme: basic
apiKeyAuth:
type: apiKey
in: header
name: ApiKey
security:
- basicAuth: []
- apiKeyAuth: []

View file

@ -131,7 +131,7 @@ get:
'200':
description: Indicates a successful call.
content:
application/json; charset=utf-8:
application/json:
schema:
type: object
properties:

View file

@ -13,7 +13,7 @@ get:
'200':
description: Indicates a successful call.
content:
application/json; charset=utf-8:
application/json:
schema:
type: array
items:

View file

@ -21,7 +21,7 @@ get:
items:
$ref: '../components/schemas/alert_response_properties.yaml'
examples:
createCaseCommentResponse:
getCaseAlertsResponse:
$ref: '../components/examples/get_case_alerts_response.yaml'
servers:
- url: https://localhost:5601

View file

@ -15,7 +15,7 @@ get:
'200':
description: Indicates a successful call.
content:
application/json; charset=utf-8:
application/json:
schema:
type: array
items: