Jump to

• Request
• Response

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 Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ApiEntityMonteCarloRunSettings

Type: object

Title: ApiEntityMonteCarloRunSettings

Show Source

• activitySelection: string
  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)
  Actual number of iterations the monte carlo analysis has run for a pre or post response type.
• checkConvergenceIterationFrequency: integer (int32)
  Number of iterations for which the mean plan finish date must remain constant for analysis results to be considered converged.
• convergedAtIterations: integer (int32)
  The number of iterations at which the risk analysis results have converged.
• convergenceThreshold: number (double)
  Maximum percentage deviation at which analysis results are considered converged.
• finishDate: string (date-time)
  Finish date of a monte carlo analysis for a pre or post response type.
• includeProposedRisks: boolean
  Controls whether the risk analysis includes risks with a status of proposed.
• iterations: integer (int32)
  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)
  The unique identifier of a Monte Carlo run settings object.
• monteCarloScenario: string
  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)
  The value (0 to 100) used to calculate optimistic percentiles in risk analysis.
• pessimisticPercentile: integer (int32)
  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)
  Number used to set the starting point for the risk analysis random number generator.
• runTime: integer (int64)
  Run time of a monte carlo analysis run for a pre or post response type.
• 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)
  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
  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.

{
    "title":"ApiEntityMonteCarloRunSettings",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "monteCarloRunSettingsId":{
            "type":"integer",
            "description":"The unique identifier of a Monte Carlo run settings object.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "monteCarloScenario":{
            "type":"string",
            "description":"The type of risk analysis run on a project. <ul><li><b>PRE_MITIGATED</b> : A quantitative risk analysis that doesn't take into account the impact of defined risk response plans.</li><li><b>POST_MITIGATED</b> : A quantitative risk analysis that takes into account the impact of defined risk response plans.</li></ul>",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PRE_MITIGATED",
                "POST_MITIGATED"
            ]
        },
        "iterations":{
            "type":"integer",
            "description":"Number of iterations run during the risk analysis.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "randomSeed":{
            "type":"integer",
            "description":"Number used to set the starting point for the risk analysis random number generator.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "useConvergence":{
            "type":"boolean",
            "description":"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.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "runTime":{
            "type":"integer",
            "description":"Run time of a monte carlo analysis run for a pre or post response type.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scheduleCost":{
            "type":"boolean",
            "description":"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.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "convergenceThreshold":{
            "type":"number",
            "description":"Maximum percentage deviation at which analysis results are considered converged.",
            "format":"double",
            "exampleSetFlag":false
        },
        "activitySelection":{
            "type":"string",
            "description":"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.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PROJECT_ONLY",
                "MILESTONE_LOE",
                "ALL"
            ]
        },
        "actualIterations":{
            "type":"integer",
            "description":"Actual number of iterations the monte carlo analysis has run for a pre or post response type.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "optimisticPercentile":{
            "type":"integer",
            "description":"The value (0 to 100) used to calculate optimistic percentiles in risk analysis.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "pessimisticPercentile":{
            "type":"integer",
            "description":"The value (0 to 100) used to calculate pessimistic percentiles in risk analysis.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "includeProposedRisks":{
            "type":"boolean",
            "description":"Controls whether the risk analysis includes risks with a status of <b>proposed</b>.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "convergedAtIterations":{
            "type":"integer",
            "description":"The number of iterations at which the risk analysis results have converged.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier of a project associated with Monte Carlo run settings.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "startDate":{
            "type":"string",
            "description":"Start date of a monte carlo analysis for a pre or post response type.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "finishDate":{
            "type":"string",
            "description":"Finish date of a monte carlo analysis for a pre or post response type.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "checkConvergenceIterationFrequency":{
            "type":"integer",
            "description":"Number of iterations for which the mean plan finish date must remain constant for analysis results to be considered converged.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

404 Response

The requested Monte Carlo run settings do not exist, or you do not have access to them.

Back to Top