Documentation Index

Fetch the complete documentation index at: https://docs.grassfish.com/llms.txt

Use this file to discover all available pages before exploring further.

Get the report data as an Excel spreadsheet

Prev Next
Post
/v{version}/GenericReports/{id}/Download

Content of the report is translated to the specified language. See generic report definition from GET v/GenericReports for required key(s) for the request parameters.

Security
API Key: api_key
Header parameter nameX-ApiKey

Api Key

API Key: session_id
Header parameter nameX-Session-Id

Session Id

Path parameters
id
stringRequired

Unique ID of the report

version
stringRequired

The requested API version

Default"1.20"
Query parameters
language
string

Language of the returned reports (default: en)

Body parameters

Request parameters as key-value pairs

Expand All
object
property*
object additionalProperties
Responses
200

OK

file
file
400

Bad request

Expand All
object
ValidationErrors
object
property*
Array of string additionalProperties
string
Expand All
object
ValidationErrors
object
property*
Array of string additionalProperties
string
403

Access denied

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties
Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties
404

Report file not found

500

Unexpected error

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties
Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties