Method: cases.generateReport

Full name: projects.locations.instances.cases.generateReport

Generate case report.

HTTP request


Path parameters

Parameters
name

string

Required. The resource name of the Case to generate Report for. Format: projects/{project}/locations/{location}/instances/{instance}/cases/{case}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "caseId": integer,
  "reportKind": enum (ReportType)
}
Fields
caseId

integer

Required. Case id to generate report for.
reportKind

enum (ReportType)

Required. Report kind.

Response body

Response message for cases.generateReport.

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

JSON representation 
{
  "fileContents": string,
  "contentType": string
}
Fields
fileContents

string (bytes format)

Output only. The content of the report.

A base64-encoded string.
contentType

string

Output only. The content type of the report.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

ReportType

Report type.

Enums
REPORT_TYPE_UNSPECIFIED Unspecified report type.
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.