Method: views.saveOverviewTemplate

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

Save an overview template.

HTTP request


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

Path parameters

Parameters
parent

string

Required. The onotlogy record to import visual families for. Format: projects/{project}/locations/{location}/instances/{instance}/Views/{view}

Request body

The request body contains an instance of OverviewTemplateData.

Response body

Represents a full overview template containing widgets and metadata.

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

JSON representation 
{
  "identifier": string,
  "name": string,
  "creator": string,
  "playbookIdentifier": string,
  "widgets": [
    {
      object (TemplateWidgetDefinition)
    }
  ],
  "roles": [
    string
  ],
  "id": string,
  "type": enum (OverviewTemplateEnum),
  "creationTimeUnixTimeInMs": string
}
Fields
identifier

string

Required. Unique string identifier for this overview template.
name

string

Required. Display name of the overview template.
creator

string

Optional. Username or ID of the creator.
playbookIdentifier

string

Optional. Related playbook identifier (should be a GUID string).
widgets[]

object (TemplateWidgetDefinition)

Optional. List of widget definitions contained in the template.
roles[]

string (int64 format)

Optional. List of role IDs assigned to this overview.
id

string (int64 format)

Required. Unique numeric ID of the template.
type

enum (OverviewTemplateEnum)

Required. Type of the overview template.
creationTimeUnixTimeInMs

string (int64 format)

Required. Creation timestamp (Unix epoch time in milliseconds).

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.update

For more information, see the IAM documentation.

OverviewTemplateEnum

Specifies the type or category of the overview template.

Enums
OVERVIEW_TEMPLATE_ENUM_UNSPECIFIED Unspecified overview template type.
PLAYBOOK_DEFAULT Default overview template type.
REGULAR Regular overview template type.
SYSTEM_ALERT System alert overview template type.
SYSTEM_CASE System case overview template type.
ALERT_TYPE Alert type overview template type.