mirror of
https://github.com/elastic/kibana.git
synced 2025-04-23 17:28:26 -04:00
[DOCS] Add assignees query parameter to find cases API (#146087)
This commit is contained in:
parent
9c5e96c56d
commit
e1227a3fe9
5 changed files with 48 additions and 4 deletions
|
@ -1085,7 +1085,9 @@ Any modifications made to this file will be overwritten.
|
|||
|
||||
<h3 class="field-label">Query parameters</h3>
|
||||
<div class="field-items">
|
||||
<div class="param">defaultSearchOperator (optional)</div>
|
||||
<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">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">fields (optional)</div>
|
||||
|
||||
|
@ -1922,8 +1924,8 @@ Any modifications made to this file will be overwritten.
|
|||
<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="#getCases_200_response"><code>getCases_200_response</code> - </a></li>
|
||||
<li><a href="#getCases_assignees_parameter"><code>getCases_assignees_parameter</code> - </a></li>
|
||||
<li><a href="#getCases_owner_parameter"><code>getCases_owner_parameter</code> - </a></li>
|
||||
<li><a href="#getCases_reporters_parameter"><code>getCases_reporters_parameter</code> - </a></li>
|
||||
<li><a href="#owners"><code>owners</code> - </a></li>
|
||||
<li><a href="#payload_alert_comment"><code>payload_alert_comment</code> - </a></li>
|
||||
<li><a href="#payload_alert_comment_comment"><code>payload_alert_comment_comment</code> - </a></li>
|
||||
|
@ -2485,13 +2487,13 @@ Any modifications made to this file will be overwritten.
|
|||
</div> <!-- field-items -->
|
||||
</div>
|
||||
<div class="model">
|
||||
<h3><a name="getCases_owner_parameter"><code>getCases_owner_parameter</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
||||
<h3><a name="getCases_assignees_parameter"><code>getCases_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="getCases_reporters_parameter"><code>getCases_reporters_parameter</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
||||
<h3><a name="getCases_owner_parameter"><code>getCases_owner_parameter</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
||||
<div class='model-description'></div>
|
||||
<div class="field-items">
|
||||
</div> <!-- field-items -->
|
||||
|
|
|
@ -33,6 +33,12 @@ default space is used.
|
|||
|
||||
=== {api-query-parms-title}
|
||||
|
||||
`assignees`::
|
||||
(Optional, string or array of strings) Filters the returned cases by assignees.
|
||||
Valid values are `none` or unique identifiers for the user profiles. These
|
||||
identifiers can be found by using the
|
||||
{ref}/security-api-suggest-user-profile.html[suggest user profile API].
|
||||
|
||||
`defaultSearchOperator`::
|
||||
(Optional, string) The default operator to use for the `simple_query_string`.
|
||||
Defaults to `OR`.
|
||||
|
|
|
@ -188,6 +188,24 @@
|
|||
{
|
||||
"$ref": "#/components/parameters/space_id"
|
||||
},
|
||||
{
|
||||
"name": "assignees",
|
||||
"in": "query",
|
||||
"description": "Filters the returned cases by assignees. Valid values are `none` or unique identifiers for the user profiles. These identifiers can be found by using the suggest user profile API.",
|
||||
"schema": {
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "defaultSearchOperator",
|
||||
"in": "query",
|
||||
|
|
|
@ -113,6 +113,15 @@ paths:
|
|||
- cases
|
||||
parameters:
|
||||
- $ref: '#/components/parameters/space_id'
|
||||
- name: assignees
|
||||
in: query
|
||||
description: Filters the returned cases by assignees. Valid values are `none` or unique identifiers for the user profiles. These identifiers can be found by using the suggest user profile API.
|
||||
schema:
|
||||
oneOf:
|
||||
- type: string
|
||||
- type: array
|
||||
items:
|
||||
type: string
|
||||
- name: defaultSearchOperator
|
||||
in: query
|
||||
description: The default operator to use for the simple_query_string.
|
||||
|
|
|
@ -9,6 +9,15 @@ get:
|
|||
- cases
|
||||
parameters:
|
||||
- $ref: '../components/parameters/space_id.yaml'
|
||||
- name: assignees
|
||||
in: query
|
||||
description: Filters the returned cases by assignees. Valid values are `none` or unique identifiers for the user profiles. These identifiers can be found by using the suggest user profile API.
|
||||
schema:
|
||||
oneOf:
|
||||
- type: string
|
||||
- type: array
|
||||
items:
|
||||
type: string
|
||||
- name: defaultSearchOperator
|
||||
in: query
|
||||
description: The default operator to use for the simple_query_string.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue