Jump to

• Request
• Response

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

get

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

This endpoint returns Monte Carlo Activity 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 Activity 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<ApiEntityMonteCarloActivityIterationValue>

Type: array

Title: List<ApiEntityMonteCarloActivityIterationValue>

Show Source

• Array of: object ApiEntityMonteCarloActivityIterationValue
  Title: ApiEntityMonteCarloActivityIterationValue

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

Nested Schema : ApiEntityMonteCarloActivityIterationValue

Type: object

Title: ApiEntityMonteCarloActivityIterationValue

Show Source

• activityCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of the activity.
• activityId: integer (int64)
  The system-generated unique identifier of the activity.
• atCompletionDuration: number (double)
  The activity at completion duration for the iteration. Stored for first 50 iterations only.
• atCompletionTotalCost: number (double)
  The activity at completion total cost for the iteration. Stored for the first 50 iterations only.
• drivingPath: boolean
  The activity longest path value for the iteration. Stored for the first 50 iterations only.
• earlyFinishDate: string (date-time)
  The activity early finish date for the iteration. Stored for all iterations.
• earlyStartDate: string (date-time)
  The activity early start date for the iteration. Stored for all iterations.
• finishDate: string (date-time)
  The activity finish date for the iteration. Stored for the first 50 iterations only.
• freeFloat: number (double)
  The activity free float for the iteration. Stored for the first 50 iterations only.
• impactBarStartDate: string (date-time)
  If an activity has a schedule impact, then the Impact Bar Start Date is the start date that the impact on the activity Gantt bar is drawn from for the iteration. Stored for the first 50 iterations only.
• impactingRisks: string
  Maximum Length: 3855

  The risks that impacted the activity for the iteration. Stored for the first 50 iterations only.
• indirectDurationImpact: number (double)
  Indirect duration impact due to scheduling on the activity for the iteration. Stored for the first 50 iterations only.
• isCritical: boolean
  The activity critical value for the iteration. Stored for all iterations.
• iterationNumber: integer (int64)
  The iteration sequence number.
• lateFinishDate: string (date-time)
  The activity late finish date for the iteration. Stored for the first 50 iterations only.
• lateStartDate: string (date-time)
  The activity late start date for the iteration. Stored for the first 50 iterations only.
• 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.
• otherScheduleDrivenCostImpact: number (double)
  Other cost impact on the activity for the iteration. Stored for the first 50 iterations only.
• 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 system-generated unique identifier of the project.
• projectScenarioId: integer (int64)
  The system-generated unique identifier of the project scenario.
• remainingDuration: number (double)
  The activity remaining duration for the iteration. Stored for all iterations.
• remainingEarlyStartDate: string (date-time)
  The activity remaining early start for the iteration. Stored for the first 50 iterations only.
• remainingTotalCost: number (double)
  The activity remaining total cost for the iteration. Stored for all iterations.
• riskCostImpact: number (double)
  The total for the iteration of the cost impact on the activity due to risks impacting the activity. Stored for first 50 iterations only.
• riskScheduleDrivenCostImpact: number (double)
  Total cost impact due to scheduling on the activity for the iteration. Stored for the first 50 iterations only.
• riskScheduleImpact: number (double)
  The change in the activity remaining duration due to risks impacting the activity for the iteration. Only schedule impacts from threats and opportunities are included (Weather risks impact an activity's non-working, but not the remaining duration). If the sampled risk schedule impacts on the activity are greater than the activity remaining duration, then the activity remaining duration is set to 1 minute because negative duration values are not supported. Stored for the first 50 iterations only.
• startDate: string (date-time)
  The activity start date for the iteration. Stored for the first 50 iterations only.
• totalCostImpact: number (double)
  Total cost impact due to risks on the activity for the iteration. Stored for the first 50 iterations only.
• totalFloat: number (double)
  The activity total float for the iteration. Stored for the first 50 iterations only.
• totalScheduleImpact: number (double)
  The sum of the uncertainty schedule impact and the risk schedule impact for the iteration. Stored for the first 50 iterations only.
• totalWeatherDelay: number (double)
  The number of weather non-working days between the start and finish of the activity for the iteration. Weather non-working time that coincides with other non-working weather time on the activity time is included. Stored for the first 50 iterations only.
• uncertaintyDelay: number (double)
  The activity mean delay for the iteration. Stored for all iterations.
• uncertaintyScheduleDrivenCostImpact: number (double)
  Total cost impact due to uncertainty on the activity for the iteration. Stored for the first 50 iterations only.
• uncertaintyScheduleImpact: number (double)
  For the iteration, the difference between the activity deterministic remaining duration and the duration sampled from the activity Uncertainty Distribution. The value can be positive or negative. Stored for the first 50 iterations only.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityMonteCarloActivityIterationValue",
    "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"
            ]
        },
        "uncertaintyScheduleDrivenCostImpact":{
            "type":"number",
            "description":"Total cost impact due to uncertainty on the activity for the iteration. Stored for the first 50 iterations only. ",
            "format":"double",
            "exampleSetFlag":false
        },
        "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"
            ]
        },
        "activityCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of the activity.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "lateStartDate":{
            "type":"string",
            "description":"The activity late start date for the iteration. Stored for the first 50 iterations only.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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 activity remaining duration for the iteration. Stored for all iterations.",
            "format":"double",
            "exampleSetFlag":false
        },
        "lateFinishDate":{
            "type":"string",
            "description":"The activity late finish date for the iteration. Stored for the first 50 iterations only.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "earlyStartDate":{
            "type":"string",
            "description":"The activity early start date for the iteration. Stored for all iterations.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "earlyFinishDate":{
            "type":"string",
            "description":"The activity early finish date for the iteration. Stored for all iterations.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "startDate":{
            "type":"string",
            "description":"The activity start date for the iteration. Stored for the first 50 iterations only.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "finishDate":{
            "type":"string",
            "description":"The activity finish date for the iteration. Stored for the first 50 iterations only.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "atCompletionDuration":{
            "type":"number",
            "description":"The activity at completion duration for the iteration. Stored for first 50 iterations only.",
            "format":"double",
            "exampleSetFlag":false
        },
        "drivingPath":{
            "type":"boolean",
            "description":"The activity longest path value for the iteration. Stored for the first 50 iterations only.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "freeFloat":{
            "type":"number",
            "description":"The activity free float for the iteration. Stored for the first 50 iterations only.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalFloat":{
            "type":"number",
            "description":"The activity total float for the iteration. Stored for the first 50 iterations only.",
            "format":"double",
            "exampleSetFlag":false
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "remainingTotalCost":{
            "type":"number",
            "description":"The activity remaining total cost for the iteration. Stored for all iterations.",
            "format":"double",
            "exampleSetFlag":false
        },
        "atCompletionTotalCost":{
            "type":"number",
            "description":"The activity at completion total cost for the iteration. Stored for the first 50 iterations only.",
            "format":"double",
            "exampleSetFlag":false
        },
        "activityId":{
            "type":"integer",
            "description":"The system-generated unique identifier of the activity.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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 activity mean delay for the iteration. Stored for all iterations.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalWeatherDelay":{
            "type":"number",
            "description":"The number of weather non-working days between the start and finish of the activity for the iteration. Weather non-working time that coincides with other non-working weather time on the activity time is included. Stored for the first 50 iterations only.",
            "format":"double",
            "exampleSetFlag":false
        },
        "riskScheduleImpact":{
            "type":"number",
            "description":"The change in the activity remaining duration due to risks impacting the activity for the iteration. Only schedule impacts from threats and opportunities are included (Weather risks impact an activity's non-working, but not the remaining duration). If the sampled risk schedule impacts on the activity are greater than the activity remaining duration, then the activity remaining duration is set to 1 minute because negative duration values are not supported. Stored for the first 50 iterations only.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalScheduleImpact":{
            "type":"number",
            "description":"The sum of the uncertainty schedule impact and the risk schedule impact for the iteration. Stored for the first 50 iterations only.",
            "format":"double",
            "exampleSetFlag":false
        },
        "remainingEarlyStartDate":{
            "type":"string",
            "description":"The activity remaining early start for the iteration. Stored for the first 50 iterations only.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "impactBarStartDate":{
            "type":"string",
            "description":"If an activity has a schedule impact, then the Impact Bar Start Date is the start date that the impact on the activity Gantt bar is drawn from for the iteration. Stored for the first 50 iterations only.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "uncertaintyScheduleImpact":{
            "type":"number",
            "description":"For the iteration, the difference between the activity deterministic remaining duration and the duration sampled from the activity Uncertainty Distribution. The value can be positive or negative. Stored for the first 50 iterations only.",
            "format":"double",
            "exampleSetFlag":false
        },
        "impactingRisks":{
            "maxLength":"3855",
            "type":"string",
            "description":"The risks that impacted the activity for the iteration. Stored for the first 50 iterations only.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "riskCostImpact":{
            "type":"number",
            "description":"The total for the iteration of the cost impact on the activity due to risks impacting the activity. Stored for first 50 iterations only.",
            "format":"double",
            "exampleSetFlag":false
        },
        "indirectDurationImpact":{
            "type":"number",
            "description":"Indirect duration impact due to scheduling on the activity for the iteration. Stored for the first 50 iterations only.",
            "format":"double",
            "exampleSetFlag":false
        },
        "riskScheduleDrivenCostImpact":{
            "type":"number",
            "description":"Total cost impact due to scheduling on the activity for the iteration. Stored for the first 50 iterations only.",
            "format":"double",
            "exampleSetFlag":false
        },
        "otherScheduleDrivenCostImpact":{
            "type":"number",
            "description":"Other cost impact on the activity for the iteration. Stored for the first 50 iterations only. ",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalCostImpact":{
            "type":"number",
            "description":"Total cost impact due to risks on the activity for the iteration. Stored for the first 50 iterations only.",
            "format":"double",
            "exampleSetFlag":false
        },
        "isCritical":{
            "type":"boolean",
            "description":"The activity critical value for the iteration. Stored for all iterations.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        }
    },
    "exampleSetFlag":false
}

204 Response

Successful operation with no content.

404 Response

The requested Monte Carlo Activity Iteration Values does not exist, or you do not have access to it.

Back to Top