See all operations
POST: project-templates/{project_template_id}/risks/probabilities
Description
Adds a new risk probability 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/v6_0/RestService.svc/project-templates/{project_template_id}/risks/probabilities
Request Parameters
|
Name
|
Description
|
|
project_template_id
|
The id of the project template
|
Request Body
|
Property
|
Description
|
|
RiskProbabilityId
|
The id of the risk probability (integer)
|
|
Name
|
The name of the risk probability (string)
|
|
Active
|
Whether the probability is active or not (boolean)
|
|
Position
|
The display position of this probability
|
|
Color
|
The hex color code associated with the probability (string)
|
|
Score
|
The score value
|
<RemoteRiskProbability xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v6_0.DataObjects">
<Active>false</Active>
<Color i:nil="true" />
<Name i:nil="true" />
<Position>0</Position>
<RiskProbabilityId i:nil="true" />
<Score>0</Score>
</RemoteRiskProbability>
{"RiskProbabilityId":null,
"Name":null,
"Active":false,
"Position":0,
"Color":null,
"Score":0}
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
|
|
RiskProbabilityId
|
The id of the risk probability (integer)
|
|
Name
|
The name of the risk probability (string)
|
|
Active
|
Whether the probability is active or not (boolean)
|
|
Position
|
The display position of this probability
|
|
Color
|
The hex color code associated with the probability (string)
|
|
Score
|
The score value
|
<RemoteRiskProbability xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v6_0.DataObjects">
<Active>false</Active>
<Color i:nil="true" />
<Name i:nil="true" />
<Position>0</Position>
<RiskProbabilityId i:nil="true" />
<Score>0</Score>
</RemoteRiskProbability>
{"RiskProbabilityId":null,
"Name":null,
"Active":false,
"Position":0,
"Color":null,
"Score":0}