SpiraPlan: REST Web Service (v6.0)

See all operations

GET: projects/{project_id}/reports/generated/{generated_report_id}

Description

Retrieves the contents of the generated report (step 4 in getting the output of a report)

This returns the report contents in binary form. This API call is currently limited to system administrators because of the potential performance impact of running large reports

How to Execute

To access this REST web service, you need to use the following URL (make sure to replace any parameters (eg {project_id}) with the relevant value (eg 1):

http://api.inflectra.com/Spira/Services/v6_0/RestService.svc/projects/{project_id}/reports/generated/{generated_report_id}

Request Parameters

Name Description
project_id The id of the project
generated_report_id The id of the generated report - obtained from the API call to check on the status of a generated report

Request Body

Return Data

The JSON and XML examples below show the shape of one entry that will be returned. It does not show an example of how that entry will be populated.

Property Description