Create Report
Create customized reports by specifying parameters like SaaS type and policy name.
Input ParametersInput Parameters
|
Parameter |
Required/ |
Data Type |
Description |
|---|---|---|---|
| reportName | Required | String | Specify the name of the report you want to generate. |
|
description |
Optional |
String / Null |
Specify a description that helps you identify the purpose of the report. |
|
fileFormat |
Required |
String |
Specify the output format for the report (`csv` or `pdf`). |
|
saasApplicationType |
Required |
String |
Specify the identifier for the SaaS application (for example, 'OFFICE365'). |
|
saasApplicationName |
Required |
String |
Specify the name of the SaaS application. |
|
connectorId |
Required |
Integer |
Specify the connector ID associated with your SaaS account. |
|
connectorName |
Required |
String |
Specify the connector name that corresponds to the ID. |
|
policyId |
Required |
Integer |
Specify the policy ID you want the report to use. |
|
policyName |
Required |
String |
Specify the policy name applied during report generation. |
|
result |
Required |
Array of Strings |
Specify which result types you want to include (`Pass`, `Fail`, `Error`). |
|
fileFormat |
Required |
String |
Specify the file format in which you want to download the report. (`csv` or `pdf`). |
|
templateName |
Required |
String |
Specify the template name to be used for the report. |
|
templateId |
Required |
Integer |
Specify the template ID of the template. |
Sample - Create Customized ReportSample - Create Customized Report
API Request
curl --location '<qualys_base_url>/sdr/api/v1/reporting/create/'
Request Body
{
'reportName': <report-name>,
'description': <report-description>,
'fileFormat': 'csv/pdf',
'config': {
'saasApplication': {
'key': 'OFFICE365' <saas type>,
'value': 'Office 365' <saas value>
},
'connectors': [
{
'key': <connector-id>,
'value': '<connector-name>'
}
],
'policy': {
'key': <policy-id>,
'value': '<policy-name>'
},
'result': [<any-combination>
'Pass',
'Fail',
'Error'
],
'fileFormat': 'csv/pdf',
'template': {<compulsory-values>
'key': 'SDR_Assessment_Template',
'value': 'SaaS Assessment Template'
}
}
}Response
{
"data": {
"fileUuid": "2eeaxxxx-b4xx-11xx-a4xx-33xxe5xx3dxx"
},
"message": "Request successfully created.",
"count": null
}