Jump to

• Request
• Response

View a Monte Carlo Risk Result by Project Risk and Scenario

get

/api/restapi/monteCarloRiskResult/projectRisk/{projectRiskId}/scenario/{scenario}

This endpoint returns a Monte Carlo risk results that meet the following requirements:

• The object is associated with a project risk with an ID value that matches the value of the {projectRiskId} path parameter.
• The object was run under a scenario that matches the value of the {scenario} path parameter.

Request

Path Parameters

• projectRiskId(required): integer(int64)
  Project Risk ID of which MonteCarlo Risk Result has to be returned.
• scenario(required): string
  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.

  Allowed Values: [ "PRE_MITIGATED", "POST_MITIGATED", "BOTH" ]

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<ApiEntityMonteCarloRiskResult>

Type: array

Title: List<ApiEntityMonteCarloRiskResult>

Show Source

• Array of: object ApiEntityMonteCarloRiskResult
  Title: ApiEntityMonteCarloRiskResult

{
    "title":"List<ApiEntityMonteCarloRiskResult>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityMonteCarloRiskResult",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityMonteCarloRiskResult

Type: object

Title: ApiEntityMonteCarloRiskResult

Show Source

• 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.
• meanDelay: number (double)
  Read Only: true

  The estimated average project delay duration before implementing a response action.
• monteCarloRiskResultFinancial: monteCarloRiskResultFinancial
  An object containing Monte Carlo risk result financial fields in the form of key-value pairs.
• monteCarloRiskResultId: integer (int64)
  Read Only: true

  The unique identifier of a risk result.
• 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.
• projectRiskId: integer (int64)
  The unique identifier of a project.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.

{
    "title":"ApiEntityMonteCarloRiskResult",
    "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"
            ]
        },
        "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>",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PRE_MITIGATED",
                "POST_MITIGATED"
            ]
        },
        "projectRiskId":{
            "type":"integer",
            "description":"The unique identifier of a project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "meanDelay":{
            "type":"number",
            "description":"The estimated average project delay duration before implementing a response action.",
            "format":"double",
            "readOnly":true,
            "exampleSetFlag":false
        },
        "monteCarloRiskResultFinancial":{
            "description":"An object containing Monte Carlo risk result financial fields in the form of key-value pairs.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityMonteCarloRiskResultFinancial"
                }
            ]
        },
        "monteCarloRiskResultId":{
            "type":"integer",
            "description":"The unique identifier of a risk result.",
            "format":"int64",
            "readOnly":true,
            "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
}

Nested Schema : monteCarloRiskResultFinancial

An object containing Monte Carlo risk result financial fields in the form of key-value pairs.

Match All

Show Source

• object ApiEntityMonteCarloRiskResultFinancial
  Title: ApiEntityMonteCarloRiskResultFinancial

{
    "description":"An object containing Monte Carlo risk result financial fields in the form of key-value pairs.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityMonteCarloRiskResultFinancial"
        }
    ]
}

Nested Schema : ApiEntityMonteCarloRiskResultFinancial

Type: object

Title: ApiEntityMonteCarloRiskResultFinancial

Show Source

• 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.
• meanCostImpact: number (double)
  Read Only: true

  The estimated average project cost impact before implementing a response action.
• monteCarloRiskResultId: integer (int64)
  Read Only: true

  The unique identifier of a risk result.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.

{
    "title":"ApiEntityMonteCarloRiskResultFinancial",
    "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"
            ]
        },
        "meanCostImpact":{
            "type":"number",
            "description":"The estimated average project cost impact before implementing a response action.",
            "format":"double",
            "readOnly":true,
            "exampleSetFlag":false
        },
        "monteCarloRiskResultId":{
            "type":"integer",
            "description":"The unique identifier of a risk result.",
            "format":"int64",
            "readOnly":true,
            "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
}

204 Response

Successful operation with no content.

404 Response

The requested Monte Carlo risk result does not exist, or you do not have access to it.

Back to Top