Method: legacySoarDashboard.legacyGetDashboardWidgetDefinitions

Full name: projects.locations.instances.legacySoarDashboard.legacyGetDashboardWidgetDefinitions

Returns the widget definitions of a dashboard.

HTTP request


Path parameters

Parameters
instance

string

Required. The instance to get the dashboard widget definitions for. Format: projects/{project}/locations/{location}/instances/{instance}

Request body

The request body must be empty.

Response body

GetLegacySoarDashboardWidgetDefinitionsResponse represents the response for getting dashboard widget definitions.

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

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

object (DashboardWidgetDefinitionDataModel)

Optional. The data model of the dashboard widget definitions.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

DashboardWidgetDefinitionDataModel

DashboardWidgetDefinitionDataModel represents the data model for a dashboard widget definition.

JSON representation 
{
  "id": integer,
  "name": string,
  "description": string,
  "widgetPreviewImage": string,
  "widgetType": enum (DashboardWidgetTypesEnum),
  "axisXDescription": string,
  "axisYDescription": string,
  "creationTimeUnixTimeInMs": string,
  "modificationTimeUnixTimeInMs": string
}
Fields
id

integer

Optional. The ID of the widget.
name

string

Optional. The name of the widget.
description

string

Optional. The description of the widget.
widgetPreviewImage

string

Optional. The widget preview image.
widgetType

enum (DashboardWidgetTypesEnum)

Optional. The type of the widget.
axisXDescription

string

Optional. The description of the x axis.
axisYDescription

string

Optional. The description of the y axis.
creationTimeUnixTimeInMs

string (int64 format)

Optional. The creation time of the widget in Unix time in milliseconds.
modificationTimeUnixTimeInMs

string (int64 format)

Optional. The update time of the widget in Unix time in milliseconds.

DashboardWidgetTypesEnum

DashboardWidgetTypesEnum is an enum that represents the widget types for a dashboard.

Enums
DASHBOARD_WIDGET_TYPE_UNSPECIFIED Unspecified widget type
CUSTOM Custom type
PLAYBOOK_MONITORING Playbook monitoring