See all operations
POST: projects/{project_id}/risks/{risk_id}/mitigations?existing_risk_mitigation_id={existing_risk_mitigation_id}&creator_id={creator_id}
Description
Adds a risk mitigation to a risk
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/projects/{project_id}/risks/{risk_id}/mitigations?existing_risk_mitigation_id={existing_risk_mitigation_id}&creator_id={creator_id}
Request Parameters
|
Name
|
Description
|
|
project_id
|
The id of the project
|
|
risk_id
|
The id of the risk
|
|
existing_risk_mitigation_id
|
The id of the existing mitigation to insert before (null = end of the list)
|
|
creator_id
|
The id of the user adding the mitigation (null = use authenticated user)
|
Request Body
|
Property
|
Description
|
|
RiskMitigationId
|
The id of the mitigation
|
|
RiskId
|
The id of the risk the mitigation belongs to
|
|
Position
|
The position of the step in the requirement
|
|
Description
|
The description of this step
|
|
LastUpdateDate
|
The date the step was last updated
|
|
ConcurrencyDate
|
The date the step was edited
|
|
CreationDate
|
The date the step was created
|
|
IsDeleted
|
Is this mitigation deleted?
|
|
IsActive
|
Is this mitigation active?
|
|
ReviewDate
|
The scheduled review date (optional)
|
<RemoteRiskMitigation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v6_0.DataObjects">
<ConcurrencyDate>0001-01-01T00:00:00</ConcurrencyDate>
<CreationDate>0001-01-01T00:00:00</CreationDate>
<Description i:nil="true" />
<IsActive>false</IsActive>
<IsDeleted>false</IsDeleted>
<LastUpdateDate>0001-01-01T00:00:00</LastUpdateDate>
<Position>0</Position>
<ReviewDate i:nil="true" />
<RiskId>0</RiskId>
<RiskMitigationId i:nil="true" />
</RemoteRiskMitigation>
{"RiskMitigationId":null,
"RiskId":0,
"Position":0,
"Description":null,
"LastUpdateDate":"0001-01-01T00:00:00",
"ConcurrencyDate":"0001-01-01T00:00:00",
"CreationDate":"0001-01-01T00:00:00",
"IsDeleted":false,
"IsActive":false,
"ReviewDate":null}
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
|
|
RiskMitigationId
|
The id of the mitigation
|
|
RiskId
|
The id of the risk the mitigation belongs to
|
|
Position
|
The position of the step in the requirement
|
|
Description
|
The description of this step
|
|
LastUpdateDate
|
The date the step was last updated
|
|
ConcurrencyDate
|
The date the step was edited
|
|
CreationDate
|
The date the step was created
|
|
IsDeleted
|
Is this mitigation deleted?
|
|
IsActive
|
Is this mitigation active?
|
|
ReviewDate
|
The scheduled review date (optional)
|
<RemoteRiskMitigation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v6_0.DataObjects">
<ConcurrencyDate>0001-01-01T00:00:00</ConcurrencyDate>
<CreationDate>0001-01-01T00:00:00</CreationDate>
<Description i:nil="true" />
<IsActive>false</IsActive>
<IsDeleted>false</IsDeleted>
<LastUpdateDate>0001-01-01T00:00:00</LastUpdateDate>
<Position>0</Position>
<ReviewDate i:nil="true" />
<RiskId>0</RiskId>
<RiskMitigationId i:nil="true" />
</RemoteRiskMitigation>
{"RiskMitigationId":null,
"RiskId":0,
"Position":0,
"Description":null,
"LastUpdateDate":"0001-01-01T00:00:00",
"ConcurrencyDate":"0001-01-01T00:00:00",
"CreationDate":"0001-01-01T00:00:00",
"IsDeleted":false,
"IsActive":false,
"ReviewDate":null}