Method: legacySoarReports.legacyAddOrUpdateReportSchedule

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

legacySoarReports.legacyAddOrUpdateReportSchedule to add or update a report schedule.

HTTP request


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

Path parameters

Parameters
instance

string

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

Request body

The request body contains data with the following structure:

JSON representation 
{
  "id": string,
  "reportTemplateId": string,
  "isEnabled": boolean,
  "environments": [
    string
  ],
  "recipentsEmail": [
    string
  ],
  "message": string,
  "timeOfDayHours": number,
  "intervalType": enum (ApiReportScheduleIntervalTypeEnum),
  "weeklyDays": [
    enum (ApiWeeklyDayEnum)
  ],
  "type": enum (ReportTypeEnum),
  "timeFilter": enum (DashboardTimeRangeTypesEnums),
  "dayOfTheMonth": integer
}
Fields
id

string (int64 format)

Output only. The ID of the report schedule.
reportTemplateId

string (int64 format)

Required. The ID of the report template.
isEnabled

boolean

Required. Whether the report schedule is enabled.
environments[]

string

Required. The environments for the report schedule.
recipentsEmail[]

string

Required. The email addresses of the recipients of the report.
message

string

Required. The message of the report.
timeOfDayHours

number

Required. The time of day in hours for the report schedule.
intervalType

enum (ApiReportScheduleIntervalTypeEnum)

Required. The interval type of the report schedule.
weeklyDays[]

enum (ApiWeeklyDayEnum)

Required. The days of the week for the report schedule.
type

enum (ReportTypeEnum)

Required. The type of the report.
timeFilter

enum (DashboardTimeRangeTypesEnums)

Required. The time filter for the dashboard.
dayOfTheMonth

integer

Optional. The day of the month for the report schedule.

Response body

Response message for legacySoarReports.legacyAddOrUpdateReportSchedule.

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

JSON representation 
{
  "id": string,
  "reportTemplateId": string,
  "environments": [
    string
  ],
  "recipentsEmail": [
    string
  ],
  "message": string,
  "timeOfDayHours": number,
  "intervalType": enum (ApiReportScheduleIntervalTypeEnum),
  "weeklyDays": [
    enum (ApiWeeklyDayEnum)
  ],
  "type": enum (ReportTypeEnum),
  "timeFilter": enum (DashboardTimeRangeTypesEnums),
  "isEnabled": boolean,
  "dayOfTheMonth": integer
}
Fields
id

string (int64 format)

Output only. The ID of the report schedule.
reportTemplateId

string (int64 format)

Required. The ID of the report template.
environments[]

string

Required. The environments for the report schedule.
recipentsEmail[]

string

Required. The email addresses of the recipients of the report.
message

string

The message of the report.
timeOfDayHours

number

Required. The time of day in hours for the report schedule.
intervalType

enum (ApiReportScheduleIntervalTypeEnum)

Required. The interval type of the report schedule.
weeklyDays[]

enum (ApiWeeklyDayEnum)

Required. The days of the week for the report schedule.
type

enum (ReportTypeEnum)

Required. The type of the report.
timeFilter

enum (DashboardTimeRangeTypesEnums)

Required. The time filter for the dashboard.
isEnabled

boolean

Required. Whether the report schedule is enabled.
dayOfTheMonth

integer

Optional. The day of the month for the report schedule.

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

For more information, see the IAM documentation.

ApiReportScheduleIntervalTypeEnum

ApiReportScheduleIntervalTypeEnum defines the interval type of the report schedule.

Enums
DAILY Daily interval type.
WEEKLY Weekly interval type.
MONTHLY Monthly interval type.

ApiWeeklyDayEnum

ApiWeeklyDayEnum defines the days of the week.

Enums
SUNDAY Sunday.
MONDAY Monday.
TUESDAY Tuesday.
WEDNESDAY Wednesday.
THURSDAY Thursday.
FRIDAY Friday.
SATURDAY Saturday.

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

DashboardTimeRangeTypesEnums defines the time range types for the dashboard.

Enums
DASHBOARD_TIME_RANGE_TYPES_ENUMS_UNSPECIFIED Unspecified time range type.
LAST_DAY Last day time range type.
LAST_3_DAYS Last 3 days time range type.
LAST_WEEK Last week time range type.
LAST_2_WEEKS Last 2 weeks time range type.
LAST_MONTH Last month time range type.
LAST_3_MONTHS Last 3 months time range type.
LAST_6_MONTHS Last 6 months time range type.
LAST_YEAR Last year time range type.

ApiReportScheduleIntervalTypeEnum

ApiReportScheduleIntervalTypeEnum defines the interval type of the report schedule.

Enums
DAILY Daily interval type.
WEEKLY Weekly interval type.
MONTHLY Monthly interval type.

ApiWeeklyDayEnum

ApiWeeklyDayEnum defines the days of the week.

Enums
SUNDAY Sunday.
MONDAY Monday.
TUESDAY Tuesday.
WEDNESDAY Wednesday.
THURSDAY Thursday.
FRIDAY Friday.
SATURDAY Saturday.

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

DashboardTimeRangeTypesEnums defines the time range types for the dashboard.

Enums
DASHBOARD_TIME_RANGE_TYPES_ENUMS_UNSPECIFIED Unspecified time range type.
LAST_DAY Last day time range type.
LAST_3_DAYS Last 3 days time range type.
LAST_WEEK Last week time range type.
LAST_2_WEEKS Last 2 weeks time range type.
LAST_MONTH Last month time range type.
LAST_3_MONTHS Last 3 months time range type.
LAST_6_MONTHS Last 6 months time range type.
LAST_YEAR Last year time range type.