SpiraPlan: REST Web Service (v6.0)

See all operations

POST: projects/{project_id}/reports/saved/{saved_report_id}/generate

Description

Starts the generation of a specific user's saved report (step 2 in getting the output of a report)

This call returns the GUID of the report generation id (used to check status and retrieve it). 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/saved/{saved_report_id}/generate

Request Parameters

Name Description
project_id The id of the project
saved_report_id The id of the saved report - use the GET reports/saved API call to find this

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
Empty