Oracle Prime Cloud Release 16

Returns the risk matrix specified by the risk matrix name.

get

/primeapi/restapi/v16.2/riskMatrix/name/{name}

Request

Path Parameters

name: Type: string

Required: true

Name of Risk Matrix to be found.

Response

Supported Media Types

application/json

200 Response

successful operation

Body

Root Schema : ApiEntityRiskMatrix

Type: object

Properties

impactLevels: Type: integer (int32)

The degree to which a risk matrix is impacted.
matrixDescription: Type: string

The detailed summary of the risk scoring matrix.
matrixName: Type: string

The name of the risk scoring matrix.
probabilityLevels: Type: integer (int32)

A count of the number of levels (thresholds) for the probability scoretype associated with the matrix. This does not count the Negligible level.
riskMatrixId: Type: integer (int64)

The ID of the risk matrix.
riskScoreMatrixMethod: Type: string

Allowed Values: [ "HIGHEST", "AVERAGE_IMPACTS", "AVERAGE_INDIVIDUAL_SCORES" ]

The type of calculation used to obtain an overall impact value. The valid values are Highest Impact and Average Impact.
scores: Type: array scores

Unique Items Required: true
scoreTypes: Type: array scoreTypes

Unique Items Required: true
tolerances: Type: array tolerances

Unique Items Required: true
workspace: Type: object ApiEntityWorkspace
workspaceId: Type: integer (int64)

The workspace that contains the risk matrix.

Nested Schema : scores

Type: array

Unique Items Required: true

Items

Type: object ApiEntityRiskMatrixScore

Nested Schema : scoreTypes

Type: array

Unique Items Required: true

Items

Type: object ApiEntityRiskMatrixScoreType

Nested Schema : tolerances

Type: array

Unique Items Required: true

Items

Type: object ApiEntityRiskMatrixTolerance

Nested Schema : ApiEntityWorkspace

Type: object

Properties

description: Type: string

A summary of the workspace. The description provides more information than short names or titles. It can give background information or establish a purpose for the item. These details help differentiate between items with similar names and are useful in multi-user environments.
parentWorkspace: Type: integer (int64)

The workspace hierarchically above the child workspace. Parent workspaces can push down shared data to child workspaces.
securityGuid: Type: string

The Globally Unique Identifier of the workspace.
sequenceNumber: Type: integer (int32)

Determines the order of appearance of workspaces in a list.
workspaceCode: Type: string

The unique identifier for a workspace.
workspaceId: Type: integer (int64)

The unique identifier for the workspace.
workspaceName: Type: string

The name of the workspace.

Nested Schema : ApiEntityRiskMatrixScore

Type: object

Properties

matrixName: Type: string
probabilityThresholdLevel: Type: integer (int32)

INTEGER
riskMatrix: Type: object ApiEntityRiskMatrix
riskMatrixId: Type: integer (int64)

KEY
riskMatrixScoreId: Type: integer (int64)
severityEight: Type: integer (int32)

INTEGER
severityEightLabel: Type: string

STRING
severityFive: Type: integer (int32)

INTEGER
severityFiveLabel: Type: string

STRING
severityFour: Type: integer (int32)

INTEGER
severityFourLabel: Type: string

STRING
severityNine: Type: integer (int32)

INTEGER
severityNineLabel: Type: string

STRING
severityOne: Type: integer (int32)

INTEGER
severityOneLabel: Type: string

STRING
severitySeven: Type: integer (int32)

INTEGER
severitySevenLabel: Type: string

STRING
severitySix: Type: integer (int32)

INTEGER
severitySixLabel: Type: string

STRING
severityThree: Type: integer (int32)

INTEGER
severityThreeLabel: Type: string

STRING
severityTwo: Type: integer (int32)

INTEGER
severityTwoLabel: Type: string

STRING

Nested Schema : ApiEntityRiskMatrixScoreType

Type: object

Properties

matrixName: Type: string
riskMatrix: Type: object ApiEntityRiskMatrix
riskMatrixId: Type: integer (int64)

The unique identifier for the risk scoring matrix.
riskMatrixScoreTypeId: Type: integer (int64)

KEY
riskScoreType: Type: object ApiEntityRiskScoreType
riskScoreTypeId: Type: integer (int64)

The unique identifier for the risk matrix score type.
riskScoreTypeName: Type: string

Nested Schema : ApiEntityRiskScoreType

Type: object

Properties

riskScoreThresholds: Type: array riskScoreThresholds

Unique Items Required: true
riskScoreTypeId: Type: integer (int64)
riskScoreTypeName: Type: string
scoreType: Type: string

Allowed Values: [ "PROBABILITY", "SCHEDULE", "RELATIVE_SCHEDULE", "COST", "RELATIVE_COST", "USER" ]
workspace: Type: object ApiEntityWorkspace
workspaceId: Type: integer (int64)

Nested Schema : riskScoreThresholds

Type: array

Unique Items Required: true

Items

Type: object ApiEntityRiskScoreThreshold

Nested Schema : ApiEntityRiskScoreThreshold

Type: object

Properties

color: Type: string

The color that represents the urgency of the risk.
level: Type: integer (int32)

The level of the risk threshold.
lower: Type: number (double)

The lower limit of the risk score threshold range.
riskScoreThresholdCode: Type: string

The unique identifier for the risk scoring threshold.
riskScoreThresholdId: Type: integer (int64)

The unique ID of the risk score threshold.
riskScoreThresholdName: Type: string

The name of the risk threshold.
riskScoreType: Type: object ApiEntityRiskScoreType
riskScoreTypeId: Type: integer (int64)

The category to which the risk score belongs.
riskScoreTypeName: Type: string

The name of the risk score type.
stringValue: Type: string

The value of the string.
upper: Type: number (double)

The upper limit of the risk score threshold range.

Nested Schema : ApiEntityRiskMatrixTolerance

Type: object

Properties

color: Type: string
riskMatrix: Type: object ApiEntityRiskMatrix
riskMatrixId: Type: integer (int64)

Required: true
riskMatrixName: Type: string
riskMatrixToleranceId: Type: integer (int64)
value: Type: number (double)

404 Response

Risk Matrix does not exist or you do not have access to it.