Batch Update Project Risks
put
/api/restapi/projectRisk/batch
Send a request to this endpoint to update one or more project risks.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : List<ApiEntityProjectRiskInput>
Type:
array
Title:
Show Source
List<ApiEntityProjectRiskInput>
-
Array of:
object ApiEntityProjectRiskInput
Title:
ApiEntityProjectRiskInput
This entity represents a ProjectRisk object, a unique ProjectRisk object can be identified by the following combinations of the fields.- projectRiskId
- riskCode,projectId
- riskCode,projectCode,workspaceCode
Nested Schema : ApiEntityProjectRiskInput
Type:
object
Title:
ApiEntityProjectRiskInput
This entity represents a ProjectRisk object, a unique ProjectRisk object can be identified by the following combinations of the fields.
Show Source
- projectRiskId
- riskCode,projectId
- riskCode,projectCode,workspaceCode
-
actualScheduleImpact: number
(double)
The actual schedule impact due to the risk occurring.
-
addressLine1: string
Minimum Length:
0
Maximum Length:200
The first line of the address of a location.
This might be the building number and street address. -
addressLine2: string
Minimum Length:
0
Maximum Length:200
The second line of the address of a location.
This might be a neighborhood or town. -
cause: string
Minimum Length:
0
Maximum Length:4000
A description of the cause of the risk. -
cbsCodes: array
cbsCodes
List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.
-
cbsSheetCodeId: integer
(int64)
The cost breakdown structure code assigned to the risk.
-
city: string
Minimum Length:
0
Maximum Length:200
The city name for a location. -
codeValuesRisk: array
codeValuesRisk
The list of code values for a project risk. This entity can only be used to assign codeValues or create codeValues on the fly.
-
configuredFields: array
configuredFields
The list of configured fields for a project risk.
-
costCategoryId: integer
(int64)
The category name used to organize and define the cost.
-
costImpactQuantified: boolean
When selected, the quantified cost distribution is used to determine the cost impact for each iteration.
-
country: string
Minimum Length:
0
Maximum Length:3
The country for a location. -
description: string
Minimum Length:
0
Maximum Length:4000
A detailed summary of the risk. -
effect: string
Minimum Length:
0
Maximum Length:4000
The resulting effect of the presence of the risk. -
excludeFromRiskRemovalAnalysis: boolean
Default Value:
false
Determines whether the impact of removing the risk is calculated during risk removal risk analysis. -
hasPostResponseData: boolean
Determines whether this risk has post-response values.
-
identifiedById: integer
(int64)
The user who added the risk to the project.
-
identifiedDate: string
(date-time)
The date the risk was added to the project.
-
impactedDate: string
(date-time)
The date the risk impacted the project.
-
impacts: array
impacts
The impact of the risk.
-
latitude: number
(double)
Minimum Value:
-90
Maximum Value:90
The geographical coordinate for the latitude of the location.
The default format for latitude is decimal degrees format, but the format you need to use will depend on your geolocation service. -
locationName: string
Minimum Length:
0
Maximum Length:255
A name for the location that your users will understand and recognize. -
longitude: number
(double)
Minimum Value:
-180
Maximum Value:180
The geographical coordinate for the longitude of the location.
The default format for longitude is decimal degrees format, but the format you need to use will depend on your geolocation service. -
ownerId: integer
(int64)
The name of the user who is assigned to manage the risk.
-
postalCode: string
Minimum Length:
0
Maximum Length:20
The postal code, post code, or zip code of a location. -
probabilityImpactQuantified: boolean
When selected, the quantified probability distribution is used to determine the probability that the risk occurs for each iteration.
-
projectCode: string
Minimum Length:
1
Maximum Length:60
The unique identifier for a project set by the user who created the project. -
projectId(required): integer
(int64)
The unique identifier for the project to which the risk was added.
-
projectRiskFinancial:
projectRiskFinancial
The financial fields associated with a project risk.
-
projectRiskId: integer
(int64)
The system-generated identifier of the project risk.
-
projectRiskStatus: string
Allowed Values:
[ "PROPOSED", "OPEN", "MONITORING", "IMPACTING", "REJECTED", "CANNOT_IMPACT", "IMPACTED" ]
The status of the risk.
Proposed: The risk is identified and awaits approval.
Open: The risk is approved as a valid risk and is awaiting management.
Monitoring: The risk has been managed and is being monitored.
Impacting: The risk is currently impacting the project.
Cannot Impact: The risk did not happen and can no longer happen.
Impacted: The risk occurred.
Rejected: The risk is not seen as a valid risk to the project and therefore will not be tracked and managed by the project. -
riskCode: string
Minimum Length:
1
Maximum Length:60
The unique identifier for the risk. -
riskFactorCostImpactOption: string
Default Value:
ALL_COSTS
Allowed Values:[ "ALL_COSTS", "MATERIAL_COSTS_ONLY", "LABOR_COSTS_ONLY", "NONLABOR_COSTS_ONLY", "LABOR_AND_NONLABOR_COSTS_ONLY" ]
The cost type the risk factor impacts. -
riskName(required): string
Minimum Length:
0
Maximum Length:255
The name of the risk. -
riskQuantifiedCostImpact:
riskQuantifiedCostImpact
The impact this risk will have on cost data.
-
riskQuantifiedOtherImpacts: array
riskQuantifiedOtherImpacts
The impact this risk will have on other data.
-
riskType: string
Allowed Values:
[ "THREAT", "OPPORTUNITY", "WEATHER", "RISK_FACTOR" ]
The type of risk. Valid values are Threat, Opportunity, Weather and Risk Factor. -
scheduleImpactQuantified: boolean
When selected, the quantified schedule impact distribution is used to calculate the schedule impact size for each iteration.
-
state: string
Minimum Length:
0
Maximum Length:200
The state, region, or province of a location. -
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace. -
workspaceId: integer
(int64)
The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.
Nested Schema : cbsCodes
Type:
array
List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.
Show Source
Nested Schema : codeValuesRisk
Type:
array
The list of code values for a project risk. This entity can only be used to assign codeValues or create codeValues on the fly.
Show Source
-
Array of:
object ApiEntityCodeValueRiskInput
Title:
ApiEntityCodeValueRiskInput
This entity represents a CodeValueRisk object, a unique CodeValueRisk object can be identified by the following combinations of the fields.- codeValueRiskId
- codeValueId
- codeTypeId,codeValueCode
- codeTypeCode,codeValueCode
- codeTypeCode,parentId,codeValueCode
- codeValueCode,codeTypeId,parentId
- codeTypeCode,codeValueCode,projectCode
- codeTypeCode,codeValueCode,projectId
- codeTypeCode,codeValueCode,parentId,projectCode
- codeTypeCode,codeValueCode,parentId,projectId
Nested Schema : configuredFields
Type:
array
The list of configured fields for a project risk.
Show Source
-
Array of:
object ApiEntityProjectRiskConfiguredFieldValueInput
Title:
ApiEntityProjectRiskConfiguredFieldValueInput
This entity represents a ProjectRiskConfiguredFieldValue object, a unique ProjectRiskConfiguredFieldValue object can be identified by the following combinations of the fields.- projectRiskConfiguredFieldValueId
- columnDefinitionId
- columnName
- columnLabel
Nested Schema : impacts
Type:
array
The impact of the risk.
Show Source
-
Array of:
object ApiEntityRiskImpactInput
Title:
ApiEntityRiskImpactInput
Nested Schema : projectRiskFinancial
The financial fields associated with a project risk.
Match All
The financial fields associated with a project risk.
Show Source
-
object
ApiEntityProjectRiskFinancialInput
Title:
ApiEntityProjectRiskFinancialInput
Nested Schema : riskQuantifiedCostImpact
The impact this risk will have on cost data.
Match All
The impact this risk will have on cost data.
Show Source
-
object
ApiEntityRiskQuantifiedCostImpactInput
Title:
ApiEntityRiskQuantifiedCostImpactInput
Nested Schema : riskQuantifiedOtherImpacts
Type:
array
The impact this risk will have on other data.
Show Source
-
Array of:
object ApiEntityRiskQuantifiedOtherImpactInput
Title:
ApiEntityRiskQuantifiedOtherImpactInput
Nested Schema : ApiEntityCodeValueRiskInput
Type:
object
Title:
ApiEntityCodeValueRiskInput
This entity represents a CodeValueRisk object, a unique CodeValueRisk object can be identified by the following combinations of the fields.
Show Source
- codeValueRiskId
- codeValueId
- codeTypeId,codeValueCode
- codeTypeCode,codeValueCode
- codeTypeCode,parentId,codeValueCode
- codeValueCode,codeTypeId,parentId
- codeTypeCode,codeValueCode,projectCode
- codeTypeCode,codeValueCode,projectId
- codeTypeCode,codeValueCode,parentId,projectCode
- codeTypeCode,codeValueCode,parentId,projectId
-
action: string
Allowed Values:
[ "DELETE" ]
Provide a value for this field during object update to delete code value assigned to the object. -
codeTypeCode: string
Minimum Length:
0
Maximum Length:60
This field displays the name of a code or value. -
codeTypeId(required): integer
(int64)
The unique identifier for the code type.The code type object can also be identified by its unique criteria.
-
codeValueCode(required): string
Minimum Length:
1
Maximum Length:60
The unique identifier for the code value. -
codeValueId: integer
(int64)
The unique identifier for the code value.
-
codeValueName: string
Minimum Length:
1
Maximum Length:255
The name of the code value. -
codeValueRiskId: integer
(int64)
The unique identifier of a risk code value.
-
parentId: integer
(int64)
The unique identifier of a parent code value.
-
projectCode: string
Minimum Length:
1
Maximum Length:60
The code of a Project of a Project CodeType. -
projectId: integer
(int64)
The unique identifier for the project.The project object can also be identified by its unique criteria.
-
projectRiskId: integer
(int64)
The unique identifier of a project.
Nested Schema : ApiEntityProjectRiskConfiguredFieldValueInput
Type:
object
Title:
ApiEntityProjectRiskConfiguredFieldValueInput
This entity represents a ProjectRiskConfiguredFieldValue object, a unique ProjectRiskConfiguredFieldValue object can be identified by the following combinations of the fields.
Show Source
- projectRiskConfiguredFieldValueId
- columnDefinitionId
- columnName
- columnLabel
-
action: string
Allowed Values:
[ "DELETE" ]
Provide value for this field during object update to delete the assigned configured field value. -
columnDefinitionId: integer
(int64)
Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
-
columnLabel: string
Minimum Length:
1
Maximum Length:100
The user-specified UDF column label. -
columnName: string
Minimum Length:
1
Maximum Length:100
The user-specified UDF column name. -
dateValue: string
(date-time)
This holds values for Date type configured fields.
-
numberValue: number
This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.
-
projectRiskConfiguredFieldValueId: integer
(int64)
The unique identifier for the Risk Configured Field.
-
projectRiskId: integer
(int64)
The system-generated identifier of a Risk.
-
textValue: string
Maximum Length:
4000
This holds values for Boolean, List and Text type configured fields.
Nested Schema : ApiEntityRiskImpactInput
Type:
object
Title:
Show Source
ApiEntityRiskImpactInput
-
postRiskScoreThresholdCode: string
Minimum Length:
0
Maximum Length:60
The unique identifier for the risk scoring threshold. -
postRiskScoreThresholdId: integer
(int64)
The system-generated unique identifier for the post-response impact threshold.
-
projectRiskId(required): integer
(int64)
The system-generated unique identifier of the project risk.
-
riskImpactId: integer
(int64)
A database generated unique value for the object that links the RSK_PROJECT to the selected threshold. It also includes the score type.
-
riskScoreThresholdCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of the risk score threshold of a risk impact. -
riskScoreThresholdId(required): integer
(int64)
The system-generated unique identifier for the pre-response impact threshold.
-
riskScoreTypeId(required): integer
(int64)
The system-generated unique identifier of the risk score type.
-
riskScoreTypeName: string
Minimum Length:
0
Maximum Length:255
The risk score type name of a risk impact.
Nested Schema : ApiEntityProjectRiskFinancialInput
Type:
object
Title:
Show Source
ApiEntityProjectRiskFinancialInput
-
actualCostImpact: number
(double)
Minimum Value:
0
The actual cost impact due to the risk occurring. -
contingency: number
(double)
Minimum Value:
0
The allowable risk cost should the risk occur. -
projectRiskId(required): integer
(int64)
The unique identifier of a project risk.
Nested Schema : ApiEntityRiskQuantifiedCostImpactInput
Type:
object
Title:
Show Source
ApiEntityRiskQuantifiedCostImpactInput
-
postResponseDistributionShape: string
Allowed Values:
[ "SINGLE_POINT", "TRIANGLE", "UNIFORM", "BETAPERT" ]
Determines the distribution that best models the three-point estimates for the cost impact after a response. -
postResponseMaximum: number
(double)
The maximum cost of responding to a risk event. This field is in base currency and is calculated from postResponseMaximumProject field based on the specified exchange rate.
-
postResponseMinimum: number
(double)
The minimum cost of responding to a risk event that has occurred. This field is in base currency and is calculated from postResponseMinimumProject field based on the specified exchange rate.
-
postResponseMostLikely: number
(double)
The most likely cost of a risk event that has occurred. This field is in base currency and is calculated from postResponseMostLikelyProject field based on the specified exchange rate.
-
preResponseDistributionShape(required): string
Allowed Values:
[ "SINGLE_POINT", "TRIANGLE", "UNIFORM", "BETAPERT" ]
Determines the distribution that best models the three-point estimates for the cost impact before a response. -
preResponseMaximum: number
(double)
The maximum cost of preparing for a risk event that has not occurred. This field is in base currency and is calculated from preResponseMaximumProject field based on the specified exchange rate.
-
preResponseMinimum: number
(double)
The minimum cost of preparing for a risk event that has not occurred. This field is in base currency and is calculated from preResponseMinimumProject field based on the specified exchange rate.
-
preResponseMostLikely: number
(double)
The most likely cost of preparing for a risk event that has not occurred. This field is in base currency and is calculated from preResponseMostLikelyProject field based on the specified exchange rate.
-
projectRiskId(required): integer
(int64)
The unique identifier of a project.
-
quantifiedCostImpactId: integer
(int64)
The unique identifier of a cost impact.
Nested Schema : ApiEntityRiskQuantifiedOtherImpactInput
Type:
object
Title:
Show Source
ApiEntityRiskQuantifiedOtherImpactInput
-
maximum: number
(double)
The maximum probability that a risk event will occur.
-
minimum: number
(double)
The minimum probability that a risk event will occur.
-
mostLikely: number
(double)
The most likely probability that a risk event will occur.
-
preOrPostResponse: string
Allowed Values:
[ "PRE_RESPONSE", "POST_RESPONSE" ]
Indicates whether a risk impact is measured pre or post response. -
projectRiskId(required): integer
(int64)
The unique identifier of a project.
-
quantifiedOtherImpactId(required): integer
(int64)
The unique identifier of a risk impact.
-
scoreType: string
Allowed Values:
[ "PROBABILITY", "SCHEDULE", "RELATIVE_SCHEDULE", "COST", "RELATIVE_COST", "USER" ]
The type of an impact score. -
shape(required): string
Allowed Values:
[ "SINGLE_POINT", "TRIANGLE", "UNIFORM", "BETAPERT" ]
The distribution that best models the three-point estimates for risk probabilities or risk schedule impacts.
Examples
Back to Top
Response
200 Response
A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {"links":{"1":"https://[host]:[port]/api/restapi/[object]/1","2":"https://[host]:[port]/api/restapi/[object]/2"},"warnings":[{"primaryKeyName":"objectIdFieldName","uniqueFieldName":"object_code_01","uniqueFieldValue":"objectCodeFieldName","primaryKeyValue":1,"warningMessages":["warning_message_1","warning_message_2"]}]}
400 Response
Invalid input.