Returns a list of cases
Scope
guardian-cases:read
Body Response - Schema
200 (list containing paginated cases)
| Parameter | Type | Description | Required |
|---|---|---|---|
| _embedded | array[object] | "_embedded" subdivides into: 1 - "baseline" (integer 2 - "case" (string) - The ID of the case. 3 - "event_id" (string) - the ID of the event that triggered the anomaly. 4 - "hits" (integer 5 - "hits_number" (array[string]) - the number of anomalous values. Required. 6 - "id" (string) - the ID of the anomaly. 7 - "id" (string) - the ID of the anomaly. 8 - "ingest_timestamp" (string<date-time>) - ingestion date of the anomaly. 9 - "pop_baseline" (array[string]) - the peer baseline. Required. 10 - "pop_conf" (number<double>) - confidence in the anomaly regarding the peer baseline. Required. 11 - "pop_prob" (number<double>) - probability of 'hits' for the peers. Required. 12 - "source" (string) - source of the anomaly. 13 - "specification" (string) - specification of the case. Example: 14 - "user_baseline" (array[string]) - the user baseline. Required. 15 - "user_conf" (number<double>) - confidence in the anomaly regarding the user baseline. Required. 16 - "user_id" (string) - the ID of the user that triggered the anomaly. 17 - "user_prob" (number<double>) - probability of 'hits' for the user. Required. | yes |
| _links | Object | "_links" subdivides into: 1 - "first" (object) - the first page link. 2 - "last" (object) - the last page link. 3 - "next" (object) - the next page link. 4 - "prev" (object) - the previous page link. 5 - "self" (object) - the current page link. 6 - "show" (object) - the show link. | no |
| count | integer<int32> | The number of results in the current page. Example: 10 | no |
| page | integer<int32> | The current page. Example: 10 | no |
| per_page | integer<int32> | The number of results per page. Example: 10 | no |
| total | integer<int64> | The total number of results. Example: 10 | no |
| total_page | integer<int64> | The total number of pages. Example: 5 | no |
400 (bad request), 401 (unauthorized), 403 (forbidden)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | n/a | yes |
| message | string | n/a | yes |
| description | string | n/a | no |
| fields | array[object] | "fields" subdivides into: "name" (string) "description" (string) | yes (name and description) |
TroubleshootingIf you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.