Using the new Spira Reports API

This is a brand new API method that was added in v6.2.1.1, and it lets you view a list of saved reports, generate a saved report asynchronously, and finally download that report in whichever format was selected (Acrobat, Word, Excel, HTML, or XML).

Here is the recommended order of using the API:

1. Saved Report API

• GET: projects/{project_id}/reports/saved?include_shared={include_shared}
  • Returns a list of saved reports for the current
• POST: projects/{project_id}/reports/saved/{saved_report_id}/generate (to generate the saved report)
  • Returns an alphanumeric GUID to use with the next function
  • It executes asynchronously in the background so you need to use the next two functions to get the report itself

2. Generated Report API

• GET: projects/{project_id}/reports/generated?report_generation_id={report_generation_id} to check the status of the report
  • When it returns an integer > 0 this is the ID of the generated report
  • This needs to be called every couple of minutes to check on the status and report progress
• GET: projects/{project_id}/reports/generated/{generated_report_id} to get the generated report

Note: You need to be connecting to the API as a System Administrator to use this API.