View all Program Risks by Name
get
/api/restapi/programRisk/name/{riskName}
Send a request to this endpoint to view a project risk with a name value matching the value of the {riskName} path parameter.
Request
Path Parameters
-
riskName(required): string
The name of the program risk.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : List<ApiEntityProgramRisk>
Type:
arrayTitle:
Show Source
List<ApiEntityProgramRisk>-
Array of:
object ApiEntityProgramRisk
Title:
ApiEntityProgramRisk
Nested Schema : ApiEntityProgramRisk
Type:
objectTitle:
Show Source
ApiEntityProgramRisk-
actualScheduleImpact: number
(double)
The actual schedule impact due to the risk occurring.
-
addressLine1: string
Minimum Length:
0Maximum Length:200The first line of the address of a location.
This might be the building number and street address. -
addressLine2: string
Minimum Length:
0Maximum Length:200The second line of the address of a location.
This might be a neighborhood or town. -
cause: string
Minimum Length:
0Maximum Length:4000A description of the cause of the risk. -
city: string
Minimum Length:
0Maximum Length:200The city name for a location. -
codeValuesProgramRisk: array
codeValuesProgramRisk
The list of code values for a program 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 program risk.
-
costImpactQuantified: boolean
When selected, the quantified cost distribution is used to determine the cost impact for each iteration.
-
country: string
Minimum Length:
0Maximum Length:3The country for a location. -
description: string
Minimum Length:
0Maximum Length:4000A detailed summary of the risk. -
effect: string
Minimum Length:
0Maximum Length:4000The resulting effect of the presence of the risk. -
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.
-
latitude: number
(double)
Minimum Value:
-90Maximum Value:90The 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. -
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
locationName: string
Minimum Length:
0Maximum Length:255A name for the location that your users will understand and recognize. -
longitude: number
(double)
Minimum Value:
-180Maximum Value:180The 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:
0Maximum Length:20The postal code, post code, or zip code of a location. -
postResponseMeanDelay: number
(double)
The estimated average project delay duration before implementing a response action.
-
postScore: integer
(int32)
The post-response risk score calculated using the project risk matrix.
-
preResponseMeanDelay: number
(double)
The estimated average project delay duration before implementing a response action.
-
probabilityImpactQuantified: boolean
When selected, the quantified probability distribution is used to determine the probability that the risk occurs for each iteration.
-
programCode: string
Maximum Length:
60The unique identifier for a program set by the user who created the program. -
programId: integer
(int64)
The unique identifier for the program to which the risk was added.
-
programRiskFinancial:
programRiskFinancial
The financial fields associated with a program risk.
-
programRiskId: integer
(int64)
The system-generated identifier of the program risk.
-
programRiskImpacts: array
programRiskImpacts
The impact of the program risk.
-
programRiskQuantifiedCostImpact:
programRiskQuantifiedCostImpact
The impact this program risk will have on cost data.
-
programRiskQuantifiedOtherImpacts: array
programRiskQuantifiedOtherImpacts
The impact this program risk will have on other data.
-
programRiskStatus: 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. -
quantifiedPostResponseProbabilityThreshold: number
(double)
The probability threshold that a risk will occur after implementing a response action.
-
quantifiedPostResponseScheduleThreshold: number
(double)
The estimated impact size that the risk will have on the project schedule after implementing a response action.
-
quantifiedProbabilityThreshold: number
(double)
The estimated probability that a risk will occur before implementing a response action.
-
quantifiedScheduleThreshold: number
(double)
The estimated impact size that the risk will have on the project schedule before implementing a response action.
-
responseEffectiveness: number
(double)
The effectiveness of the risk's response actions expressed as a ratio of the Exposure Improvement and the Total At Completion Response Cost.
-
riskCode: string
Minimum Length:
1Maximum Length:60The unique identifier for the risk. -
riskName: string
Minimum Length:
0Maximum Length:255The name of the risk. -
riskSourceType: string
Allowed Values:
[ "PROJECT", "PROGRAM" ]The source type of the risk i.e. Project or Program. -
riskType: string
Allowed Values:
[ "THREAT", "OPPORTUNITY", "WEATHER" ]The type of risk. Valid values are Threat, Opportunity and Weather. -
scheduleImpactQuantified: boolean
When selected, the quantified schedule impact distribution is used to calculate the schedule impact size for each iteration.
-
score: integer
(int32)
The pre-response risk score calculated using the project risk matrix.
-
scoreImprovement: integer
(int32)
The change in project risk score due to the response action(s).
-
state: string
Minimum Length:
0Maximum Length:200The state, region, or province of a location. -
updateDate: string
(date-time)
Date when the record was last updated.
-
workspaceCode: string
Minimum Length:
0Maximum Length:60The 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 : codeValuesProgramRisk
Type:
arrayThe list of code values for a program risk. This entity can only be used to assign codeValues or create codeValues on the fly.
Show Source
-
Array of:
object ApiEntityCodeValueProgramRisk
Title:
ApiEntityCodeValueProgramRisk
Nested Schema : configuredFields
Type:
arrayThe list of configured fields for a program risk.
Show Source
-
Array of:
object ApiEntityProgramRiskConfiguredFieldValue
Title:
ApiEntityProgramRiskConfiguredFieldValue
Nested Schema : programRiskFinancial
The financial fields associated with a program risk.
Match All
Show Source
-
object
ApiEntityProgramRiskFinancial
Title:
ApiEntityProgramRiskFinancial
Nested Schema : programRiskImpacts
Type:
arrayThe impact of the program risk.
Show Source
-
Array of:
object ApiEntityProgramRiskImpact
Title:
ApiEntityProgramRiskImpact
Nested Schema : programRiskQuantifiedCostImpact
The impact this program risk will have on cost data.
Match All
Show Source
-
object
ApiEntityProgramRiskQuantifiedCostImpact
Title:
ApiEntityProgramRiskQuantifiedCostImpact
Nested Schema : programRiskQuantifiedOtherImpacts
Type:
arrayThe impact this program risk will have on other data.
Show Source
-
Array of:
object ApiEntityProgramRiskQuantifiedOtherImpact
Title:
ApiEntityProgramRiskQuantifiedOtherImpact
Nested Schema : ApiEntityCodeValueProgramRisk
Type:
objectTitle:
Show Source
ApiEntityCodeValueProgramRisk-
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:
0Maximum Length:60This 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.
-
codeTypeName: string
Minimum Length:
0Maximum Length:255The name of a code or value. -
codeValueCode(required): string
Minimum Length:
1Maximum Length:60The unique identifier for the code value. -
codeValueId: integer
(int64)
The unique identifier for the code value.
-
codeValueName: string
Minimum Length:
1Maximum Length:255The name of the code value. -
codeValueProgramRiskId: integer
(int64)
The unique identifier of a risk code value.
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
parentId: integer
(int64)
The unique identifier of a parent code value.
-
programRiskId: integer
(int64)
The system-generated identifier of the program risk.
-
sequenceNumber: integer
(int32)
The number that specifies the position of the code value item within the code type list.
-
updateDate: string
(date-time)
Date when the record was last updated.
Nested Schema : ApiEntityProgramRiskConfiguredFieldValue
Type:
objectTitle:
Show Source
ApiEntityProgramRiskConfiguredFieldValue-
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:
1Maximum Length:100The user-specified UDF column label. -
columnName: string
Minimum Length:
1Maximum Length:100The user-specified UDF column name. -
costValue: number
This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.
-
costValueWorkspace1: number
(double)
This holds values for Cost type configured fields in the workspace1 currency conversion.
-
costValueWorkspace2: number
(double)
This holds values for Cost type configured fields in the workspace2 currency conversion.
-
costValueWorkspace3: number
(double)
This holds values for Cost type configured fields in the workspace3 currency conversion.
-
dateValue: string
(date-time)
This holds values for Date type configured fields.
-
exceptionMessage: string
Maximum Length:
4000Provides the error message for why the formula calculation resulted in an error. -
hasException: boolean
Determines if formula calculation hit an error calculating a value for this field.
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
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.
-
programRiskConfiguredFieldValueId: integer
(int64)
The unique identifier for the Program Risk Configured Field.
-
programRiskId: integer
(int64)
The system-generated identifier of the program risk.
-
textValue: string
Maximum Length:
4000This holds values for Boolean, List and Text type configured fields. -
updateDate: string
(date-time)
Date when the record was last updated.
Nested Schema : ApiEntityProgramRiskFinancial
Type:
objectTitle:
Show Source
ApiEntityProgramRiskFinancial-
actualCostImpact: number
(double)
Minimum Value:
0The actual cost impact due to the risk occurring. -
actualResponseCost: number
(double)
Minimum Value:
0The actual cost of implementing the response action. This field is in base currency and is calculated from actualResponseCostProject field based on the specified exchange rate. -
actualResponseCostProject: number
(double)
Minimum Value:
0The actual cost of implementing a response action. This value is based on the project currency. -
atCompletionTotalResponseCost: number
(double)
The total At Completion Response Cost of the risk.
-
contingency: number
(double)
Minimum Value:
0The allowable risk cost should the risk occur. -
exposureImprovementCost: number
(double)
The difference between the Pre-Response Exposure and the Post-Response Exposure.
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
postActualResponseCost: number
(double)
The total Post-Response Actual Response Cost of the risk.
-
postAtCompletionTotalResponseCost: number
(double)
The total Post-Response At Completion Response Cost of the risk.
-
postExposureCost: number
(double)
The mean post-response probability of the risk multiplied by the mean post-response cost impact of the risk. This field is in base currency and is calculated from postExposureCostProject field based on the specified exchange rate.
-
postExposureCostProject: number
(double)
The mean post-response probability of the risk multiplied by the mean post-response cost impact of the risk. This value is based on the project currency.
-
postQuantifiedCostThreshold: number
(double)
The estimated impact size that the risk will have on the project cost after implementing a response action.
-
postRemainingTotalResponseCost: number
(double)
The total Post-Response Remaining Response Cost of the risk.
-
postResponseExposureWorkspace1: number
(double)
The mean post-response probability of the risk multiplied by the mean post-response cost impact of the risk.
-
postResponseExposureWorkspace2: number
(double)
The mean post-response probability of the risk multiplied by the mean post-response cost impact of the risk.
-
postResponseExposureWorkspace3: number
(double)
The mean post-response probability of the risk multiplied by the mean post-response cost impact of the risk.
-
preActualResponseCost: number
(double)
The total Pre-Response Actual Response Cost of the risk.
-
preAtCompletionTotalResponseCost: number
(double)
The total Pre-Response At Completion Response Cost of the risk.
-
preExposureCost: number
(double)
The mean pre-response probability of the risk multiplied by the mean pre-response cost impact of the risk. This field is in base currency and is calculated from preExposureCostProject field based on the specified exchange rate.
-
preExposureCostProject: number
(double)
The mean pre-response probability of the risk multiplied by the mean pre-response cost impact of the risk. This value is based on the project currency.
-
preQuantifiedCostThreshold: number
(double)
The estimated impact size that the risk will have on the project cost before implementing a response action.
-
preRemainingTotalResponseCost: number
(double)
The total Pre-Response Remaining Response Cost of the risk.
-
preResponseExposureWorkspace1: number
(double)
The mean pre-response probability of the risk multiplied by the mean pre-response cost impact of the risk.
-
preResponseExposureWorkspace2: number
(double)
The mean pre-response probability of the risk multiplied by the mean pre-response cost impact of the risk.
-
preResponseExposureWorkspace3: number
(double)
The mean pre-response probability of the risk multiplied by the mean pre-response cost impact of the risk.
-
programRiskId: integer
(int64)
The system-generated identifier of the program risk.
-
remainingTotalResponseCost: number
(double)
The total Remaining Response Cost of the risk.
-
updateDate: string
(date-time)
Date when the record was last updated.
Nested Schema : ApiEntityProgramRiskImpact
Type:
objectTitle:
Show Source
ApiEntityProgramRiskImpact-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
postRiskScoreThresholdCode: string
Minimum Length:
0Maximum Length:60The unique identifier for the risk scoring threshold. -
postRiskScoreThresholdId: integer
(int64)
The system-generated unique identifier for the post-response impact threshold.
-
programRiskId: integer
(int64)
The system-generated identifier of the program risk.
-
riskCode: string
Minimum Length:
1Maximum Length:60The project risk code of a risk impact. -
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:
0Maximum Length:60The user-specified identifier of the risk score threshold of a risk impact. -
riskScoreThresholdId: integer
(int64)
The system-generated unique identifier for the pre-response impact threshold.
-
riskScoreTypeId: integer
(int64)
The system-generated unique identifier of the risk score type.
-
riskScoreTypeName: string
Minimum Length:
0Maximum Length:255The risk score type name of a risk impact. -
updateDate: string
(date-time)
Date when the record was last updated.
-
workspaceCode: string
Minimum Length:
0Maximum Length:60The user-specified identifier of a workspace.
Nested Schema : ApiEntityProgramRiskQuantifiedCostImpact
Type:
objectTitle:
Show Source
ApiEntityProgramRiskQuantifiedCostImpact-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
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.
-
postResponseMaximumProject: number
(double)
The maximum cost of responding to a risk event. This value is based on the project currency.
-
postResponseMaximumWorkspace1: number
(double)
The maximum cost of responding to a risk event.
-
postResponseMaximumWorkspace2: number
(double)
The maximum cost of responding to a risk event.
-
postResponseMaximumWorkspace3: number
(double)
The maximum cost of responding to a risk event.
-
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.
-
postResponseMinimumProject: number
(double)
The minimum cost of responding to a risk event that has occurred. This value is based on the project currency.
-
postResponseMinimumWorkspace1: number
(double)
The minimum cost of responding to a risk event that has occurred.
-
postResponseMinimumWorkspace2: number
(double)
The minimum cost of responding to a risk event that has occurred.
-
postResponseMinimumWorkspace3: number
(double)
The minimum cost of responding to a risk event that has occurred.
-
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.
-
postResponseMostLikelyProject: number
(double)
The most likely cost of a risk event that has occurred. This value is based on the project currency.
-
postResponseMostLikelyWorkspace1: number
(double)
The most likely cost of a risk event that has occurred.
-
postResponseMostLikelyWorkspace2: number
(double)
The most likely cost of a risk event that has occurred.
-
postResponseMostLikelyWorkspace3: number
(double)
The most likely probability that a risk event will occur.
-
preResponseDistributionShape: 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.
-
preResponseMaximumProject: number
(double)
The maximum cost of preparing for a risk event that has not occurred. This value is based on the project currency.
-
preResponseMaximumWorkspace1: number
(double)
The maximum cost of preparing for a risk event that has not occurred.
-
preResponseMaximumWorkspace2: number
(double)
The maximum cost of preparing for a risk event that has not occurred.
-
preResponseMaximumWorkspace3: number
(double)
The maximum cost of preparing for a risk event that has not occurred.
-
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.
-
preResponseMinimumProject: number
(double)
The minimum cost of preparing for a risk event that has not occurred. This value is based on the project currency.
-
preResponseMinimumWorkspace1: number
(double)
The minimum cost of preparing for a risk event that has not occurred.
-
preResponseMinimumWorkspace2: number
(double)
The minimum cost of preparing for a risk event that has not occurred.
-
preResponseMinimumWorkspace3: number
(double)
The minimum cost of preparing for a risk event that has not occurred.
-
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.
-
preResponseMostLikelyProject: number
(double)
The most likely cost of preparing for a risk event that has not occurred. This value is based on the project currency.
-
preResponseMostLikelyWorkspace1: number
(double)
The most likely cost of preparing for a risk event that has not occurred.
-
preResponseMostLikelyWorkspace2: number
(double)
The most likely cost of preparing for a risk event that has not occurred.
-
preResponseMostLikelyWorkspace3: number
(double)
The most likely cost of preparing for a risk event that has not occurred.
-
programRiskId: integer
(int64)
The system-generated identifier of the program risk.
-
quantifiedCostImpactId: integer
(int64)
The unique identifier of a cost impact.
-
updateDate: string
(date-time)
Date when the record was last updated.
Nested Schema : ApiEntityProgramRiskQuantifiedOtherImpact
Type:
objectTitle:
Show Source
ApiEntityProgramRiskQuantifiedOtherImpact-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
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. -
programRiskId: integer
(int64)
The system-generated identifier of the program risk.
-
quantifiedOtherImpactId: 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: string
Allowed Values:
[ "SINGLE_POINT", "TRIANGLE", "UNIFORM", "BETAPERT" ]The distribution that best models the three-point estimates for risk probabilities or risk schedule impacts. -
updateDate: string
(date-time)
Date when the record was last updated.
204 Response
Successful operation with no content.
404 Response
The requested risk does not exist or you do not have access to it.