Update Risks
put
/risk
Send a request to this endpoint to update one or more risk. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.
Request
Header Parameters
-
Authorization(required):
OAuth token
Supported Media Types
- application/json
Root Schema : List<Risk>
Type:
array
Title:
Show Source
List<Risk>
-
Array of:
object Risk
Title:
Risk
Risk Entity
Nested Schema : Risk
Type:
object
Title:
Risk
Risk Entity
Show Source
-
Cause: string
The description of the cause of the Risk.
-
CostThresholdId: integer
(int32)
-
CreateDate: string
(date-time)
The date this risk was created.
-
CreateUser: string
The name of the user that created the risk.
-
Description: string
The description of the Risk.
-
Effect: string
The description of the risks effect on the project.
-
Exposure: number
(double)
The calculated exposure value for the risk.
-
ExposureFinishDate: string
(date-time)
The calculated date the exposure finishes for the risk.
-
ExposureStartDate: string
(date-time)
The calculated date the exposure starts for the risk.
-
Id(required): string
The ID of the Risk. Must be unique within a project.
-
IdentifiedByResourceId: string
The short code of the resource that identified the risk.
-
IdentifiedByResourceName: string
The name of the resource that identified the risk.
-
IdentifiedByResourceObjectId: integer
(int32)
The unique ID of the resource that identified the risk.
-
IdentifiedDate: string
(date-time)
The date this risk was identified.
-
ImpactThresholdValues: integer
(int32)
-
IsBaseline: boolean
The boolean value indicating if this business object is related to a Project or Baseline.
-
IsTemplate: boolean
The boolean value indicating if this business object is related to a template Project.
-
LastUpdateDate: string
(date-time)
The date this risk was last updated.
-
LastUpdateUser: string
The name of the user that last updated the risk.
-
Name: string
The name of the Risk. Does not need to be unique.
-
Note: string
The comments associated with the Risk.
-
ObjectId: integer
(int32)
The unique ID generated by the system.
-
ProbabilityThresholdId: integer
(int32)
-
ProjectId: string
The short name of the associated project.
-
ProjectName: string
The name of the associated project.
-
ProjectObjectId(required): integer
(int32)
The unique ID of the associated project.
-
ResourceId: string
The ID of the resource who owns the Risk. The owner of the Risk is responsible for resolving the Risk.
-
ResourceName: string
The name of the resource who owns the Risk. The owner of the Risk is responsible for resolving the Risk.
-
ResourceObjectId: integer
(int32)
The unique ID of the associated resource.
-
ResponseTotalCost: number
(double)
The total estimated cost for the risk. If the risk has an associated response plan, the cost is calculated from the risk response actions for the response plan. Not available if user does not have View Project Costs-Financial privilege.
-
RiskCategoryName: string
The name of the category to which the Risk is assigned. e.g. Weather, Health, Legal etc. A Risk can only be associated with a single category.
-
RiskCategoryObjectId: integer
(int32)
The unique ID of the category to which the Risk is assigned. e.g. Weather, Health, Legal etc. A Risk can only be associated with a single category.
-
ScheduleThresholdId: integer
(int32)
-
Score: integer
(int32)
The calculated score value of the impact values assigned to the risk.
-
ScoreColor: string
The color of the tolerance threshold for the score value.
-
ScoreText: string
The calculated score text value of the impact values assigned to the risk.
-
Status: string
The current status of the Risk. Valid values are 'Proposed', 'Open', 'Rejected', 'Managed', and 'Impacted'.
-
Type: string
The type of the risk. Valid values are 'Threat' and 'Opportunity'.
Response
Supported Media Types
- application/json
200 Response
OK.
Root Schema : schema
Type:
boolean
400 Response
Bad Request.
401 Response
Unauthorized.
403 Response
Forbidden.
404 Response
Not Found.
405 Response
Invalid Input.
500 Response
Internal Server Error.