Jump to

• Request
• Response

Run Risk Analysis

post

/api/restapi/action/runRiskAnalysis

Send a request to this endpoint to run a risk analysis job. This endpoint returns a job ID upon execution of the request. Send a request to the View Job Status endpoint to monitor the status of scheduled jobs. Risk analysis uses project risk data to determine the severity and potential impact of project risks. Run risk analysis on your projects to ascertain the likelihood of achieving your project's cost and schedule objectives.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityMonteCarloSettingsInput

Type: object

Title: ApiEntityMonteCarloSettingsInput

Show Source

• activitySelection: string
  Allowed Values: [ "PROJECT_ONLY", "MILESTONE_LOE", "ALL" ]

  Determines the activities that are included in the risk analysis results. Selecting all the activities will increase the risk analysis time.
• checkConvergenceIterationFrequency: integer (int32)
  The number of iterations for which the mean plan finish date must remain constant to be considered converged.
• convergenceThreshold: number (double)
  The maximum percentage deviation at which analysis results are considered converged.
• includeProposedItems: boolean
  Controls whether the risk analysis includes risks with a status of Proposed.
• iterations: integer (int32)
  The number of iterations run during the risk analysis.
• 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.
• monteCarloSettingsId: integer (int64)
  The unique identifier of a set of Monte Carlo settings.
• optimisticPercentile: integer (int32)
  The value (0% to 100%) to be used to calculate optimistic percentiles.
• pessimisticPercentile: integer (int32)
  The value (0% to 100%) to be used to calculate pessimistic percentiles.
• 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 of a project.
• randomSeed: integer (int32)
  Defines the number to be used to set the starting point for the random number generator.
• recalculateCost: boolean
  Read Only: true

  Deprecated. As of 23.6, replaced by 'scheduleCost'.
  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.
• responseContext: string
  Allowed Values: [ "PRE_MITIGATED", "POST_MITIGATED", "BOTH" ]

  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.
  • BOTH : A quantitative risk analysis that uses both pre and post mitigated contexts.
• runMeanImpacted: boolean
  Read Only: true

  Deprecated. As of 23.10.
  Setting to tell the monte carlo job to run mean impacts.
• runRiskRemovalImpact: 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.
• samplingShape: string
  Read Only: true

  Allowed Values: [ "UNIFORM", "TRIANGLE", "SINGLE_POINT" ]

  Deprecated. As of 23.10.
  Acts as a placeholder for type of distribution , Triangle , Uniform etc in case the schedule or cost impacts don't have their own distribution defined.
• 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.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.
• useConvergence: 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.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityMonteCarloSettingsInput",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>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,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier of a project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "responseContext":{
            "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><li><b>BOTH</b> : A quantitative risk analysis that uses both pre and post mitigated contexts.</li></ul>",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PRE_MITIGATED",
                "POST_MITIGATED",
                "BOTH"
            ]
        },
        "includeProposedItems":{
            "type":"boolean",
            "description":"Controls whether the risk analysis includes risks with a status of Proposed.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "runRiskRemovalImpact":{
            "type":"boolean",
            "description":"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.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "iterations":{
            "type":"integer",
            "description":"The number of iterations run during the risk analysis.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "optimisticPercentile":{
            "type":"integer",
            "description":"The value (0% to 100%) to be used to calculate optimistic percentiles.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "pessimisticPercentile":{
            "type":"integer",
            "description":"The value (0% to 100%) to be used to calculate pessimistic percentiles.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "randomSeed":{
            "type":"integer",
            "description":"Defines the number to be used to set the starting point for the 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 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.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "convergenceThreshold":{
            "type":"number",
            "description":"The maximum percentage deviation at which analysis results are considered converged.",
            "format":"double",
            "exampleSetFlag":false
        },
        "checkConvergenceIterationFrequency":{
            "type":"integer",
            "description":"The number of iterations for which the mean plan finish date must remain constant to be considered converged.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "activitySelection":{
            "type":"string",
            "description":"Determines the activities that are included in the risk analysis results. Selecting all the activities will increase the risk analysis time.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PROJECT_ONLY",
                "MILESTONE_LOE",
                "ALL"
            ]
        },
        "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"
            ]
        },
        "samplingShape":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Acts as a placeholder for type of distribution , Triangle , Uniform etc in case the schedule or cost impacts don't have their own distribution defined.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "UNIFORM",
                "TRIANGLE",
                "SINGLE_POINT"
            ]
        },
        "recalculateCost":{
            "type":"boolean",
            "description":"<b>Deprecated.</b> As of <i>23.6</i>,  replaced by <i>'scheduleCost'</i>.</br>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.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "runMeanImpacted":{
            "type":"boolean",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Setting to tell the monte carlo job to run mean impacts.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "monteCarloSettingsId":{
            "type":"integer",
            "description":"The unique identifier of a set of Monte Carlo settings.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

The object was successfully created.

Body ()

Root Schema : ApiEntityScheduleJob

Type: object

Title: ApiEntityScheduleJob

Show Source

• jobId: integer (int64)
  The unique identifier for the background service.
• jobKey: integer (int64)
  The unique identifier for a job.
• jobStatus: string
  Allowed Values: [ "NEW", "QUEUED", "RUNNING", "DELEGATED", "ON_HOLD", "REJECTED", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED", "NOOP", "COMPLETED_WITH_WARNINGS", "RETRIED" ]

  The status of the background service.
• 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.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.

{
    "title":"ApiEntityScheduleJob",
    "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"
            ]
        },
        "jobKey":{
            "type":"integer",
            "description":"The unique identifier for a job.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "jobId":{
            "type":"integer",
            "description":"The unique identifier for the background service.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "jobStatus":{
            "type":"string",
            "description":"The status of the background service.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "NEW",
                "QUEUED",
                "RUNNING",
                "DELEGATED",
                "ON_HOLD",
                "REJECTED",
                "COMPLETED",
                "COMPLETED_WITH_ERRORS",
                "FAILED",
                "NOOP",
                "COMPLETED_WITH_WARNINGS",
                "RETRIED"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

400 Response

Invalid input for the Action service.

Back to Top