SpiraPlan: REST Web Service (v6.0)

See all operations

PUT: projects/{project_id}/risks


Updates a risk in the system

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


Request Parameters

Name Description
project_id The id of the current project

Request Body

Property Description
RiskId The id of the risk
ClosedDate The date the risk was closed (optional) (in UTC)
ComponentId The id of the component the risk is associated with (optional)
CreationDate The date the risk was created (in UTC)
CreatorId The id of the user that created the risk
Description The description of the risk
IsDeleted Is the risk deleted
LastUpdateDate The date/time the risk was last updated (in UTC)
Name The name of the risk
OwnerId The id of the user that the risk is assigned to currently (optional)
ReleaseId The id of the release that the risk is currently assigned to (optional)
ReviewDate The date/time the risk needs to be reviewed (in UTC)
RiskImpactId The id of the risk impact (optional)
RiskProbabilityId The id of the risk probability (optional)
RiskStatusId The id of the risk status (default if not populated)
RiskTypeId The id of the risk type (default if not populated)
ProjectGroupId The id of the project group (not used)
RiskDetectabilityId The id of the risk detectability (not used)
GoalId The id of the project goal (not used)
ProjectId The id of the project that the artifact belongs to
ConcurrencyDate The datetime used to track optimistic concurrency to prevent edit conflicts
CustomProperties The list of associated custom properties/fields for this artifact
Tags The list of meta-tags that should be associated with the artifact

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.