Method: caseAlerts.fetchRecommendation

Full name: projects.locations.instances.cases.caseAlerts.fetchRecommendation

fetch recommendation for an alert.

HTTP request


GET https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{parent}/caseAlerts:fetchRecommendation

Path parameters

Parameters
parent

string

Required. The unique name(ID) of the CaseAlert.

Query parameters

Parameters
recommendationId

string

Required. The requested recommendation id.

Request body

The request body must be empty.

Response body

Response message for caseAlerts.fetchRecommendation.

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

JSON representation 
{
  "recommendation": string,
  "alertIdentifierToCaseId": {
    string: integer,
    ...
  },
  "marketplaceActionsTriggeredManually": [
    string
  ],
  "state": enum (RecommendationResponseState)
}
Fields
recommendation

string

Output only. The recommendation text.
alertIdentifierToCaseId

map (key: string, value: integer)

Output only. Mapping of alert identifiers to case IDs.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
marketplaceActionsTriggeredManually[]

string

Optional. List of marketplace actions triggered manually.
state

enum (RecommendationResponseState)

Output only. The recommendation response state.

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 parent resource:

  • chronicle.caseAlerts.get

For more information, see the IAM documentation.

RecommendationResponseState

The recommendation response state.

Enums
RECOMMENDATION_RESPONSE_STATE_UNSPECIFIED The recommendation response state is unspecified.
RUNNING The recommendation is running.
SUCCEEDED The recommendation is succeeded.
FAILED The recommendation is failed.