Jump to

• Request
• Response

View Monte Carlo Project Delta by Project and Scenario

get

/api/restapi/monteCarloProjectDelta/project/{projectId}/deltaScenario/{scenario}

This endpoint returns Monte Carlo project deltas that meet the following requirements:

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

Request

Path Parameters

• projectId(required): integer(int64)
  Project ID of which MonteCarlo Project Delta has to be returned.
• scenario(required): string
  Risk analysis results delta.
  Allowed Values: [ "ORG_PRE_TO_ORG_POST", "ORG_PRE_TO_SENS_PRE", "ORG_POST_TO_SENS_POST", "PRE_MEAN_IMPACTED", "POST_MEAN_IMPACTED" ]

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ApiEntityMonteCarloProjectDelta

Type: object

Title: ApiEntityMonteCarloProjectDelta

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.
• monteCarloDeltaScenario: string
  Allowed Values: [ "ORG_PRE_TO_ORG_POST", "ORG_PRE_TO_SENS_PRE", "ORG_POST_TO_SENS_POST", "PRE_MEAN_IMPACTED", "POST_MEAN_IMPACTED" ]

  The type of the risk analysis scenario.
• monteCarloProjectDeltaFinancial: monteCarloProjectDeltaFinancial
  An object containing Monte Carlo project delta financial fields in the form of key-value pairs.
• monteCarloProjectDeltaId: integer (int64)
  The system-generated identifier of the project delta.
• pessimisticDurationDeltaAbs: number (double)
  The duration difference between the Pre-Response and Post-Response remaining duration values.
• pessimisticDurationDeltaPct: number (double)
  The percentage difference between the Pre-Response and Post-Response remaining duration values.
• pessimisticFinishDeltaAbs: number (double)
  The duration difference between the pre-response and post-response pessimistic finish dates.
• pessimisticFinishDeltaPct: number (double)
  Duration of difference between the pre-response and post-response pessimistic finish dates represented as a percentage.
• pessimisticStartDeltaAbs: number (double)
  The duration difference between the pre-response and post-response pessimistic start date values.
• pessimisticStartDeltaPct: number (double)
  Duration of difference between the pre-response and post-response pessimistic start date values represented as a percentage.
• projectId: integer (int64)
  The system-generated identifier of the project.
• removedItemId: integer (int64)
  The system-generated identifier of the removed object.
• removedItemType: string
  Allowed Values: [ "ACTIVITY_UNCERTAINTY", "NONE", "RISK" ]

  Type of removed item.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.

{
    "title":"ApiEntityMonteCarloProjectDelta",
    "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"
            ]
        },
        "removedItemId":{
            "type":"integer",
            "description":"The system-generated identifier of the removed object.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "removedItemType":{
            "type":"string",
            "description":"Type of removed item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "ACTIVITY_UNCERTAINTY",
                "NONE",
                "RISK"
            ]
        },
        "pessimisticStartDeltaPct":{
            "type":"number",
            "description":"Duration of difference between the pre-response and post-response pessimistic start date values represented as a percentage. ",
            "format":"double",
            "exampleSetFlag":false
        },
        "pessimisticFinishDeltaAbs":{
            "type":"number",
            "description":"The duration difference between the pre-response and post-response pessimistic finish dates.",
            "format":"double",
            "exampleSetFlag":false
        },
        "pessimisticFinishDeltaPct":{
            "type":"number",
            "description":"Duration of difference between the pre-response and post-response pessimistic finish dates represented as a percentage.",
            "format":"double",
            "exampleSetFlag":false
        },
        "pessimisticDurationDeltaAbs":{
            "type":"number",
            "description":"The duration difference between the Pre-Response and Post-Response remaining duration values.",
            "format":"double",
            "exampleSetFlag":false
        },
        "pessimisticDurationDeltaPct":{
            "type":"number",
            "description":"The percentage difference between the Pre-Response and Post-Response remaining duration values.",
            "format":"double",
            "exampleSetFlag":false
        },
        "pessimisticStartDeltaAbs":{
            "type":"number",
            "description":"The duration difference between the pre-response and post-response pessimistic start date values.",
            "format":"double",
            "exampleSetFlag":false
        },
        "monteCarloProjectDeltaFinancial":{
            "description":"An object containing Monte Carlo project delta financial fields in the form of key-value pairs.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityMonteCarloProjectDeltaFinancial"
                }
            ]
        },
        "monteCarloDeltaScenario":{
            "type":"string",
            "description":"The type of the risk analysis scenario.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "ORG_PRE_TO_ORG_POST",
                "ORG_PRE_TO_SENS_PRE",
                "ORG_POST_TO_SENS_POST",
                "PRE_MEAN_IMPACTED",
                "POST_MEAN_IMPACTED"
            ]
        },
        "monteCarloProjectDeltaId":{
            "type":"integer",
            "description":"The system-generated identifier of the project delta.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The system-generated identifier of the project.",
            "format":"int64",
            "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 : monteCarloProjectDeltaFinancial

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

Match All

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

Show Source

• object ApiEntityMonteCarloProjectDeltaFinancial
  Title: ApiEntityMonteCarloProjectDeltaFinancial

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

Nested Schema : ApiEntityMonteCarloProjectDeltaFinancial

Type: object

Title: ApiEntityMonteCarloProjectDeltaFinancial

Show Source

• atCompletionPessimisticCostDeltaAbs: number (double)
  The cost difference between the pre-response and post-response at-completion cost values.
• atCompletionPessimisticCostDeltaPct: number (double)
  The percentage difference between the pre-response and post-response at-completion cost values.
• 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.
• monteCarloProjectDeltaId: integer (int64)
  The unique identifier of a project cost delta.
• pessimisticCostDeltaAbs: number (double)
  The cost difference between the Pre-Response and Post-Response remaining cost values.
• pessimisticCostDeltaPct: number (double)
  The percentage difference between the Pre-Response and Post-Response remaining cost values.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.

{
    "title":"ApiEntityMonteCarloProjectDeltaFinancial",
    "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"
            ]
        },
        "pessimisticCostDeltaAbs":{
            "type":"number",
            "description":"The cost difference between the Pre-Response and Post-Response remaining cost values.",
            "format":"double",
            "exampleSetFlag":false
        },
        "pessimisticCostDeltaPct":{
            "type":"number",
            "description":"The percentage difference between the Pre-Response and Post-Response remaining cost values.",
            "format":"double",
            "exampleSetFlag":false
        },
        "monteCarloProjectDeltaId":{
            "type":"integer",
            "description":"The unique identifier of a project cost delta.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "atCompletionPessimisticCostDeltaAbs":{
            "type":"number",
            "description":"The cost difference between the pre-response and post-response at-completion cost values.",
            "format":"double",
            "exampleSetFlag":false
        },
        "atCompletionPessimisticCostDeltaPct":{
            "type":"number",
            "description":"The percentage difference between the pre-response and post-response at-completion cost values.",
            "format":"double",
            "exampleSetFlag":false
        },
        "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 project delta does not exist, or you do not have access to it.

Back to Top