Get Deployment Job Result Summary

Use this API to get the deployment job results for the job wherein you manually include 50 to 100 assets.

POST/pm/v1/deploymentjob/{deploymentJobId}/deploymentjobresult/summary

Input ParametersInput Parameters

Parameter

Mandatory/Optional

Data Type

Description

deploymentJobId

Mandatory

string

Specify the deployment job ID for which you want to fetch the results.

filter

Optional

string

 

Specify the QQL to filter jobs based on deployment jobs search criteria. For example, tags.name:"cloud agent".

pageNumber

Optional

string

The page to be returned.

Default value: 0

pageSize

 

Optional

string

 

Limit number of rows to be returned per page.

Default value: 10

sort

 

Optional

string

Sort the jobs by certain data.

For example, [{"status":"asc"}]

jobinstanceId

 

Optional

string

Specify the job instance ID to get the deployment job results for a particular run of the deployment job.

If you don't specify the job instance ID, the deployment job results for the latest job run are returned.

Sample - Get Deployment Job Result SummarySample - Get Deployment Job Result Summary

API request

curl -X 'POST' \  
'<qualys_base_url>/pm/v1/deploymentjob/ccxxxx31-3xx8-47xx-b46c-8926c29xxxxx/deploymentjobresult/summary' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <<jwt token>>' \
-H 'Content-Type: application/json' \
-d '{ "query": "(agentId:[af29xx01-6bc8-4xx4-9dxx-7xxxx9a5e1c])" }'

Request Body - Specify the agentId and job status to get the deployment job result summary

{
  "query": "(agentId:[af29xx01-6bc8-4xx4-9dxx-7xxxx9a5e1c]) and status: Completed"
}

Response

 {
  "id": "ccxxxx31-3xx8-47xx-b46c-8926c29xxxxx",
  "name": "test_job_777",
  "assetCount": 1,
  "patchCount": 1,
  "createdBy": "patch_mm",
  "createdOn": 1692617396972,
  "assets": [
    {
      "asset": {
      "id": "af29xx01-6bc8-4xx4-9dxx-7xxxx9a5e1c",
      "name": "AVWin11",
      "operatingSystem": "Microsoft Windows 11 Pro 10.0.22000 N/A Build 22000",
      "tags": [
      { "id": "fxxxx263-1b49-4xxx-939f-c2e6xxxx6374", "name": null }
    ,
    { "id": "xxxxxcd1-xxxe-43xx-bb1f-4xxxxx296f8d", "name": null }
    ],
    "lastLoggedOnUser": ".
    Akanksha",
    "successPatches": 0,
    "installedPatches": 0,
    "failedPatches": 0,
    "supersededPatches": 0,
    "notApplicablePatches": 0,
    "executing": null,
    "pendingExecution": null,
    "pendingReboot": null,
    "pendingVerification": null,
    "jobInstanceId": 1,
    "interfaces": [],
    "skipPatchCount": null,
    "additionalFields": null
   },
   "endDateTime": 0,
   "startDateTime": 0,
   "statusDateTime": 1692675367118,
   "status": "Not Licensed",
   "statusCode": "20392",
   "jobSentOn": 0,
   "installed": null,
   "failed": null,
   "success": null,
   "superseded": null,
   "notApplicable": null,
   "failedActionsCount": null,
   "successfulActionsCount": null,
   "interimResultStatus": null,
   "jobInstanceId": 1,
   "totalPatchCount": 0,
   "runId": 0,
   "scanDateTime": null,
   "pendingForRebootInAnotherJob": false,
   "pendingForRebootInAnotherJobName": null
      }
   ]
}