View Monte Carlo Run Settings
get
/api/restapi/monteCarloRunSettings/{monteCarloRunSettingsId}
This endpoint returns Monte Carlo run settings that meet the following requirements:
- The object has an ID that matches the value of the {monteCarloRunSettingsId} path parameter.
Request
Path Parameters
-
monteCarloRunSettingsId(required): integer(int64)
ID of MonteCarlo Run Settings to be found.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : ApiEntityMonteCarloRunSettings
Type:
object
Title:
Show Source
ApiEntityMonteCarloRunSettings
-
activitySelection: string
Read Only:
true
Allowed Values:[ "PROJECT_ONLY", "MILESTONE_LOE", "ALL" ]
Type of activity that needs to be considered in monte carlo run . It coule take values as project only activities or mileston or level of effort activities or it could include all activites based on the value specified at the time of run for a pre or post response type. -
actualIterations: integer
(int32)
Read Only:
true
Actual number of iterations the monte carlo analysis has run for a pre or post response type. -
checkConvergenceIterationFrequency: integer
(int32)
Read Only:
true
Number of iterations for which the mean plan finish date must remain constant for analysis results to be considered converged. -
convergedAtIterations: integer
(int32)
Read Only:
true
The number of iterations at which the risk analysis results have converged. -
convergenceThreshold: number
(double)
Read Only:
true
Maximum percentage deviation at which analysis results are considered converged. -
finishDate: string
(date-time)
Read Only:
true
Finish date of a monte carlo analysis for a pre or post response type. -
includeProposedRisks: boolean
Read Only:
true
Controls whether the risk analysis includes risks with a status of proposed. -
iterations: integer
(int32)
Read Only:
true
Number of iterations run during the risk analysis. -
link: string
(url)
Read Only:
true
The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
monteCarloRunSettingsId: integer
(int64)
Read Only:
true
The unique identifier of a Monte Carlo run settings object. -
monteCarloScenario: string
Read Only:
true
Allowed Values:[ "PRE_MITIGATED", "POST_MITIGATED" ]
The type of risk analysis run on a project.- PRE_MITIGATED : A quantitative risk analysis that doesn't take into account the impact of defined risk response plans.
- POST_MITIGATED : A quantitative risk analysis that takes into account the impact of defined risk response plans.
-
optimisticPercentile: integer
(int32)
Read Only:
true
The value (0 to 100) used to calculate optimistic percentiles in risk analysis. -
pessimisticPercentile: integer
(int32)
Read Only:
true
The value (0 to 100) used to calculate pessimistic percentiles in risk analysis. -
projectId: integer
(int64)
The unique identifier of a project associated with Monte Carlo run settings.
-
randomSeed: integer
(int32)
Read Only:
true
Number used to set the starting point for the risk analysis random number generator. -
runTime: integer
(int64)
Read Only:
true
Run time of a monte carlo analysis run for a pre or post response type. -
samplingShape: stringRead Only:true
Allowed Values:[ "SINGLE_POINT", "TRIANGLE", "UNIFORM", "BETAPERT" ]
Deprecated. As of 23.10.The sampling shape of a Monte Carlo analysis. -
scheduleCost: boolean
Select this option to run a risk analysis where activity costs vary for each iteration. This will increase the risk analysis time. If this option is not selected, the activity costs will remain fixed for each iteration.
-
startDate: string
(date-time)
Read Only:
true
Start date of a monte carlo analysis for a pre or post response type. -
updateDate: string
(date-time)
Read Only:
true
Date when the record was last updated. -
useConvergence: boolean
Read Only:
true
Controls whether convergence is used to automatically determine when enough iterations have been run during risk analysis. If this option is selected, the analysis runs until specified convergence criteria are met.
404 Response
The requested Monte Carlo run settings do not exist, or you do not have access to them.