Method: legacySearches.legacyGetCasesFilterValues

Full name: projects.locations.instances.legacySearches.legacyGetCasesFilterValues

legacySearches.legacyGetCasesFilterValues to get cases filter values.

HTTP request


POST https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{instance}/legacySearches:legacyGetCasesFilterValues

Path parameters

Parameters
instance

string

Required. The instance to get the search results for. Format: projects/{project}/locations/{location}/instances/{instance}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "typeOfFilter": enum (LegacyCaseSearchFilterTypeEnum),
  "numberOfValuesToReturn": integer,
  "searchTerm": string
}
Fields
typeOfFilter

enum (LegacyCaseSearchFilterTypeEnum)

Required. Type of filter.
numberOfValuesToReturn

integer

Optional. Number of values to return.
searchTerm

string

Optional. Search term.

Response body

Response for legacySearches.legacyGetCasesFilterValues.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "payload": [
    string
  ]
}
Fields
payload[]

string

Optional. The filter values.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the instance resource:

  • chronicle.legacySearches.searchCases

For more information, see the IAM documentation.

LegacyCaseSearchFilterTypeEnum

Enum that represents the case search filter type.

Enums
TAGS Tags filter type.
ENVIRONMENTS Environments filter type.
ASSIGNED_USERS Assigned users filter type.
PRODUCTS Products filter type.
PORTS Ports filter type.
CATEGORY_OUTCOMES Category outcomes filter type.
ALERT_NAME Alert name filter type.
ALERT_TYPE Alert type filter type.
ALERT_PLAYBOOK_TRIGGER Alert playbook trigger filter type.
VENDORS Vendors filter type.
ROOT_CAUSE_CLOSES Root cause closes filter type.
USERS_AND_SOC_ROLES Users and soc roles filter type.