Method: views.fetchPredefined

Full name: projects.locations.instances.views.fetchPredefined

Fetch predefined widgets coming from integations.

HTTP request


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

Path parameters

Parameters
parent

string

Required. Format: projects/{project}/locations/{location}/instances/{instance}

Query parameters

Parameters
scope

string

Required. The scope of the predefined widgets.

Request body

The request body must be empty.

Response body

Response message for views.fetchPredefined.

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

JSON representation 
{
  "payload": [
    {
      object (PredefinedCaseAlertViewWidget)
    }
  ]
}
Fields
payload[]

object (PredefinedCaseAlertViewWidget)

The list of predefined widgets.

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.views.get

For more information, see the IAM documentation.

PredefinedCaseAlertViewWidget

Represents the full response for a predefined Case Alert View widget configuration.

JSON representation 
{
  "config": {
    object (PredefinedCaseAlertViewWidgetConfig)
  },
  "actionIdentifier": string,
  "conditionsGroup": {
    object (WidgetConditionsGroup)
  },
  "description": string,
  "integration": string,
  "identifier": string,
  "title": string,
  "name": string,
  "supported": boolean,
  "presentIfEmpty": boolean,
  "type": enum (ViewWidgetTemplateTypeEnum),
  "width": enum (WidgetTemplateGridColumnsEnum),
  "scope": enum (TargetScopeEnum)
}
Fields
config

object (PredefinedCaseAlertViewWidgetConfig)

Output only. Optional config section defining rendering and type metadata
actionIdentifier

string

Output only. The identifier of the action linked to this widget
conditionsGroup

object (WidgetConditionsGroup)

Output only. Optional condition group for filtering or conditional display logic Define ConditionsGroup separately
description

string

Output only. Description of the widget
integration

string

Output only. The name of the integration that provides this widget
identifier

string

Output only. Unique identifier for this widget
title

string

Output only. The title displayed on the widget
name

string

Output only. The internal or user-facing name of the widget
supported

boolean

Output only. Indicates if the widget is supported
presentIfEmpty

boolean

Output only. Indicates if the widget should be shown even when data is empty
type

enum (ViewWidgetTemplateTypeEnum)

Output only. The widget template type (e.g., statistics, wall activity, etc.)
width

enum (WidgetTemplateGridColumnsEnum)

Output only. The layout width of the widget in grid columns
scope

enum (TargetScopeEnum)

Output only. The scope in which this widget is applicable (e.g., global, case, alert)

PredefinedCaseAlertViewWidgetConfig

Configuration metadata for rendering a predefined widget.

JSON representation 
{
  "type": enum (ViewWidgetTemplateTypeEnum),
  "htmlContent": string,
  "widgetDefinitionScope": enum (TargetScopeEnum),
  "htmlHeight": integer,
  "safeRendering": boolean
}
Fields
type

enum (ViewWidgetTemplateTypeEnum)

Output only. The widget type (e.g., statistics, wall activity, etc.)
htmlContent

string

Output only. Optional raw HTML content to be rendered in the widget
widgetDefinitionScope

enum (TargetScopeEnum)

Output only. The target scope of the widget (e.g., case-level, alert-level, both)
htmlHeight

integer

Output only. Optional HTML height in pixels for the widget content
safeRendering

boolean

Output only. Indicates if HTML should be safely rendered