SpiraPlan: REST Web Service (v6.0)

See all operations

GET: projects/{project_id}/reports/generated?report_generation_id={report_generation_id}

Description

Checks on the status of the generation of a specific user's saved report (step 3 in getting the output of a report)

Returns: -1 if the report was not found, 0 if the generation is in progress, an int with the ID of the completed report. 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?report_generation_id={report_generation_id}

Request Parameters

Name Description
project_id The id of the project
report_generation_id The guid of the report generation request - in other words from the POST call to generate a specific saved 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
MaxValue
MinValue