Get Deployment Job Progress Report

Use this API to generate deployment job progress report for the specified job ID.

GET/pm/v1/report/jobprogress/{deploymentJobId}

Input ParametersInput Parameters

Parameter

Mandatory/Optional

Data Type

Description

deploymentJobId

Mandatory

string

Deployment job ID for which you want to fetch details.

filter

Optional

string

Specify the QQL to filter the job based on search criteria.

For example, status: Completed

sort

Optional

string

Sort the jobs by certain data.

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

jobInstanceId

Optional

string

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

If you don't specify the job instance ID, the job progress report will be generated for the latest job run.

includeActionReport

-

Boolean

Specify whether you want to include deployment actions result in the report.

Default value: false

Sample - Get the job progress report for a job IDSample - Get the job progress report for a job ID

API request

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

Response

    
        {
    "reportId": "88f44569-38f1-441a-becc-7749b4c88d9a"
}