Jump to

• Request
• Response

View All Monte Carlo Project Iteration Values by Project ID and Scenario

get

/api/restapi/monteCarloProjectIterationValues/project/{projectId}/scenario/{scenario}

This endpoint returns Monte Carlo Project Iteration Values 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 Monte Carlo Project Iteration Values 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<ApiEntityMonteCarloProjectIterationValue>

Type: array

Title: List<ApiEntityMonteCarloProjectIterationValue>

Show Source

• Array of: object ApiEntityMonteCarloProjectIterationValue
  Title: ApiEntityMonteCarloProjectIterationValue

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

Nested Schema : ApiEntityMonteCarloProjectIterationValue

Type: object

Title: ApiEntityMonteCarloProjectIterationValue

Show Source

• atCompletionTotalCost: number (double)
  The project at completion total cost for the iteration. Stored for the first 50 iterations only.
• earlyFinishDate: string (date-time)
  The project finish date for the iteration. Stored for all iterations.
• earlyStartDate: string (date-time)
  The project start date for the iteration. Stored for all iterations.
• impactBarStartDate: string (date-time)
  The start date that the project impact bar starts on. Stored for the first 50 iterations only.
• impactingRisks: string
  Maximum Length: 3855

  Deprecated. As of 24.3, replaced by 'risksImpactingProject'.
  The project risks that impacted the project for the iteration. Stored for the first 50 iterations only.
• iterationBlock: integer (int64)
  The iteration block number.
• iterationNumber: integer (int64)
  The iteration sequence number.
• 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.
• 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.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectDirectRemainingDuration: number (double)
  The project direct remaining duration due to project risks for the iteration. Stored for all iterations.
• projectId: integer (int64)
  The system-generated unique identifier of the project.
• projectScenarioId: integer (int64)
  The system-generated unique identifier of the project scenario.
• projectTotalDirectAtCompletionCost: number (double)
  The project direct at completion cost due to project risks for the iteration. Stored for all iterations.
• projectTotalDirectRemainingCost: number (double)
  The project direct remaining cost due to project risks for the iteration. Stored for all iterations.
• remainingCost: number (double)
  The project total remaining duration for the iteration. Stored for all iterations.
• remainingDuration: number (double)
  The project remaining duration for the iteration. Stored for all iterations.
• removedItemId: integer (int64)
  The system-generated identifier of the removed object.
• removedItemType: string
  Allowed Values: [ "ACTIVITY_UNCERTAINTY", "NONE", "RISK" ]

  The type of removed item.
• riskCostImpactProject: number (double)
  The total for the iteration of all of the project-level risk cost impacts. Stored for the first 50 iterations only.
• riskCostImpactTotal: number (double)
  The total for the iteration of all the project-level and activity level risk cost impacts. Stored for the first 50 iterations only.
• risksImpactingProject: string
  Maximum Length: 0

  The project risks that impacted the project for the iteration. Stored for the first 50 iterations only.
• uncertaintyDelay: number (double)
  The project mean schedule delay for the iteration. Stored for all iterations.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityMonteCarloProjectIterationValue",
    "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>",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PRE_MITIGATED",
                "POST_MITIGATED"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The system-generated unique identifier of the 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"
            ]
        },
        "remainingDuration":{
            "type":"number",
            "description":"The project remaining duration for the iteration. Stored for all iterations.",
            "format":"double",
            "exampleSetFlag":false
        },
        "earlyStartDate":{
            "type":"string",
            "description":"The project start date for the iteration. Stored for all iterations.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "earlyFinishDate":{
            "type":"string",
            "description":"The project finish date for the iteration. Stored for all iterations.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "atCompletionTotalCost":{
            "type":"number",
            "description":"The project at completion total cost for the iteration. Stored for the first 50 iterations only.",
            "format":"double",
            "exampleSetFlag":false
        },
        "remainingCost":{
            "type":"number",
            "description":"The project total remaining duration for the iteration. Stored for all iterations.",
            "format":"double",
            "exampleSetFlag":false
        },
        "projectScenarioId":{
            "type":"integer",
            "description":"The system-generated unique identifier of the project scenario.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "iterationNumber":{
            "type":"integer",
            "description":"The iteration sequence number.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "uncertaintyDelay":{
            "type":"number",
            "description":"The project mean schedule delay for the iteration. Stored for all iterations.",
            "format":"double",
            "exampleSetFlag":false
        },
        "impactBarStartDate":{
            "type":"string",
            "description":"The start date that the project impact bar starts on. Stored for the first 50 iterations only.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "impactingRisks":{
            "maxLength":"3855",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.3</i>,  replaced by <i>'risksImpactingProject'</i>.</br>The project risks that impacted the project for the iteration. Stored for the first 50 iterations only.",
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "removedItemType":{
            "type":"string",
            "description":"The type of removed item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "ACTIVITY_UNCERTAINTY",
                "NONE",
                "RISK"
            ]
        },
        "removedItemId":{
            "type":"integer",
            "description":"The system-generated identifier of the removed object.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "iterationBlock":{
            "type":"integer",
            "description":"The iteration block number.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "riskCostImpactProject":{
            "type":"number",
            "description":"The total for the iteration of all of the project-level risk cost impacts. Stored for the first 50 iterations only.",
            "format":"double",
            "exampleSetFlag":false
        },
        "riskCostImpactTotal":{
            "type":"number",
            "description":"The total for the iteration of all the project-level and activity level risk cost impacts. Stored for the first 50 iterations only.",
            "format":"double",
            "exampleSetFlag":false
        },
        "projectDirectRemainingDuration":{
            "type":"number",
            "description":"The project direct remaining duration due to project risks for the iteration. Stored for all iterations.",
            "format":"double",
            "exampleSetFlag":false
        },
        "projectTotalDirectRemainingCost":{
            "type":"number",
            "description":"The project direct remaining cost due to project risks for the iteration. Stored for all iterations.",
            "format":"double",
            "exampleSetFlag":false
        },
        "projectTotalDirectAtCompletionCost":{
            "type":"number",
            "description":"The project direct at completion cost due to project risks for the iteration. Stored for all iterations.",
            "format":"double",
            "exampleSetFlag":false
        },
        "risksImpactingProject":{
            "maxLength":"0",
            "type":"string",
            "description":"The project risks that impacted the project for the iteration. Stored for the first 50 iterations only.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

204 Response

Successful operation with no content.

404 Response

The Monte Carlo Project Iteration Values do not exist, or you do not have access to them.

Back to Top