Generate Mitigation Job Progress Report
Use this API to get the mitigation job progress report for the specified job id.
Input ParametersInput Parameters
|
Parameter |
Mandatory/ |
Data Type |
Description |
|---|---|---|---|
| deploymentJobId | Mandatory | String | Specify the job id. |
| assetIpv6Address | Optional | String | Specify the IPv6 address. |
| assetIp | Optional | String | Specify the IPv4 address. |
| actionStatus | Optional | String |
Specify the action status filter value. The values are Success, Failed, Skipped, Partial. If no value is specified, all columns are displayed in the report. |
| reportFormat | Mandatory | string | Specify the report format as PDF or CSV. Note: You can provide maximum 5 columns for PDF report. |
Sample - Generate MTG Job Progress ReportSample - Generate MTG Job Progress Report
API Request
curl -X 'POST' \
'<qualys_base_url>/pm/v1/report/mitigationjobprogress/3501bbe2-89da-45e9-a3eb-5d40692f7ccb' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '
API Body
'{
"name": "Mitigation Job Progress Report",
"description": "Mitigation Job Progress Report Description",
"query": "job.asset.status:Completed",
"reportFormat": "CSV",
"columnsToDisplay": {
"mitigationJobProgress": [
"assetId",
"assetName",
"jobStatus",
"operatingSystem",
"qid",
"actionStatus",
"returnCode",
"returnMessage",
"mitigationStatus",
"cveIds",
"mitigationTitle",
"mitigationType",
"impactFactor",
"mitigationReturnCode",
"mitigationReason",
"assetDeactivated",
"assetIpv6Address",
"assetIp"
]
},
"filters": {
"actionStatus": [
"success",
"failed",
"skipped",
"partial"
]
}
}
API Response
{
"reportId": "3a4611d8-70f3-4af1-866f-f8e1af98a060"
}