SpiraPlan: REST Web Service (v7.0)

See all operations

POST: projects/{project_id}/refresh-caches?run_async={run_async}

Description

Refreshes the task progress and test execution status for a project. Typically this needs to be called after TestRun_RecordAutomated3(...) API calls to ensure the data in the system is consistent

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):

https://api.inflectra.com/Spira/Services/v7_0/RestService.svc/projects/{project_id}/refresh-caches?run_async={run_async}

Request Parameters

Name Description
project_id The id of the project being refreshed
run_async Do we want to run this in the background. If it runs in the background it will return immediately and continue processing on the server/ Otherwise the caller will have to wait until it finishes. Choosing True is better if you have a large project that will take longer to refresh that the web service timeout, but False is better if your subsequent code relies on the data being refreshed

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.