github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 17:28:26 -04:00
Code Issues Projects Releases Packages Wiki Activity

[DOCS] Edit get tags API (#129963)

Browse source
This commit is contained in:
Lisa Cawley 2022-04-13 08:09:24 -07:00 • committed by GitHub
parent 1e4069882e
commit 724cd40267
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

19
docs/api/cases/cases-api-get-tags.asciidoc
View file

@ -4,7 +4,7 @@
<titleabbrev>Get tags</titleabbrev>
++++
Aggregates and returns all unique tags from all cases.
Aggregates and returns a list of case tags.
=== Request
@ -21,10 +21,6 @@ You must have `read` privileges for the *Cases* feature in the *Management*,
=== Path parameters
`<case_id>`::
(Required, string) An identifier for the case to retrieve. Use
<<cases-api-find-cases>> to retrieve case IDs.
`<space_id>`::
(Optional, string) An identifier for the space. If it is not specified, the
default space is used.
@ -32,9 +28,9 @@ default space is used.
=== Query parameters
`owner`::
(Optional, string or array of strings) Specifies the set of applications to
limit the retrieved tags. If not specified, the response contains all tags from
cases that the user has access to read.
(Optional, string or array of strings) A filter to limit the retrieved tags to a specific set of applications.
Valid values are: `cases`, `observability`, and `securitySolution`. If this parameter is omitted, the response
contains tags from all cases that the user has access to read.
==== Response code
@ -43,16 +39,13 @@ cases that the user has access to read.
==== Example
Gets all tags for all cases:
[source,sh]
--------------------------------------------------
GET api/cases/tags
--------------------------------------------------
// KIBANA
The API returns a JSON object with the names and email addresses of users who
opened cases. For example:
The API returns a JSON object with tags from all the cases that the user has access to read. For example:
[source,json]
--------------------------------------------------
@ -62,4 +55,4 @@ opened cases. For example:
"social engineering",
"bubblegum"
]
--------------------------------------------------
--------------------------------------------------