Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Edit get tags API #129963

Merged
merged 2 commits into from
Apr 13, 2022
Merged

[DOCS] Edit get tags API #129963

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ef3efe5
[DOCS] Edit get tags API
lcawl Apr 11, 2022
04cdc46
Merge branch 'main' into lcawl-patch-1
lcawl Apr 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 6 additions & 13 deletions docs/api/cases/cases-api-get-tags.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -21,20 +21,16 @@ 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.

=== 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

Expand All @@ -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]
--------------------------------------------------
Expand All @@ -62,4 +55,4 @@ opened cases. For example:
"social engineering",
"bubblegum"
]
--------------------------------------------------
--------------------------------------------------