SpiraPlan: REST Web Service (v7.0)

See all operations

POST: project-templates/{project_template_id}/risks/impacts

Description

Adds a new risk impact to the project template

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/project-templates/{project_template_id}/risks/impacts

Request Parameters

Name Description
project_template_id The id of the project template

Request Body

Property Description
RiskImpactId The id of the risk impact (integer)
Name The name of the risk impact (string)
Active Whether the impact is active or not (boolean)
Position The display position of this impact
Color The hex color code associated with the impact (string)
Score The score value
Guid The unique identifier for the artifact
ConcurrencyGuid GUID for representing the concurrency state of a given artifact
LastUpdateDate Last time the artifact was updated

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
RiskImpactId The id of the risk impact (integer)
Name The name of the risk impact (string)
Active Whether the impact is active or not (boolean)
Position The display position of this impact
Color The hex color code associated with the impact (string)
Score The score value
Guid The unique identifier for the artifact
ConcurrencyGuid GUID for representing the concurrency state of a given artifact
LastUpdateDate Last time the artifact was updated