Jump to

• Request
• Response

View Monte Carlo Project Deterministic Values by Project and Scenario

get

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

This endpoint returns Monte Carlo deterministic 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 MonteCarlo Project Deterministic 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<ApiEntityMonteCarloProjectDeterministicValues>

Type: array

Title: List<ApiEntityMonteCarloProjectDeterministicValues>

Show Source

• Array of: object ApiEntityMonteCarloProjectDeterministicValues
  Title: ApiEntityMonteCarloProjectDeterministicValues

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

Nested Schema : ApiEntityMonteCarloProjectDeterministicValues

Type: object

Title: ApiEntityMonteCarloProjectDeterministicValues

Show Source

• actualDuration: number (double)
  Read Only: true

  The project actual duration at the time the risk analysis was run.
• actualFinishDate: string (date-time)
  Read Only: true

  The project actual finish date at the time the risk analysis was run.
• actualStartDate: string (date-time)
  Read Only: true

  The project actual start date at the time the risk analysis was run.
• assignedRisks: string
  Read Only: true

  Maximum Length: 3855

  The risks assigned to the project at the time the risk analysis was run.
• finishDate: string (date-time)
  Read Only: true

  The project finish date at the time the risk analysis was run.
• 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.
• monteCarloProjectDeterministicFinancialValues: monteCarloProjectDeterministicFinancialValues
  An object containing Monte Carlo project deterministic financial fields in the form of key-value pairs.
• monteCarloProjectDeterministicValuesId: integer (int64)
  Read Only: true

  The system-generated identifier of the project deterministic value.
• 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.
• projectCode: string
  Read Only: true

  Maximum Length: 60

  The project code at the time the risk analysis was run.
• projectId: integer (int64)
  The system-generated identifier of the project.
• projectName: string
  Read Only: true

  Maximum Length: 255

  The project name at the time the risk analysis was run.
• remainingDuration: number (double)
  Read Only: true

  The project schedule remaining duration at the time the risk analysis was run.
• scheduledFinishDate: string (date-time)
  Read Only: true

  The project schedule finish date at the time the risk analysis was run.
• startDate: string (date-time)
  Read Only: true

  The project start date at the time the risk analysis was run.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of the project's workspace.

{
    "title":"ApiEntityMonteCarloProjectDeterministicValues",
    "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"
            ]
        },
        "projectName":{
            "maxLength":"255",
            "type":"string",
            "description":"The project name at the time the risk analysis was run.",
            "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"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The system-generated identifier of the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The project code at the time the risk analysis was run.",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "remainingDuration":{
            "type":"number",
            "description":"The project schedule remaining duration at the time the risk analysis was run.",
            "format":"double",
            "readOnly":true,
            "exampleSetFlag":false
        },
        "actualFinishDate":{
            "type":"string",
            "description":"The project actual finish date at the time the risk analysis was run.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "actualDuration":{
            "type":"number",
            "description":"The project actual duration at the time the risk analysis was run.",
            "format":"double",
            "readOnly":true,
            "exampleSetFlag":false
        },
        "actualStartDate":{
            "type":"string",
            "description":"The project actual start date at the time the risk analysis was run.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "startDate":{
            "type":"string",
            "description":"The project start date at the time the risk analysis was run.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "finishDate":{
            "type":"string",
            "description":"The project finish date at the time the risk analysis was run.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of the project's workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "assignedRisks":{
            "maxLength":"3855",
            "type":"string",
            "description":"The risks assigned to the project at the time the risk analysis was run.",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "monteCarloProjectDeterministicFinancialValues":{
            "description":"An object containing Monte Carlo project deterministic financial fields in the form of key-value pairs.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityMonteCarloProjectDeterministicFinancialValues"
                }
            ]
        },
        "scheduledFinishDate":{
            "type":"string",
            "description":"The project schedule finish date at the time the risk analysis was run.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "monteCarloProjectDeterministicValuesId":{
            "type":"integer",
            "description":"The system-generated identifier of the project deterministic value.",
            "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 : monteCarloProjectDeterministicFinancialValues

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

Match All

Show Source

• object ApiEntityMonteCarloProjectDeterministicFinancialValues
  Title: ApiEntityMonteCarloProjectDeterministicFinancialValues

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

Nested Schema : ApiEntityMonteCarloProjectDeterministicFinancialValues

Type: object

Title: ApiEntityMonteCarloProjectDeterministicFinancialValues

Show Source

• atCompletionCost: number (double)
  Read Only: true

  The sum of the activity at-completion costs at the time the risk analysis was run.
• deterministicActualCost: number (double)
  Read Only: true

  The project actual cost at the time the risk analysis as run.
• 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.
• monteCarloProjectDeterministicId: integer (int64)
  Read Only: true

  The system-generated identifier of the project deterministic value.
• monteCarloProjectDeterministicValuesId: integer (int64)
  The unique identifier of a project deterministic cost.
• remainingCost: number (double)
  Read Only: true

  The project remaining total cost plus unmapped response action remaining costs at the time the risk analysis as run.
• totalDirectResponseActualCost: number (double)
  The project total direct response actual cost at the time the risk analysis as run.
• totalDirectResponseRemainingCost: number (double)
  The project total direct response remaining cost at the time the risk analysis as run.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.

{
    "title":"ApiEntityMonteCarloProjectDeterministicFinancialValues",
    "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"
            ]
        },
        "totalDirectResponseRemainingCost":{
            "type":"number",
            "description":"The project total direct response remaining cost at the time the risk analysis as run.",
            "format":"double",
            "exampleSetFlag":false
        },
        "remainingCost":{
            "type":"number",
            "description":"The project remaining total cost plus unmapped response action remaining costs at the time the risk analysis as run. ",
            "format":"double",
            "readOnly":true,
            "exampleSetFlag":false
        },
        "atCompletionCost":{
            "type":"number",
            "description":"The sum of the activity at-completion costs at the time the risk analysis was run.",
            "format":"double",
            "readOnly":true,
            "exampleSetFlag":false
        },
        "deterministicActualCost":{
            "type":"number",
            "description":"The project actual cost at the time the risk analysis as run.",
            "format":"double",
            "readOnly":true,
            "exampleSetFlag":false
        },
        "totalDirectResponseActualCost":{
            "type":"number",
            "description":"The project total direct response actual cost at the time the risk analysis as run.",
            "format":"double",
            "exampleSetFlag":false
        },
        "monteCarloProjectDeterministicId":{
            "type":"integer",
            "description":"The system-generated identifier of the project deterministic value.",
            "format":"int64",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "monteCarloProjectDeterministicValuesId":{
            "type":"integer",
            "description":"The unique identifier of a project deterministic cost.",
            "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
}

204 Response

Successful operation with no content.

404 Response

The Monte Carlo project deterministic values do not exist, or you do not have access to them.

Back to Top