Method: cases.getCaseOverviewData

Full name: projects.locations.instances.cases.getCaseOverviewData

Retrieves the case view metadaata. This method is used to get the information needed to render the case view, including the associated widgets defined in the case view.

HTTP request


GET https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{name}:caseOverviewData

Path parameters

Parameters
name

string

Required. The case to get overview for. Format: projects/{project}/locations/{location}/instances/{instance}/cases/{case}:getOverview

Query parameters

Parameters
viewId

string (int64 format)

Optional. The view ID to get overview data for. If not provided, this will return the default case view.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of OverviewData.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • chronicle.cases.get

For more information, see the IAM documentation.