Method: legacySoarDashboard.legacySaveDashboardAsReportTemplate

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

Saves a dashboard as a report template.

HTTP request


Path parameters

Parameters
instance

string

Required. The instance to save the dashboard as a report template for. Format: projects/{project}/locations/{location}/instances/{instance}

Request body

The request body contains data with the following structure:

JSON representation
{
  "id": integer,
  "creator": string,
  "creatorFullName": string,
  "category": enum (ReportTemplateCategoryEnum),
  "name": string,
  "reportWidgets": [
    {
      object (LegacySoarDashboardWidgetDataModel)
    }
  ],
  "creationTimeUnixTimeInMs": string,
  "lastModifiedTimeUnixTimeInMs": string,
  "isSystem": boolean,
  "hasScheduler": boolean
}
Fields
id

integer

Optional. The dashboard id to save as a report template.

creator
(deprecated)

string

Optional. The creator of the report template.

creatorFullName
(deprecated)

string

Optional. The creator full name of the report template.

category

enum (ReportTemplateCategoryEnum)

Optional. The category of the report template.

name

string

Optional. The name of the report template.

reportWidgets[]

object (LegacySoarDashboardWidgetDataModel)

Optional. The report widgets of the report template.

creationTimeUnixTimeInMs

string (int64 format)

Optional. The creation time of the report template.

lastModifiedTimeUnixTimeInMs

string (int64 format)

Optional. The last modified time of the report template.

isSystem

boolean

Optional. Is the report template a system report template.

hasScheduler

boolean

Optional. Does the report template has scheduler.

Response body

If successful, the response body is an empty JSON object.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

ReportTemplateCategoryEnum

ReportTemplateCategoryEnum is an enum that represents the report template category.

Enums
ROI Roi category
MANAGEMENT Management category
SLA Sla category
TIER1 Tier1 category
GENERAL General category