Get Deployment Job Result Summary

Use this API to get details of the deployment job results based on the provided deployment job ID.

GET/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 the job result summary for a jobSample - Get the job result summary for a job

API request

    
       curl -X GET 
       "https://gateway.qg2.apps.qualys.com/pm/v1/deploymentjob/b6fd7a02-1b08-40d0-8504-2bb6bcc36ff8/deploymentjobresult/summary?jobInstanceId=21" -H "accept: application/json" -H "Authorization: Bearer <<jwt token>>"

Response

    
      {
    "id": "b6fd7a02-1b08-40d0-8504-2bb6bcc36ff8",
    "name": "Job History 1",
    "assetCount": 1,
    "patchCount": 3,
    "createdBy": "gtham_bw",
    "createdOn": 1656048779381,
    "assets": [
        {
            "asset": {
                "id": "71f0a327-20b0-4e1f-a080-c2e469a5a4bd",
                "name": "Windows-Mock-33",
                "operatingSystem": "Windows Microsoft Windows 10 Pro 10.0.10586 Build 10586",
                "tags": [
                    {
                        "id": "781270dc-02ba-45c3-9336-78edf4802c1d",
                        "name": null
                    },
                    {
                        "id": "59e00be0-1feb-46d5-80d9-980d80d4f032",
                        "name": null
                    },
                    {
                        "id": "a3ec2f0b-0666-4a4d-b36b-7908890e0c7c",
                        "name": null
                    },
                    {
                        "id": "fff55ebb-3f53-498e-ad44-da878bfacdad",
                        "name": null
                    },
                    {
                        "id": "36cb1f58-94a5-4c87-a58a-eee92d683051",
                        "name": null
                    },
                    {
                        "id": "3efeacf2-3135-4230-b993-238acef55bca",
                        "name": null
                    }
                ],
                "lastLoggedOnUser": null,
                "successPatches": 0,
                "installedPatches": 0,
                "failedPatches": 0,
                "supersededPatches": 0,
                "notApplicablePatches": 0,
                "executing": null,
                "pendingExecution": null,
                "pendingReboot": null,
                "pendingVerification": null,
                "jobInstanceId": 21,
                "interfaces": [],
                "skipPatchCount": null,
                "additionalFields": null
            },
            "endDateTime": 0,
            "startDateTime": 0,
            "statusDateTime": 1657778400267,
            "status": "Not Licensed",
            "statusCode": "20392",
            "jobSentOn": 0,
            "installed": null,
            "failed": null,
            "success": null,
            "superseded": null,
            "notApplicable": null,
            "agentCheckedInTime": 1612414981000,
            "failedActionsCount": null,
            "successfulActionsCount": null,
            "interimResultStatus": null,
            "jobInstanceId": 21,
            "totalPatchCount": 0
        },
    ]
}