Oracle Prime Projects REST API

Schedule Risk Analysis

post

/primeapi/restapi/action/runRiskAnalysis

Send a request to this endpoint to schedule a risk analysis job. This endpoint returns a job ID upon execution of the request. Send a request to the View Job Status endpoint to monitor the status of scheduled jobs. Risk analysis uses project risk data to determine the severity and potential impact of project risks. Run risk analysis on your projects to ascertain the likelihood of achieving your project's cost and schedule objectives.

Request

Supported Media Types

application/json

Monte Carlo Settings using which Risk Analysis has to be run.

Root Schema : ApiEntityMonteCarloSettings

Type: object

Show Source

checkConvergenceIterationFrequency(optional): integer(int32)

The number of iterations for which the mean plan finish date must remain constant to be considered converged.
convergenceThreshold(optional): object Percent
includeProposedItems(optional): boolean

Controls whether the risk analysis includes risks with a status of Proposed.
iterations(optional): integer(int32)

The number of iterations run during the risk analysis.
link(optional): string(url)

Read Only: true
monteCarloSettingsId(optional): integer(int64)

The unique identifier of a set of Monte Carlo settings.
optimisticPercentile(optional): integer(int32)

The value (0% to 100%) to be used to calculate optimistic percentiles.
pessimisticPercentile(optional): integer(int32)

The value (0% to 100%) to be used to calculate pessimistic percentiles.
projectId(optional): integer(int64)

The unique identifier of a project.
randomSeed(optional): integer(int32)

Defines the number to be used to set the starting point for the random number generator.
responseContext(optional): string

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

The type of risk analysis to run on the project.
Pre-Response: A quantitative risk analysis that doesn't take into account the impact of defined risk response plans.
Post-Response: A quantitative risk analysis that takes into account the impact of defined risk response plans.
Pre- and Post-Response: A quantitative risk analysis that uses both contexts.
runRiskRemovalImpact(optional): boolean

Select this option to run a risk removal impact analysis on the project. A risk removal impact analysis measures and ranks the potential impact of each risk on the cost and completion date of the entire project.
updateDate(optional): string(date-time)

Read Only: true

Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
useConvergence(optional): boolean

Controls whether convergence is used to automatically determine when enough iterations have been run during the risk analysis. As a risk analysis is performed, the results begin to converge to such an extent that there is no point running the analysis any further because the results are only changing by a small percentage. At this point, the analysis has converged and is automatically stopped. If this option is selected, the analysis is run until the convergence criteria that have been set up are met.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "runRiskRemovalImpact":{
            "type":"boolean",
            "description":"Select this option to run a risk removal impact analysis on the project. A risk removal impact analysis measures and ranks the potential impact of each risk on the cost and completion date of the entire project."
        },
        "convergenceThreshold":{
            "description":"The maximum percentage deviation at which analysis results are considered converged.",
            "$ref":"#/definitions/Percent"
        },
        "useConvergence":{
            "type":"boolean",
            "description":"Controls whether convergence is used to automatically determine when enough iterations have been run during the risk analysis. As a risk analysis is performed, the results begin to converge to such an extent that there is no point running the analysis any further because the results are only changing by a small percentage. At this point, the analysis has converged and is automatically stopped. If this option is selected, the analysis is run until the convergence criteria that have been set up are met."
        },
        "pessimisticPercentile":{
            "type":"integer",
            "format":"int32",
            "description":"The value (0% to 100%) to be used to calculate pessimistic percentiles."
        },
        "responseContext":{
            "type":"string",
            "description":"The type of risk analysis to run on the project. <br />Pre-Response: A quantitative risk analysis that doesn't take into account the impact of defined risk response plans. <br />Post-Response: A quantitative risk analysis that takes into account the impact of defined risk response plans. <br />Pre- and Post-Response: A quantitative risk analysis that uses both contexts.",
            "enum":[
                "PRE_MITIGATED",
                "POST_MITIGATED",
                "BOTH"
            ]
        },
        "includeProposedItems":{
            "type":"boolean",
            "description":"Controls whether the risk analysis includes risks with a status of Proposed."
        },
        "monteCarloSettingsId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a set of Monte Carlo settings."
        },
        "optimisticPercentile":{
            "type":"integer",
            "format":"int32",
            "description":"The value (0% to 100%) to be used to calculate optimistic percentiles."
        },
        "randomSeed":{
            "type":"integer",
            "format":"int32",
            "description":"Defines the number to be used to set the starting point for the random number generator."
        },
        "iterations":{
            "type":"integer",
            "format":"int32",
            "description":"The number of iterations run during the risk analysis."
        },
        "projectId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a project."
        },
        "checkConvergenceIterationFrequency":{
            "type":"integer",
            "format":"int32",
            "description":"The number of iterations for which the mean plan finish date must remain constant to be considered converged."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

Nested Schema : Percent

Type: object

Show Source

bigDecimal(optional): number
double(optional): number(double)

{
    "type":"object",
    "properties":{
        "double":{
            "type":"number",
            "format":"double"
        },
        "bigDecimal":{
            "type":"number"
        }
    }
}

Response

Supported Media Types

application/json

201 Response

The object was successfully created.

Root Schema : ApiEntityScheduleJob

Type: object

Show Source

jobId(optional): integer(int64)

The unique identifier for the background service.
jobKey(optional): integer(int64)

A unique identifier of a job.
jobStatus(optional): string

Allowed Values: [ "NEW", "QUEUED", "RUNNING", "DELEGATED", "ON_HOLD", "REJECTED", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED", "NOOP", "COMPLETED_WITH_WARNINGS" ]

The status of the background service.
link(optional): string(url)

Read Only: true
updateDate(optional): string(date-time)

Read Only: true

Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "jobKey":{
            "type":"integer",
            "format":"int64",
            "description":"A unique identifier of a job."
        },
        "jobStatus":{
            "type":"string",
            "description":"The status of the background service.",
            "enum":[
                "NEW",
                "QUEUED",
                "RUNNING",
                "DELEGATED",
                "ON_HOLD",
                "REJECTED",
                "COMPLETED",
                "COMPLETED_WITH_ERRORS",
                "FAILED",
                "NOOP",
                "COMPLETED_WITH_WARNINGS"
            ]
        },
        "jobId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier for the background service."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

400 Response

Invalid input for the Action service.