mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 17:59:23 -04:00
de3f8fca00
## Summary This PR limits `perPage` param to 100 in `findComments` API. ### Checklist - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios --------- Co-authored-by: lcawl <lcawley@elastic.co> Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
3204 lines
195 KiB
Text
3204 lines
195 KiB
Text
////
|
|
This content is generated from the open API specification.
|
|
Any modifications made to this file will be overwritten.
|
|
////
|
|
|
|
++++
|
|
<div class="openapi">
|
|
<h2>Access</h2>
|
|
<ol>
|
|
<li>APIKey KeyParamName:ApiKey KeyInQuery:false KeyInHeader:true</li>
|
|
<li>HTTP Basic Authentication</li>
|
|
</ol>
|
|
|
|
<h2><a name="__Methods">Methods</a></h2>
|
|
[ Jump to <a href="#__Models">Models</a> ]
|
|
|
|
<h3>Table of Contents </h3>
|
|
<div class="method-summary"></div>
|
|
<h4><a href="#Cases">Cases</a></h4>
|
|
<ul>
|
|
<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="#findCaseActivity"><code><span class="http-method">get</span> /s/{spaceId}/api/cases/{caseId}/user_actions/_find</code></a></li>
|
|
<li><a href="#findCaseComments"><code><span class="http-method">get</span> /s/{spaceId}/api/cases/{caseId}/comments/_find</code></a></li>
|
|
<li><a href="#findCaseConnectors"><code><span class="http-method">get</span> /s/{spaceId}/api/cases/configure/connectors/_find</code></a></li>
|
|
<li><a href="#findCases"><code><span class="http-method">get</span> /s/{spaceId}/api/cases/_find</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="#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>
|
|
<li><a href="#updateCaseComment"><code><span class="http-method">patch</span> /s/{spaceId}/api/cases/{caseId}/comments</code></a></li>
|
|
<li><a href="#updateCaseConfiguration"><code><span class="http-method">patch</span> /s/{spaceId}/api/cases/configure/{configurationId}</code></a></li>
|
|
</ul>
|
|
|
|
<h1><a name="Cases">Cases</a></h1>
|
|
<div class="method"><a name="addCaseComment"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /s/{spaceId}/api/cases/{caseId}/comments</code></pre></div>
|
|
<div class="method-summary">Adds a comment or alert to a case. (<span class="nickname">addCaseComment</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 case you're creating. NOTE: Each case can have a maximum of 1,000 alerts.</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">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">add_case_comment_request <a href="#add_case_comment_request">add_case_comment_request</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </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> — Cross-site request forgery protection default: null </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>
|
|
<h4 class="field-label">401</h4>
|
|
Authorization information is missing or invalid.
|
|
<a href="#4xx_response">4xx_response</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="createCase"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /s/{spaceId}/api/cases</code></pre></div>
|
|
<div class="method-summary">Creates a case. (<span class="nickname">createCase</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 case you're creating.</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">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">create_case_request <a href="#create_case_request">create_case_request</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </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> — Cross-site request forgery protection default: null </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>
|
|
<h4 class="field-label">401</h4>
|
|
Authorization information is missing or invalid.
|
|
<a href="#4xx_response">4xx_response</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="deleteCase"/>
|
|
<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</code></pre></div>
|
|
<div class="method-summary">Deletes one or more cases. (<span class="nickname">deleteCase</span>)</div>
|
|
<div class="method-notes">You must have <code>read</code> or <code>all</code> privileges and the <code>delete</code> sub-feature privilege 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">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> — Cross-site request forgery protection default: null </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">ids (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — The cases that you want to removed. All non-ASCII characters must be URL encoded. default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
<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">204</h4>
|
|
Indicates a successful call.
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
Authorization information is missing or invalid.
|
|
<a href="#4xx_response">4xx_response</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> — Cross-site request forgery protection default: null </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
<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">204</h4>
|
|
Indicates a successful call.
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
Authorization information is missing or invalid.
|
|
<a href="#4xx_response">4xx_response</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="deleteCaseComments"/>
|
|
<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</code></pre></div>
|
|
<div class="method-summary">Deletes all comments and alerts from a case. (<span class="nickname">deleteCaseComments</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">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> — Cross-site request forgery protection default: null </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
|
|
<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">204</h4>
|
|
Indicates a successful call.
|
|
<a href="#"></a>
|
|
<h4 class="field-label">401</h4>
|
|
Authorization information is missing or invalid.
|
|
<a href="#4xx_response">4xx_response</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="findCaseActivity"/>
|
|
<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/_find</code></pre></div>
|
|
<div class="method-summary">Finds user activity for a case. (<span class="nickname">findCaseActivity</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">page (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — 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> — The number of items to return. default: 20 </div><div class="param">sortOrder (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Determines the sort order. default: desc </div><div class="param">types (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Determines the types of user actions to return. default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#findCaseActivity_200_response">findCaseActivity_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>{
|
|
"userActions" : [ {
|
|
"owner" : "cases",
|
|
"action" : "create",
|
|
"created_at" : "2022-05-13T09:16:17.416Z",
|
|
"id" : "22fd3e30-03b1-11ed-920c-974bfa104448",
|
|
"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"
|
|
},
|
|
"version" : "WzM1ODg4LDFd"
|
|
}, {
|
|
"owner" : "cases",
|
|
"action" : "create",
|
|
"created_at" : "2022-05-13T09:16:17.416Z",
|
|
"id" : "22fd3e30-03b1-11ed-920c-974bfa104448",
|
|
"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"
|
|
},
|
|
"version" : "WzM1ODg4LDFd"
|
|
} ],
|
|
"total" : 1,
|
|
"perPage" : 6,
|
|
"page" : 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="#findCaseActivity_200_response">findCaseActivity_200_response</a>
|
|
<h4 class="field-label">401</h4>
|
|
Authorization information is missing or invalid.
|
|
<a href="#4xx_response">4xx_response</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="findCaseComments"/>
|
|
<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/_find</code></pre></div>
|
|
<div class="method-summary">Retrieves all the user comments from a case. (<span class="nickname">findCaseComments</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">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">page (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — 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> — The number of items to return. Limited to 100 items. default: 20 </div><div class="param">sortOrder (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Determines the sort order. default: desc </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>
|
|
<h4 class="field-label">401</h4>
|
|
Authorization information is missing or invalid.
|
|
<a href="#4xx_response">4xx_response</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="findCaseConnectors"/>
|
|
<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">findCaseConnectors</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> — 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="#findCaseConnectors_200_response_inner">findCaseConnectors_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.
|
|
|
|
<h4 class="field-label">401</h4>
|
|
Authorization information is missing or invalid.
|
|
<a href="#4xx_response">4xx_response</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="findCases"/>
|
|
<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">findCases</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">assignees (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Filters the returned cases by assignees. Valid values are <code>none</code> or unique identifiers for the user profiles. These identifiers can be found by using the suggest user profile API. default: null </div><div class="param">category (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — Filters the returned cases by category. Limited to 100 categories. default: null </div><div class="param">defaultSearchOperator (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — The default operator to use for the simple_query_string. default: OR </div><div class="param">from (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — [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> — 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> — 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> — The number of items to return. default: 20 </div><div class="param">reporters (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — 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> — 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> — 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> — 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> — 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> — Determines the sort order. default: desc </div><div class="param">status (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — 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> — 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> — [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="#findCases_200_response">findCases_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="#findCases_200_response">findCases_200_response</a>
|
|
<h4 class="field-label">401</h4>
|
|
Authorization information is missing or invalid.
|
|
<a href="#4xx_response">4xx_response</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getAllCaseComments"/>
|
|
<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</code></pre></div>
|
|
<div class="method-summary">Retrieves all the comments from a case. (<span class="nickname">getAllCaseComments</span>)</div>
|
|
<div class="method-notes">Deprecated in 8.1.0. This API is deprecated and will be removed in a future release; instead, use the get case comment API, which requires a comment identifier in the path. 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">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="#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>
|
|
<h4 class="field-label">401</h4>
|
|
Authorization information is missing or invalid.
|
|
<a href="#4xx_response">4xx_response</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> — Deprecated in 8.1.0. This parameter is deprecated and will be removed in a future release. It 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>
|
|
<h4 class="field-label">401</h4>
|
|
Authorization information is missing or invalid.
|
|
<a href="#4xx_response">4xx_response</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">Deprecated in 8.1.0. This API is deprecated and will be removed in a future release; use the find user actions API instead. 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">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.
|
|
|
|
<h4 class="field-label">401</h4>
|
|
Authorization information is missing or invalid.
|
|
<a href="#4xx_response">4xx_response</a>
|
|
</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> — 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">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.
|
|
|
|
<h4 class="field-label">401</h4>
|
|
Authorization information is missing or invalid.
|
|
<a href="#4xx_response">4xx_response</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>
|
|
<h4 class="field-label">401</h4>
|
|
Authorization information is missing or invalid.
|
|
<a href="#4xx_response">4xx_response</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getCaseConfiguration"/>
|
|
<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</code></pre></div>
|
|
<div class="method-summary">Retrieves external connection details, such as the closure type and default connector for cases. (<span class="nickname">getCaseConfiguration</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 configuration.</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="#getCaseConfiguration_200_response_inner">getCaseConfiguration_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>{
|
|
"closure_type" : "close-by-user",
|
|
"owner" : "cases",
|
|
"mappings" : [ {
|
|
"action_type" : "overwrite",
|
|
"source" : "title",
|
|
"target" : "summary"
|
|
}, {
|
|
"action_type" : "overwrite",
|
|
"source" : "title",
|
|
"target" : "summary"
|
|
} ],
|
|
"connector" : {
|
|
"name" : "none",
|
|
"id" : "none",
|
|
"fields" : "{}",
|
|
"type" : ".none"
|
|
},
|
|
"updated_at" : "2022-06-01T19:58:48.169Z",
|
|
"updated_by" : {
|
|
"full_name" : "full_name",
|
|
"profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
|
|
"email" : "email",
|
|
"username" : "elastic"
|
|
},
|
|
"created_at" : "2022-06-01T17:07:17.767Z",
|
|
"id" : "4a97a440-e1cd-11ec-be9b-9b1838238ee6",
|
|
"error" : "error",
|
|
"created_by" : {
|
|
"full_name" : "full_name",
|
|
"profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
|
|
"email" : "email",
|
|
"username" : "elastic"
|
|
},
|
|
"version" : "WzIwNzMsMV0="
|
|
}</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.
|
|
|
|
<h4 class="field-label">401</h4>
|
|
Authorization information is missing or invalid.
|
|
<a href="#4xx_response">4xx_response</a>
|
|
</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="#getCaseConfiguration_200_response_inner_created_by">getCaseConfiguration_200_response_inner_created_by</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.
|
|
|
|
<h4 class="field-label">401</h4>
|
|
Authorization information is missing or invalid.
|
|
<a href="#4xx_response">4xx_response</a>
|
|
</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">Deprecated in 8.1.0. This API is deprecated and will be removed in a future release; use the find cases API instead. 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>
|
|
<h4 class="field-label">401</h4>
|
|
Authorization information is missing or invalid.
|
|
<a href="#4xx_response">4xx_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.
|
|
|
|
<h4 class="field-label">401</h4>
|
|
Authorization information is missing or invalid.
|
|
<a href="#4xx_response">4xx_response</a>
|
|
</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>
|
|
<h4 class="field-label">200</h4>
|
|
Indicates a successful call.
|
|
|
|
<h4 class="field-label">401</h4>
|
|
Authorization information is missing or invalid.
|
|
<a href="#4xx_response">4xx_response</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="pushCase"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /s/{spaceId}/api/cases/{caseId}/connector/{connectorId}/_push</code></pre></div>
|
|
<div class="method-summary">Pushes a case to an external service. (<span class="nickname">pushCase</span>)</div>
|
|
<div class="method-notes">You must have <code>all</code> privileges for the <strong>Actions and Connectors</strong> feature in the <strong>Management</strong> section of the Kibana feature privileges. You must also 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 case you're pushing.</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">connectorId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — An identifier for the connector. To retrieve connector IDs, use the find connectors API. 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">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">body <a href="#object">object</a> (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </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> — Cross-site request forgery protection default: null </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>
|
|
<h4 class="field-label">401</h4>
|
|
Authorization information is missing or invalid.
|
|
<a href="#4xx_response">4xx_response</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="setCaseConfiguration"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /s/{spaceId}/api/cases/configure</code></pre></div>
|
|
<div class="method-summary">Sets external connection details, such as the closure type and default connector for cases. (<span class="nickname">setCaseConfiguration</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 case configuration. Connectors are used to interface with external systems. You must create a connector before you can use it in your cases. Refer to the add connectors API. If you set a default connector, it is automatically selected when you create cases in Kibana. If you use the create case API, however, you must still specify all of the connector details.</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">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">setCaseConfiguration_request <a href="#setCaseConfiguration_request">setCaseConfiguration_request</a> (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </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> — Cross-site request forgery protection default: null </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#getCaseConfiguration_200_response_inner">getCaseConfiguration_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>{
|
|
"closure_type" : "close-by-user",
|
|
"owner" : "cases",
|
|
"mappings" : [ {
|
|
"action_type" : "overwrite",
|
|
"source" : "title",
|
|
"target" : "summary"
|
|
}, {
|
|
"action_type" : "overwrite",
|
|
"source" : "title",
|
|
"target" : "summary"
|
|
} ],
|
|
"connector" : {
|
|
"name" : "none",
|
|
"id" : "none",
|
|
"fields" : "{}",
|
|
"type" : ".none"
|
|
},
|
|
"updated_at" : "2022-06-01T19:58:48.169Z",
|
|
"updated_by" : {
|
|
"full_name" : "full_name",
|
|
"profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
|
|
"email" : "email",
|
|
"username" : "elastic"
|
|
},
|
|
"created_at" : "2022-06-01T17:07:17.767Z",
|
|
"id" : "4a97a440-e1cd-11ec-be9b-9b1838238ee6",
|
|
"error" : "error",
|
|
"created_by" : {
|
|
"full_name" : "full_name",
|
|
"profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
|
|
"email" : "email",
|
|
"username" : "elastic"
|
|
},
|
|
"version" : "WzIwNzMsMV0="
|
|
}</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="#getCaseConfiguration_200_response_inner">getCaseConfiguration_200_response_inner</a>
|
|
<h4 class="field-label">401</h4>
|
|
Authorization information is missing or invalid.
|
|
<a href="#4xx_response">4xx_response</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="updateCase"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="patch"><code class="huge"><span class="http-method">patch</span> /s/{spaceId}/api/cases</code></pre></div>
|
|
<div class="method-summary">Updates one or more cases. (<span class="nickname">updateCase</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 case you're updating.</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">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">update_case_request <a href="#update_case_request">update_case_request</a> (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </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> — Cross-site request forgery protection default: null </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
array[<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.
|
|
|
|
<h4 class="field-label">401</h4>
|
|
Authorization information is missing or invalid.
|
|
<a href="#4xx_response">4xx_response</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="updateCaseComment"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="patch"><code class="huge"><span class="http-method">patch</span> /s/{spaceId}/api/cases/{caseId}/comments</code></pre></div>
|
|
<div class="method-summary">Updates a comment or alert in a case. (<span class="nickname">updateCaseComment</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 case you're updating. NOTE: You cannot change the comment type or the owner of a comment.</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">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">update_case_comment_request <a href="#update_case_comment_request">update_case_comment_request</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </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> — Cross-site request forgery protection default: null </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>
|
|
<h4 class="field-label">401</h4>
|
|
Authorization information is missing or invalid.
|
|
<a href="#4xx_response">4xx_response</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="updateCaseConfiguration"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="patch"><code class="huge"><span class="http-method">patch</span> /s/{spaceId}/api/cases/configure/{configurationId}</code></pre></div>
|
|
<div class="method-summary">Updates external connection details, such as the closure type and default connector for cases. (<span class="nickname">updateCaseConfiguration</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 case configuration. Connectors are used to interface with external systems. You must create a connector before you can use it in your cases. Refer to the add connectors API.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">configurationId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — An identifier for the configuration. 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">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">updateCaseConfiguration_request <a href="#updateCaseConfiguration_request">updateCaseConfiguration_request</a> (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </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> — Cross-site request forgery protection default: null </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
array[<a href="#getCaseConfiguration_200_response_inner">getCaseConfiguration_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>{
|
|
"closure_type" : "close-by-user",
|
|
"owner" : "cases",
|
|
"mappings" : [ {
|
|
"action_type" : "overwrite",
|
|
"source" : "title",
|
|
"target" : "summary"
|
|
}, {
|
|
"action_type" : "overwrite",
|
|
"source" : "title",
|
|
"target" : "summary"
|
|
} ],
|
|
"connector" : {
|
|
"name" : "none",
|
|
"id" : "none",
|
|
"fields" : "{}",
|
|
"type" : ".none"
|
|
},
|
|
"updated_at" : "2022-06-01T19:58:48.169Z",
|
|
"updated_by" : {
|
|
"full_name" : "full_name",
|
|
"profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
|
|
"email" : "email",
|
|
"username" : "elastic"
|
|
},
|
|
"created_at" : "2022-06-01T17:07:17.767Z",
|
|
"id" : "4a97a440-e1cd-11ec-be9b-9b1838238ee6",
|
|
"error" : "error",
|
|
"created_by" : {
|
|
"full_name" : "full_name",
|
|
"profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
|
|
"email" : "email",
|
|
"username" : "elastic"
|
|
},
|
|
"version" : "WzIwNzMsMV0="
|
|
}</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.
|
|
|
|
<h4 class="field-label">401</h4>
|
|
Authorization information is missing or invalid.
|
|
<a href="#4xx_response">4xx_response</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
|
|
<h2><a name="__Models">Models</a></h2>
|
|
[ Jump to <a href="#__Methods">Methods</a> ]
|
|
|
|
<h3>Table of Contents</h3>
|
|
<ol>
|
|
<li><a href="#4xx_response"><code>4xx_response</code> - Unsuccessful cases API response</a></li>
|
|
<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_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_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>
|
|
<li><a href="#connector_properties_cases_webhook"><code>connector_properties_cases_webhook</code> - Create or upate case request properties for Cases Webhook connector</a></li>
|
|
<li><a href="#connector_properties_jira"><code>connector_properties_jira</code> - Create or update case request properties for a Jira connector</a></li>
|
|
<li><a href="#connector_properties_jira_fields"><code>connector_properties_jira_fields</code> - </a></li>
|
|
<li><a href="#connector_properties_none"><code>connector_properties_none</code> - Create or update case request properties for no connector</a></li>
|
|
<li><a href="#connector_properties_resilient"><code>connector_properties_resilient</code> - Create case request properties for a IBM Resilient connector</a></li>
|
|
<li><a href="#connector_properties_resilient_fields"><code>connector_properties_resilient_fields</code> - </a></li>
|
|
<li><a href="#connector_properties_servicenow"><code>connector_properties_servicenow</code> - Create case request properties for a ServiceNow ITSM connector</a></li>
|
|
<li><a href="#connector_properties_servicenow_fields"><code>connector_properties_servicenow_fields</code> - </a></li>
|
|
<li><a href="#connector_properties_servicenow_sir"><code>connector_properties_servicenow_sir</code> - Create case request properties for a ServiceNow SecOps connector</a></li>
|
|
<li><a href="#connector_properties_servicenow_sir_fields"><code>connector_properties_servicenow_sir_fields</code> - </a></li>
|
|
<li><a href="#connector_properties_swimlane"><code>connector_properties_swimlane</code> - Create case request properties for a Swimlane connector</a></li>
|
|
<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_connector"><code>create_case_request_connector</code> - </a></li>
|
|
<li><a href="#external_service"><code>external_service</code> - </a></li>
|
|
<li><a href="#findCaseActivity_200_response"><code>findCaseActivity_200_response</code> - </a></li>
|
|
<li><a href="#findCaseConnectors_200_response_inner"><code>findCaseConnectors_200_response_inner</code> - </a></li>
|
|
<li><a href="#findCaseConnectors_200_response_inner_config"><code>findCaseConnectors_200_response_inner_config</code> - </a></li>
|
|
<li><a href="#findCases_200_response"><code>findCases_200_response</code> - </a></li>
|
|
<li><a href="#findCases_assignees_parameter"><code>findCases_assignees_parameter</code> - </a></li>
|
|
<li><a href="#findCases_owner_parameter"><code>findCases_owner_parameter</code> - </a></li>
|
|
<li><a href="#findCases_searchFields_parameter"><code>findCases_searchFields_parameter</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="#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="#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="#search_fields"><code>search_fields</code> - </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>
|
|
<li><a href="#setCaseConfiguration_request_settings"><code>setCaseConfiguration_request_settings</code> - </a></li>
|
|
<li><a href="#settings"><code>settings</code> - </a></li>
|
|
<li><a href="#severity_property"><code>severity_property</code> - </a></li>
|
|
<li><a href="#status"><code>status</code> - </a></li>
|
|
<li><a href="#updateCaseConfiguration_request"><code>updateCaseConfiguration_request</code> - </a></li>
|
|
<li><a href="#update_alert_comment_request_properties"><code>update_alert_comment_request_properties</code> - Update case comment request properties for alerts</a></li>
|
|
<li><a href="#update_case_comment_request"><code>update_case_comment_request</code> - Update case comment request</a></li>
|
|
<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_find_response_properties"><code>user_actions_find_response_properties</code> - </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>
|
|
|
|
<div class="model">
|
|
<h3><a name="4xx_response"><code>4xx_response</code> - Unsuccessful cases API response</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">error (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">message (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">statusCode (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="Case_response_properties_for_comments_inner"><code>Case_response_properties_for_comments_inner</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="Case_response_properties_for_connectors"><code>Case_response_properties_for_connectors</code> - Case response properties for connectors</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">fields </div><div class="param-desc"><span class="param-type"><a href="#connector_properties_swimlane_fields">connector_properties_swimlane_fields</a></span> </div>
|
|
<div class="param">id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The identifier for the connector. To retrieve connector IDs, use the find connectors API. </div>
|
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The name of the connector. </div>
|
|
<div class="param">type </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<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>
|
|
<div class="field-items">
|
|
<div class="param">alertId </div><div class="param-desc"><span class="param-type"><a href="#alert_identifiers">alert_identifiers</a></span> </div>
|
|
<div class="param">index </div><div class="param-desc"><span class="param-type"><a href="#alert_indices">alert_indices</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">rule </div><div class="param-desc"><span class="param-type"><a href="#rule">rule</a></span> </div>
|
|
<div class="param">type </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of comment. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">alert</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="add_case_comment_request"><code>add_case_comment_request</code> - Add case comment request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The add comment to case API request body varies depending on whether you are adding an alert or a comment.</div>
|
|
<div class="field-items">
|
|
<div class="param">alertId </div><div class="param-desc"><span class="param-type"><a href="#alert_identifiers">alert_identifiers</a></span> </div>
|
|
<div class="param">index </div><div class="param-desc"><span class="param-type"><a href="#alert_indices">alert_indices</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">rule </div><div class="param-desc"><span class="param-type"><a href="#rule">rule</a></span> </div>
|
|
<div class="param">type </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of comment. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">user</div>
|
|
<div class="param">comment </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The new comment. It is required only when <code>type</code> is <code>user</code>. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="add_user_comment_request_properties"><code>add_user_comment_request_properties</code> - Add case comment request properties for user comments</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines properties for case comment requests when type is user.</div>
|
|
<div class="field-items">
|
|
<div class="param">comment </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The new comment. It is required only when <code>type</code> is <code>user</code>. </div>
|
|
<div class="param">owner </div><div class="param-desc"><span class="param-type"><a href="#owners">owners</a></span> </div>
|
|
<div class="param">type </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of comment. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">user</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="alert_comment_response_properties"><code>alert_comment_response_properties</code> - Add case comment response properties for alerts</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="#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="#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="#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_rule"><code>alert_comment_response_properties_rule</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 rule identifier. </div>
|
|
<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The rule name. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="alert_identifiers"><code>alert_identifiers</code> - Alert identifiers</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The alert identifiers. It is required only when <code>type</code> is <code>alert</code>. You can use an array of strings to add multiple alerts to a case, provided that they all relate to the same rule; <code>index</code> must also be an array with the same length or number of elements. Adding multiple alerts in this manner is recommended rather than calling the API multiple times. 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>
|
|
<div class="field-items">
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="alert_indices"><code>alert_indices</code> - Alert indices</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The alert indices. It is required only when <code>type</code> is <code>alert</code>. If you are adding multiple alerts to a case, use an array of strings; the position of each index name in the array must match the position of the corresponding alert identifier in the <code>alertId</code> array. 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>
|
|
<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>
|
|
<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="case_response_created_by_properties"><code>case_response_created_by_properties</code> - Case response properties for created_by</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="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="#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>
|
|
<div class="param">connector </div><div class="param-desc"><span class="param-type"><a href="#Case_response_properties_for_connectors">Case_response_properties_for_connectors</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="#case_response_created_by_properties">case_response_created_by_properties</a></span> </div>
|
|
<div class="param">description </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">duration </div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> The elapsed time from the creation of the case to its closure (in seconds). If the case has not been closed, the duration is set to null. If the case was closed after less than half a second, the duration is rounded down to zero. </div>
|
|
<div class="param">external_service </div><div class="param-desc"><span class="param-type"><a href="#external_service">external_service</a></span> </div>
|
|
<div class="param">id </div><div class="param-desc"><span class="param-type"><a href="#string">String</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">settings </div><div class="param-desc"><span class="param-type"><a href="#settings">settings</a></span> </div>
|
|
<div class="param">severity </div><div class="param-desc"><span class="param-type"><a href="#severity_property">severity_property</a></span> </div>
|
|
<div class="param">status </div><div class="param-desc"><span class="param-type"><a href="#status">status</a></span> </div>
|
|
<div class="param">tags </div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> </div>
|
|
<div class="param">title </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">totalAlerts </div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> </div>
|
|
<div class="param">totalComment </div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> </div>
|
|
<div class="param">updated_at </div><div class="param-desc"><span class="param-type"><a href="#DateTime">Date</a></span> format: date-time</div>
|
|
<div class="param">updated_by </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 </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_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>
|
|
<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="case_response_updated_by_properties"><code>case_response_updated_by_properties</code> - Case response properties for updated_by</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="closure_types"><code>closure_types</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Indicates whether a case is automatically closed when it is pushed to external systems (<code>close-by-pushing</code>) or not automatically closed (<code>close-by-user</code>).</div>
|
|
<div class="field-items">
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="connector_properties_cases_webhook"><code>connector_properties_cases_webhook</code> - Create or upate case request properties for Cases Webhook connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines properties for connectors when type is <code>.cases-webhook</code>.</div>
|
|
<div class="field-items">
|
|
<div class="param">fields </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The identifier for the connector. To retrieve connector IDs, use the find connectors API. </div>
|
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The name of the connector. </div>
|
|
<div class="param">type </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.cases-webhook</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="connector_properties_jira"><code>connector_properties_jira</code> - Create or update case request properties for a Jira connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines properties for connectors when type is <code>.jira</code>.</div>
|
|
<div class="field-items">
|
|
<div class="param">fields </div><div class="param-desc"><span class="param-type"><a href="#connector_properties_jira_fields">connector_properties_jira_fields</a></span> </div>
|
|
<div class="param">id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The identifier for the connector. To retrieve connector IDs, use the find connectors API. </div>
|
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The name of the connector. </div>
|
|
<div class="param">type </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.jira</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="connector_properties_jira_fields"><code>connector_properties_jira_fields</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>An object containing the connector fields. If you want to omit any individual field, specify null as its value.</div>
|
|
<div class="field-items">
|
|
<div class="param">issueType </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of issue. </div>
|
|
<div class="param">parent </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. </div>
|
|
<div class="param">priority </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The priority of the issue. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="connector_properties_none"><code>connector_properties_none</code> - Create or update case request properties for no connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines properties for connectors when type is <code>.none</code>.</div>
|
|
<div class="field-items">
|
|
<div class="param">fields </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> An object containing the connector fields. To create a case without a connector, specify null. To update a case to remove the connector, specify null. </div>
|
|
<div class="param">id </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>. To update a case to remove the connector, specify <code>none</code>. </div>
|
|
<div class="param">name </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>. To update a case to remove the connector, specify <code>none</code>. </div>
|
|
<div class="param">type </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. To create a case without a connector, use <code>.none</code>. To update a case to remove the connector, specify <code>.none</code>. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.none</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="connector_properties_resilient"><code>connector_properties_resilient</code> - Create case request properties for a IBM Resilient connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines properties for connectors when type is <code>.resilient</code>.</div>
|
|
<div class="field-items">
|
|
<div class="param">fields </div><div class="param-desc"><span class="param-type"><a href="#connector_properties_resilient_fields">connector_properties_resilient_fields</a></span> </div>
|
|
<div class="param">id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The identifier for the connector. </div>
|
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The name of the connector. </div>
|
|
<div class="param">type </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.resilient</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="connector_properties_resilient_fields"><code>connector_properties_resilient_fields</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>An object containing the connector fields. If you want to omit any individual field, specify null as its value.</div>
|
|
<div class="field-items">
|
|
<div class="param">issueTypes </div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> The type of incident. </div>
|
|
<div class="param">severityCode </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The severity code of the incident. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="connector_properties_servicenow"><code>connector_properties_servicenow</code> - Create case request properties for a ServiceNow ITSM connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines properties for connectors when type is <code>.servicenow</code>.</div>
|
|
<div class="field-items">
|
|
<div class="param">fields </div><div class="param-desc"><span class="param-type"><a href="#connector_properties_servicenow_fields">connector_properties_servicenow_fields</a></span> </div>
|
|
<div class="param">id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The identifier for the connector. To retrieve connector IDs, use the find connectors API. </div>
|
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The name of the connector. </div>
|
|
<div class="param">type </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.servicenow</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="connector_properties_servicenow_fields"><code>connector_properties_servicenow_fields</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>An object containing the connector fields. If you want to omit any individual field, specify null as its value.</div>
|
|
<div class="field-items">
|
|
<div class="param">category </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The category of the incident. </div>
|
|
<div class="param">impact </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The effect an incident had on business. </div>
|
|
<div class="param">severity </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The severity of the incident. </div>
|
|
<div class="param">subcategory </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The subcategory of the incident. </div>
|
|
<div class="param">urgency </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. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="connector_properties_servicenow_sir"><code>connector_properties_servicenow_sir</code> - Create case request properties for a ServiceNow SecOps connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines properties for connectors when type is <code>.servicenow-sir</code>.</div>
|
|
<div class="field-items">
|
|
<div class="param">fields </div><div class="param-desc"><span class="param-type"><a href="#connector_properties_servicenow_sir_fields">connector_properties_servicenow_sir_fields</a></span> </div>
|
|
<div class="param">id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The identifier for the connector. To retrieve connector IDs, use the find connectors API. </div>
|
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The name of the connector. </div>
|
|
<div class="param">type </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.servicenow-sir</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="connector_properties_servicenow_sir_fields"><code>connector_properties_servicenow_sir_fields</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>An object containing the connector fields. If you want to omit any individual field, specify null as its value.</div>
|
|
<div class="field-items">
|
|
<div class="param">category </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The category of the incident. </div>
|
|
<div class="param">destIp </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. </div>
|
|
<div class="param">malwareHash </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. </div>
|
|
<div class="param">malwareUrl </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. </div>
|
|
<div class="param">priority </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The priority of the issue. </div>
|
|
<div class="param">sourceIp </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. </div>
|
|
<div class="param">subcategory </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The subcategory of the incident. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="connector_properties_swimlane"><code>connector_properties_swimlane</code> - Create case request properties for a Swimlane connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines properties for connectors when type is <code>.swimlane</code>.</div>
|
|
<div class="field-items">
|
|
<div class="param">fields </div><div class="param-desc"><span class="param-type"><a href="#connector_properties_swimlane_fields">connector_properties_swimlane_fields</a></span> </div>
|
|
<div class="param">id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The identifier for the connector. To retrieve connector IDs, use the find connectors API. </div>
|
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The name of the connector. </div>
|
|
<div class="param">type </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.swimlane</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="connector_properties_swimlane_fields"><code>connector_properties_swimlane_fields</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>An object containing the connector fields. If you want to omit any individual field, specify null as its value.</div>
|
|
<div class="field-items">
|
|
<div class="param">caseId </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The case identifier for Swimlane connectors. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="connector_types"><code>connector_types</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The type of connector.</div>
|
|
<div class="field-items">
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<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="#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>
|
|
<div class="param">settings </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">tags </div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> The words and phrases that help categorize cases. It can be an empty array. </div>
|
|
<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_connector"><code>create_case_request_connector</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">fields </div><div class="param-desc"><span class="param-type"><a href="#connector_properties_swimlane_fields">connector_properties_swimlane_fields</a></span> </div>
|
|
<div class="param">id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The identifier for the connector. To retrieve connector IDs, use the find connectors API. </div>
|
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The name of the connector. </div>
|
|
<div class="param">type </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.swimlane</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="external_service"><code>external_service</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">connector_id (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">connector_name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">external_id (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<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="#getCaseConfiguration_200_response_inner_updated_by">getCaseConfiguration_200_response_inner_updated_by</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="findCaseActivity_200_response"><code>findCaseActivity_200_response</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">page (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> </div>
|
|
<div class="param">perPage (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 class="param">userActions (optional)</div><div class="param-desc"><span class="param-type"><a href="#user_actions_find_response_properties">array[user_actions_find_response_properties]</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="findCaseConnectors_200_response_inner"><code>findCaseConnectors_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">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="#findCaseConnectors_200_response_inner_config">findCaseConnectors_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="findCaseConnectors_200_response_inner_config"><code>findCaseConnectors_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">
|
|
<h3><a name="findCases_200_response"><code>findCases_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="findCases_assignees_parameter"><code>findCases_assignees_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="findCases_owner_parameter"><code>findCases_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="findCases_searchFields_parameter"><code>findCases_searchFields_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="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>
|
|
<div class="field-items">
|
|
<div class="param">closure_type (optional)</div><div class="param-desc"><span class="param-type"><a href="#closure_types">closure_types</a></span> </div>
|
|
<div class="param">connector (optional)</div><div class="param-desc"><span class="param-type"><a href="#getCaseConfiguration_200_response_inner_connector">getCaseConfiguration_200_response_inner_connector</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="#getCaseConfiguration_200_response_inner_created_by">getCaseConfiguration_200_response_inner_created_by</a></span> </div>
|
|
<div class="param">error (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</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">mappings (optional)</div><div class="param-desc"><span class="param-type"><a href="#getCaseConfiguration_200_response_inner_mappings_inner">array[getCaseConfiguration_200_response_inner_mappings_inner]</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">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="#getCaseConfiguration_200_response_inner_updated_by">getCaseConfiguration_200_response_inner_updated_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="getCaseConfiguration_200_response_inner_connector"><code>getCaseConfiguration_200_response_inner_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="#">Object</a></span> The fields specified in the case configuration are not used and are not propagated to individual cases, therefore it is recommended to set it to <code>null</code>. </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. If you do not want a default connector, use <code>none</code>. To retrieve connector IDs, use the find connectors API. </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. If you do not want a default connector, use <code>none</code>. To retrieve connector names, use the find connectors API. </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="getCaseConfiguration_200_response_inner_created_by"><code>getCaseConfiguration_200_response_inner_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="getCaseConfiguration_200_response_inner_mappings_inner"><code>getCaseConfiguration_200_response_inner_mappings_inner</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">action_type (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">source (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">target (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_updated_by"><code>getCaseConfiguration_200_response_inner_updated_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="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="owners"><code>owners</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The application that owns the cases: Stack Management, Observability, or Elastic Security.</div>
|
|
<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 alerts. 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>
|
|
<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 rule identifier. </div>
|
|
<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The rule name. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="search_fields"><code>search_fields</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The fields to perform the <code>simple_query_string</code> parsed query against.</div>
|
|
<div class="field-items">
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="setCaseConfiguration_request"><code>setCaseConfiguration_request</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">closure_type </div><div class="param-desc"><span class="param-type"><a href="#closure_types">closure_types</a></span> </div>
|
|
<div class="param">connector </div><div class="param-desc"><span class="param-type"><a href="#setCaseConfiguration_request_connector">setCaseConfiguration_request_connector</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">settings (optional)</div><div class="param-desc"><span class="param-type"><a href="#setCaseConfiguration_request_settings">setCaseConfiguration_request_settings</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="setCaseConfiguration_request_connector"><code>setCaseConfiguration_request_connector</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>An object that contains the connector configuration.</div>
|
|
<div class="field-items">
|
|
<div class="param">fields </div><div class="param-desc"><span class="param-type"><a href="#">Object</a></span> The fields specified in the case configuration are not used and are not propagated to individual cases, therefore it is recommended to set it to <code>null</code>. </div>
|
|
<div class="param">id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The identifier for the connector. If you do not want a default connector, use <code>none</code>. To retrieve connector IDs, use the find connectors API. </div>
|
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The name of the connector. If you do not want a default connector, use <code>none</code>. To retrieve connector names, use the find connectors API. </div>
|
|
<div class="param">type </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="setCaseConfiguration_request_settings"><code>setCaseConfiguration_request_settings</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>An object that contains the case settings.</div>
|
|
<div class="field-items">
|
|
<div class="param">syncAlerts </div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Turns alert syncing on or off. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="settings"><code>settings</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>An object that contains the case settings.</div>
|
|
<div class="field-items">
|
|
<div class="param">syncAlerts </div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Turns alert syncing on or off. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="severity_property"><code>severity_property</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The severity of the case.</div>
|
|
<div class="field-items">
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="status"><code>status</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The status of the case.</div>
|
|
<div class="field-items">
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="updateCaseConfiguration_request"><code>updateCaseConfiguration_request</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">closure_type (optional)</div><div class="param-desc"><span class="param-type"><a href="#closure_types">closure_types</a></span> </div>
|
|
<div class="param">connector (optional)</div><div class="param-desc"><span class="param-type"><a href="#setCaseConfiguration_request_connector">setCaseConfiguration_request_connector</a></span> </div>
|
|
<div class="param">version </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The version of the connector. To retrieve the version value, use the get configuration API. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="update_alert_comment_request_properties"><code>update_alert_comment_request_properties</code> - Update 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>
|
|
<div class="field-items">
|
|
<div class="param">alertId </div><div class="param-desc"><span class="param-type"><a href="#alert_identifiers">alert_identifiers</a></span> </div>
|
|
<div class="param">id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The identifier for the comment. To retrieve comment IDs, use the get comments API. </div>
|
|
<div class="param">index </div><div class="param-desc"><span class="param-type"><a href="#alert_indices">alert_indices</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">rule </div><div class="param-desc"><span class="param-type"><a href="#rule">rule</a></span> </div>
|
|
<div class="param">type </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of comment. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">alert</div>
|
|
<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="update_case_comment_request"><code>update_case_comment_request</code> - Update case comment request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The update case comment API request body varies depending on whether you are updating an alert or a comment.</div>
|
|
<div class="field-items">
|
|
<div class="param">alertId </div><div class="param-desc"><span class="param-type"><a href="#alert_identifiers">alert_identifiers</a></span> </div>
|
|
<div class="param">id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The identifier for the comment. To retrieve comment IDs, use the get comments API. </div>
|
|
<div class="param">index </div><div class="param-desc"><span class="param-type"><a href="#alert_indices">alert_indices</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">rule </div><div class="param-desc"><span class="param-type"><a href="#rule">rule</a></span> </div>
|
|
<div class="param">type </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of comment. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">user</div>
|
|
<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 class="param">comment </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The new comment. It is required only when <code>type</code> is <code>user</code>. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="update_case_request"><code>update_case_request</code> - Update case request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The update case API request body varies depending on the type of connector.</div>
|
|
<div class="field-items">
|
|
<div class="param">cases </div><div class="param-desc"><span class="param-type"><a href="#update_case_request_cases_inner">array[update_case_request_cases_inner]</a></span> An array containing one or more case objects. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<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="#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>
|
|
<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> The words and phrases that help categorize cases. </div>
|
|
<div class="param">title (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> A title for the case. </div>
|
|
<div class="param">version </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The current version of the case. To determine this value, use the get case or find cases APIs. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="update_user_comment_request_properties"><code>update_user_comment_request_properties</code> - Update case comment request properties for user comments</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines properties for case comment requests when type is user.</div>
|
|
<div class="field-items">
|
|
<div class="param">comment </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The new comment. It is required only when <code>type</code> is <code>user</code>. </div>
|
|
<div class="param">id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The identifier for the comment. To retrieve comment IDs, use the get comments API. </div>
|
|
<div class="param">owner </div><div class="param-desc"><span class="param-type"><a href="#owners">owners</a></span> </div>
|
|
<div class="param">type </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of comment. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">user</div>
|
|
<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_find_response_properties"><code>user_actions_find_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">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">id </div><div class="param-desc"><span class="param-type"><a href="#string">String</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">version </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">type </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of action. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">assignees</div><div class="param-enum">create_case</div><div class="param-enum">comment</div><div class="param-enum">connector</div><div class="param-enum">description</div><div class="param-enum">pushed</div><div class="param-enum">tags</div><div class="param-enum">title</div><div class="param-enum">status</div><div class="param-enum">settings</div><div class="param-enum">severity</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>
|
|
<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">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">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">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> <!-- field-items -->
|
|
</div>
|
|
</div>
|
|
++++
|