report_jobs
Creates, updates, deletes, gets or lists a report_jobs resource.
Overview
| Name | report_jobs |
| Type | Resource |
| Id | sumologic.dashboards.report_jobs |
Fields
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
generateDashboardReport | exec | region, action, exportFormat, template, timezone | Schedule an asynchronous job to generate a report from a template. All items in the template will be included unless specified. See template section for more details on individual templates. Reports can be generated in Pdf or Png format and exported in various methods (ex. direct download). You will get back an asynchronous job identifier on success. Use the [getAsyncReportGenerationStatus] endpoint and the job identifier you got back in the response to track the status of an asynchronous report generation job. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | SumoLogic region (enum: [us2, au, ca, de, eu, fed, in, jp], default: us2) |
Lifecycle Methods
- generateDashboardReport
Schedule an asynchronous job to generate a report from a template. All items in the template will be included unless specified. See template section for more details on individual templates. Reports can be generated in Pdf or Png format and exported in various methods (ex. direct download). You will get back an asynchronous job identifier on success. Use the [getAsyncReportGenerationStatus] endpoint and the job identifier you got back in the response to track the status of an asynchronous report generation job.
EXEC sumologic.dashboards.report_jobs.generateDashboardReport
@region='{{ region }}' --required
@@json=
'{
"action": "{{ action }}",
"exportFormat": "{{ exportFormat }}",
"timezone": "{{ timezone }}",
"template": "{{ template }}"
}'
;