Show Source

• [0]: object ApiEntityMonteCarloRunSettings

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ApiEntityMonteCarloRunSettings"
    }
}

Show Source

• checkConvergenceIterationFrequency(optional): integer(int32)
  Number of iterations for which the mean plan finish date must remain constant for analysis results to be considered converged.
• convergedAtIterations(optional): integer(int32)
  The number of iterations at which the risk analysis results have converged.
• convergenceThreshold(optional): object Percent
• includeProposedRisks(optional): boolean
  Controls whether the risk analysis includes risks with a status of proposed.
• iterations(optional): integer(int32)
  Number of iterations run during the risk analysis.
• link(optional): string(url)
  Read Only: true
• monteCarloRunSettingsId(optional): integer(int64)
  The unique identifier of a Monte Carlo run settings object.
• monteCarloScenario(optional): string
  Allowed Values: [ "PRE_MITIGATED", "POST_MITIGATED", "BOTH" ]

  Type of risk analysis run on a 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.
  • BOTH: A quantitative risk analysis that uses both pre and post response contexts.
• optimisticPercentile(optional): integer(int32)
  The value (0 to 100) used to calculate optimistic percentiles in risk analysis.
• pessimisticPercentile(optional): integer(int32)
  The value (0 to 100) used to calculate pessimistic percentiles in risk analysis.
• projectId(optional): integer(int64)
  The unique identifier of a project associated with Monte Carlo run settings.
• randomSeed(optional): integer(int32)
  Number used to set the starting point for the risk analysis random number generator.
• samplingShape(optional): string
  Allowed Values: [ "NONE", "TRIANGLE", "UNIFORM", "GAUSSIAN", "SINGLE_POINT" ]

  The sampling shape of a Monte Carlo analysis.
• 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 risk analysis. If this option is selected, the analysis runs until specified convergence criteria are met.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "monteCarloScenario":{
            "type":"string",
            "description":"Type of risk analysis run on a project. <ul><li><b>PRE_RESPONSE</b>: A quantitative risk analysis that doesn't take into account the impact of defined risk response plans.</li><li><b>POST-RESPONSE</b>: A quantitative risk analysis that takes into account the impact of defined risk response plans.</li><li><b>BOTH</b>: A quantitative risk analysis that uses both pre and post response contexts.</li></ul>",
            "enum":[
                "PRE_MITIGATED",
                "POST_MITIGATED",
                "BOTH"
            ]
        },
        "convergenceThreshold":{
            "description":"Maximum percentage deviation at which analysis results are considered converged.",
            "$ref":"#/definitions/Percent"
        },
        "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."
        },
        "includeProposedRisks":{
            "type":"boolean",
            "description":"Controls whether the risk analysis includes risks with a status of <b>proposed</b>."
        },
        "pessimisticPercentile":{
            "type":"integer",
            "format":"int32",
            "description":"The value (0 to 100) used to calculate pessimistic percentiles in risk analysis."
        },
        "optimisticPercentile":{
            "type":"integer",
            "format":"int32",
            "description":"The value (0 to 100) used to calculate optimistic percentiles in risk analysis."
        },
        "randomSeed":{
            "type":"integer",
            "format":"int32",
            "description":"Number used to set the starting point for the risk analysis random number generator."
        },
        "iterations":{
            "type":"integer",
            "format":"int32",
            "description":"Number of iterations run during the risk analysis."
        },
        "samplingShape":{
            "type":"string",
            "description":"The sampling shape of a Monte Carlo analysis.",
            "enum":[
                "NONE",
                "TRIANGLE",
                "UNIFORM",
                "GAUSSIAN",
                "SINGLE_POINT"
            ]
        },
        "projectId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a project associated with Monte Carlo run settings."
        },
        "convergedAtIterations":{
            "type":"integer",
            "format":"int32",
            "description":"The number of iterations at which the risk analysis results have converged."
        },
        "monteCarloRunSettingsId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a Monte Carlo run settings object."
        },
        "checkConvergenceIterationFrequency":{
            "type":"integer",
            "format":"int32",
            "description":"Number of iterations for which the mean plan finish date must remain constant for analysis results to be considered converged."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"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.",
            "readOnly":true
        }
    }
}

Show Source

• bigDecimal(optional): number
• double(optional): number(double)

{
    "type":"object",
    "properties":{
        "double":{
            "type":"number",
            "format":"double"
        },
        "bigDecimal":{
            "type":"number"
        }
    }
}