View Monte Carlo Settings by Project
get
/primeapi/restapi/monteCarloSettings/project/{projectId}
This endpoint returns monte carlo settings that meet the following requirements:
- The object is associated with a project with an ID value that matches the value of the {id} path parameter.
Request
Path Parameters
-
projectId: integer(int64)
Project ID of which MonteCarlo Settings has to be returned.
Response
Supported Media Types
- application/json
200 Response
successful operation
Nested Schema : ApiEntityMonteCarloSettings
Type:
Show Source
object
-
checkConvergenceIterationFrequency(optional):
integer(int32)
The number of iterations for which the mean plan finish date must remain constant to be considered converged.
-
convergenceThreshold(optional):
object Percent
-
includeProposedItems(optional):
boolean
Controls whether the risk analysis includes risks with a status of Proposed.
-
iterations(optional):
integer(int32)
The number of iterations run during the risk analysis.
-
link(optional):
string(url)
Read Only:
true
-
monteCarloSettingsId(optional):
integer(int64)
The unique identifier of a set of Monte Carlo settings.
-
optimisticPercentile(optional):
integer(int32)
The value (0% to 100%) to be used to calculate optimistic percentiles.
-
pessimisticPercentile(optional):
integer(int32)
The value (0% to 100%) to be used to calculate pessimistic percentiles.
-
projectId(optional):
integer(int64)
The unique identifier of a project.
-
randomSeed(optional):
integer(int32)
Defines the number to be used to set the starting point for the random number generator.
-
responseContext(optional):
string
Allowed Values:
[ "PRE_MITIGATED", "POST_MITIGATED", "BOTH" ]
The type of risk analysis to 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 contexts. -
runRiskRemovalImpact(optional):
boolean
Select this option to run a risk removal impact analysis on the project. A risk removal impact analysis measures and ranks the potential impact of each risk on the cost and completion date of the entire project.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
useConvergence(optional):
boolean
Controls whether convergence is used to automatically determine when enough iterations have been run during the risk analysis. As a risk analysis is performed, the results begin to converge to such an extent that there is no point running the analysis any further because the results are only changing by a small percentage. At this point, the analysis has converged and is automatically stopped. If this option is selected, the analysis is run until the convergence criteria that have been set up are met.
204 Response
Successful operation with no content.
404 Response
The requested Monte Carlo settings do not exist, or you do not have access to them.