Method: legacySoarReports.legacyGetReportTemplates

Full name: projects.locations.instances.legacySoarReports.legacyGetReportTemplates

legacySoarReports.legacyGetReportTemplates to get report templates.

HTTP request


GET https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{instance}/legacySoarReports:legacyGetReportTemplates

Path parameters

Parameters
instance

string

Required. The instance to get the report templates for. Format: projects/{project}/locations/{location}/instances/{instance}

Request body

The request body must be empty.

Response body

Response message for legacySoarReports.legacyGetReportTemplates.

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

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

object (LegacyReportTemplateDetails)

Optional. The report templates.

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 instance resource:

  • chronicle.legacySoarReports.get

For more information, see the IAM documentation.

LegacyReportTemplateDetails

ReportTemplateDetails represents the details of a report template.

JSON representation 
{
  "creator": string,
  "creatorFullName": string,
  "category": enum (ReportTemplateCategoryEnum),
  "name": string,
  "reportWidgets": [
    {
      object (LegacyDashboardWidgetDataModel)
    }
  ],
  "id": string,
  "creationTimeUnixTimeInMs": string,
  "modificationTimeUnixTimeInMs": string,
  "isSystem": boolean,
  "hasScheduler": boolean
}
Fields
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 (LegacyDashboardWidgetDataModel)

Optional. The report widgets of the report template.
id

string (int64 format)

Output only. The report template id.
creationTimeUnixTimeInMs

string (int64 format)

Optional. The creation time of the report template.
modificationTimeUnixTimeInMs

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.

ReportTemplateCategoryEnum

ReportTemplateCategoryEnum defines the category of the report template.

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