Method: legacySoarReports.download

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

legacySoarReports.download to generate a report template.

HTTP request


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

Path parameters

Parameters
name

string

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

Query parameters

Parameters
templateEncoded

string

Optional. Encoded report template here
type

enum (ReportTypeEnum)

Optional. The type of the report.
environments[]

string

Required. The environments for the report template.
timeFilter

enum (DashboardTimeRangeTypesEnums)

Required. The time filter for the dashboard.
id

string (int64 format)

Required. The report id.

Request body

The request body must be empty.

Response body

Response message for legacySoarReports.download.

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

JSON representation 
{
  "media": {
    object (Media)
  }
}
Fields
media

object (Media)

Zipped file with the integration content. Includes the following folders: Actions, Connectors, Jobs, Managers, Dependencies Each folder includes json files and a python file for the script. Includes integration definition json file. Includes metadata.json file Information representing the imported data

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

  • chronicle.legacySoarReports.get

For more information, see the IAM documentation.

ReportTypeEnum

ReportTypeEnum defines the type of the report.

Enums
PDF Pdf report type.
RTF Rtf report type.
DOC Doc report type.
DOCX Docx report type.
HTML Html report type.
XLSX Xlsx report type.
CSV Csv report type.

DashboardTimeRangeTypesEnums

LINT: LEGACY_NAMES DashboardTimeRangeTypesEnums is an enum that represents the time range types for a dashboard.

Enums
DASHBOARD_TIME_RANGE_TYPE_UNSPECIFIED Custom time range
LAST_DAY Last day
LAST_3_DAYS Last 3 days
LAST_WEEK Last week
LAST_2_WEEKS Last 2 weeks
LAST_MONTH Last month
LAST_3_MONTHS Last 3 months
LAST_6_MONTHS Last 6 months
LAST_YEAR Last year