Description: Get a report's details by using a specific report ID.
Since: 3.8
Security: Requires a user with the Manage Reports role.
Notes: For Xray version 3.21.2 and above with Projects, a Project Admin with Manage Security Assets privilege can get a report's details by using a specific report ID using this REST API in the scope of a project, by using the additional query parameter projectKey.
Usage: GET api/v1/reports/{id}
Sample Response
{
"id": 1234,
"name": "vul_report_1",
"status": "completed", //running, pending, complete, aborted, failed
"total_artifacts": 1000,
"num_of_processed_artifacts": 10,
"progress": 1,
"number_of_rows": 10,
"start_time": "1970-01-01T02:00:00+02:00",
"end_time_estimation": "1970-01-01T03:00:00+02:00",
"error": "error message in case of failure",
"Author": "user who initiated the report",
"report_type": "license | vulnerability | operational_risk"
}Get Reports Details by ID in Projects
GET api/v1/reports/7?projectKey=<project_key>
{
"id": 1234,
"name": "vul_report_1",
"status": "completed", //running, pending, complete, aborted, failed
"total_artifacts": 1000,
"num_of_processed_artifacts": 10,
"progress": 1,
"number_of_rows": 10,
"start_time": "1970-01-01T02:00:00+02:00",
"end_time_estimation": "1970-01-01T03:00:00+02:00",
"error": "error message in case of failure",
"Author": "user who initiated the report",
"report_type": "license | vulnerability | operational_risk",
"project_key": "myproj"
}