Create an Activity Risk
post
/api/restapi/activityRisk
Send a request to this endpoint to create an activity risk. An application object will be created using the JSON data provided in the request body.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : ApiEntityActivityRiskInput
Type:
object
Title:
ApiEntityActivityRiskInput
This entity represents a ActivityRisk object, a unique ActivityRisk object can be identified by the following combinations of the fields.
Show Source
- activityRiskId
- activityId,projectRiskId
- activityCode,projectCode,workspaceCode,projectRiskId
- activityId,projectCode,workspaceCode,riskCode
- activityCode,projectCode,workspaceCode,riskCode
- activityCode,projectId,projectRiskId
- activityId,projectId,riskCode
- activityCode,projectId,riskCode
-
activityCode: string
Maximum Length:
60
The user-specified identifier of the activity. -
activityId(required): integer
(int64)
The unique identifier of an activity assigned to a risk.
-
activityRiskId: integer
(int64)
The unique identifier for the activity.The activity object can also be identified by its unique criteria.
-
link: string(url)Read Only:true
Deprecated. As of 23.10.The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
projectCode: string
Minimum Length:
1
Maximum Length:60
The unique identifier for a project set by the user who created the project. -
projectName: string
Maximum Length:
255
The name of the project. -
projectRiskId(required): integer
(int64)
The unique identifier for the project risk.The project risk object can also be identified by its unique criteria.
-
quantifiedOtherImpacts: array
quantifiedOtherImpacts
Activity risk impacts associated with the activity.
-
riskCode: string
Maximum Length:
60
The unique identifier for the risk. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated. -
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace.
Nested Schema : quantifiedOtherImpacts
Type:
array
Activity risk impacts associated with the activity.
Show Source
-
Array of:
object ApiEntityActivityRiskQuantifiedOtherImpactInput
Title:
ApiEntityActivityRiskQuantifiedOtherImpactInput
Nested Schema : ApiEntityActivityRiskQuantifiedOtherImpactInput
Type:
object
Title:
Show Source
ApiEntityActivityRiskQuantifiedOtherImpactInput
-
activityRiskId: integer
(int64)
The unique identifier of the activity risk to which the risk is assigned.
-
link: string(url)Read Only:true
Deprecated. As of 23.10.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(required): string
Allowed Values:
[ "PRE_RESPONSE", "POST_RESPONSE" ]
The type of risk analysis scenario run on the project.
Pre-Response: A quantitative risk analysis that doesn't take into account the impact of defined risk response plans.
Post-Response: A quantitative risk analysis that takes into account the impact of defined risk response plans.
Pre- and Post-Response: A quantitative risk analysis that uses both scenarios. -
quantifiedOtherImpactId: integer
(int64)
The unique identifier for the Activity Risk Impact.
-
scoreType(required): string
Allowed Values:
[ "PROBABILITY", "SCHEDULE", "RELATIVE_SCHEDULE", "COST", "RELATIVE_COST", "USER" ]
The name of the risk score type. -
shape(required): string
Allowed Values:
[ "SINGLE_POINT", "TRIANGLE", "UNIFORM", "BETAPERT" ]
The distribution that best models the three-point estimates for risk probabilities. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated.
Examples
Back to Top
Response
Supported Media Types
- application/json
201 Response
The object was successfully created.
Root Schema : ApiEntityActivityRisk
Type:
object
Title:
Show Source
ApiEntityActivityRisk
-
activityCode: string
Maximum Length:
60
The user-specified identifier of the activity. -
activityId: integer
(int64)
The unique identifier of an activity assigned to a risk.
-
activityRiskId: integer
(int64)
The unique identifier for the activity.The activity object can also be identified by its unique criteria.
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
projectCode: string
Minimum Length:
1
Maximum Length:60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
projectName: string
Maximum Length:
255
The name of the project. -
projectRiskId: integer
(int64)
The unique identifier for the project risk.The project risk object can also be identified by its unique criteria.
-
quantifiedOtherImpacts: array
quantifiedOtherImpacts
Activity risk impacts associated with the activity.
-
riskCode: string
Maximum Length:
60
The unique identifier for the risk. -
updateDate: string
(date-time)
Date when the record was last updated.
-
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace.
Nested Schema : quantifiedOtherImpacts
Type:
array
Activity risk impacts associated with the activity.
Show Source
-
Array of:
object ApiEntityActivityRiskQuantifiedOtherImpact
Title:
ApiEntityActivityRiskQuantifiedOtherImpact
Nested Schema : ApiEntityActivityRiskQuantifiedOtherImpact
Type:
object
Title:
Show Source
ApiEntityActivityRiskQuantifiedOtherImpact
-
activityRiskId: integer
(int64)
The unique identifier of the activity risk to which the risk is assigned.
-
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" ]
The type of risk analysis scenario run on the project.
Pre-Response: A quantitative risk analysis that doesn't take into account the impact of defined risk response plans.
Post-Response: A quantitative risk analysis that takes into account the impact of defined risk response plans.
Pre- and Post-Response: A quantitative risk analysis that uses both scenarios. -
quantifiedOtherImpactId: integer
(int64)
The unique identifier for the Activity Risk Impact.
-
scoreType: string
Allowed Values:
[ "PROBABILITY", "SCHEDULE", "RELATIVE_SCHEDULE", "COST", "RELATIVE_COST", "USER" ]
The name of the risk score type. -
shape: string
Allowed Values:
[ "SINGLE_POINT", "TRIANGLE", "UNIFORM", "BETAPERT" ]
The distribution that best models the three-point estimates for risk probabilities. -
updateDate: string
(date-time)
Date when the record was last updated.
400 Response
Invalid input for the Activity Risk service.